{"id":18221863,"url":"https://github.com/karlicoss/goodrexport","last_synced_at":"2025-10-05T09:39:41.659Z","repository":{"id":53524492,"uuid":"206980146","full_name":"karlicoss/goodrexport","owner":"karlicoss","description":"Goodreads data export","archived":false,"fork":false,"pushed_at":"2021-03-26T04:20:38.000Z","size":32,"stargazers_count":17,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-22T00:14:50.267Z","etag":null,"topics":["backup","data-liberation","export","goodreads"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/karlicoss.png","metadata":{"files":{"readme":"README.org","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-07T14:32:54.000Z","updated_at":"2024-07-08T09:03:30.000Z","dependencies_parsed_at":"2022-09-01T13:22:32.307Z","dependency_job_id":null,"html_url":"https://github.com/karlicoss/goodrexport","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/karlicoss/goodrexport","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karlicoss%2Fgoodrexport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karlicoss%2Fgoodrexport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karlicoss%2Fgoodrexport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karlicoss%2Fgoodrexport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/karlicoss","download_url":"https://codeload.github.com/karlicoss/goodrexport/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karlicoss%2Fgoodrexport/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261978908,"owners_count":23239417,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","data-liberation","export","goodreads"],"created_at":"2024-11-03T22:04:49.165Z","updated_at":"2025-10-05T09:39:36.618Z","avatar_url":"https://github.com/karlicoss.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"#+begin_src python :dir src :results drawer :exports results\nimport goodrexport.export as E; return E.make_parser().prog\n#+end_src\n\n#+RESULTS:\n:results:\nExport/takeout for your personal Goodreads data\n:end:\n\n* Setting up\n1. The easiest way is =pip3 install --user git+https://github.com/karlicoss/goodrexport=.\n\n   Alternatively, use =git clone --recursive=, or =git pull \u0026\u0026 git submodule update --init=. After that, you can use =pip3 install --editable=.\n2. [[https://www.goodreads.com/api/keys][get your API keys]]\n\n* Exporting\n\n#+begin_src python :dir src :results drawer :exports results\nimport goodrexport.export as E; return E.make_parser().epilog\n#+end_src\n\n#+RESULTS:\n:results:\n\nUsage:\n\n*Recommended*: create =secrets.py= keeping your api parameters, e.g.:\n\n\n: user_id = \"USER_ID\"\n: key = \"KEY\"\n\n\nAfter that, use:\n\n: python3 -m goodrexport.export --secrets /path/to/secrets.py\n\nThat way you type less and have control over where you keep your plaintext secrets.\n\n*Alternatively*, you can pass parameters directly, e.g.\n\n: python3 -m goodrexport.export --user_id \u003cuser_id\u003e --key \u003ckey\u003e\n\nHowever, this is verbose and prone to leaking your keys/tokens/passwords in shell history.\n\n\nYou can also import ~goodrexport.export~ as a module and call ~get_xml~ function directly to get raw XML.\n\n\nI *highly* recommend checking exported files at least once just to make sure they contain everything you expect from your export. If not, please feel free to ask or raise an issue!\n\n:end:\n\n* Using data\n  \n#+begin_src python :dir src  :results drawer :exports results\nimport goodrexport.exporthelpers.dal_helper as D; return D.make_parser().epilog\n#+end_src\n\n#+RESULTS:\n:results:\n\nYou can use =goodrexport.dal= (stands for \"Data Access/Abstraction Layer\") to access your exported data, even offline.\nI elaborate on motivation behind it [[https://beepb00p.xyz/exports.html#dal][here]].\n\n- main usecase is to be imported as python module to allow for *programmatic access* to your data.\n\n  You can find some inspiration in [[https://beepb00p.xyz/mypkg.html][=my.=]] package that I'm using as an API to all my personal data.\n\n- to test it against your export, simply run: ~python3 -m goodrexport.dal --source /path/to/export~\n\n- you can also try it interactively: ~python3 -m goodrexport.dal --source /path/to/export --interactive~\n\n:end:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarlicoss%2Fgoodrexport","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkarlicoss%2Fgoodrexport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarlicoss%2Fgoodrexport/lists"}