goodreads-to-sqlite
Save data from Goodreads to a SQLite database. Can save all your public shelves and reviews, and also the public reviews and shelves of other people.
How to install
$ pip install goodreads-to-sqlite
Add the -U flag to update. Change notes can be found in the CHANGELOG file, next to this README.
Authentication
Create a Goodreads developer token: https://www.goodreads.com/api/keys
Run this command and paste in your token and your profile URL:
$ goodreads-to-sqlite auth
This will create a file called auth.json in your current directory containing the required value. To save the file at
a different path or filename, use the --auth=myauth.json option.
Retrieving books
The books command retrieves all of the books and reviews/ratings belonging to you:
$ goodreads-to-sqlite books goodreads.db rixx
You can specify the user to target, to fetch books on public shelves of other users. Please provide either the user ID (the numerical part of a user's profile URL), or the name of their vanity URL.
$ goodreads-to-sqlite books goodreads.db rixx
Sometime in 2018 or 2017, Goodreads started leaving out some "read_at" timestamps in their API. If you want to include
these datapoints regardless, you can add the --scrape parameter, and the dates will be scraped from the website.
This will take a bit longer, by maybe a minute depending on the size of your library.
$ goodreads-to-sqlite books goodreads.db --scrape
The auth.json file is used by default for authentication. You can point to a different location of auth.json using
-a:
$ goodreads-to-sqlite books goodreads.db rixx -a /path/to/auth.json
Limitations
- The order of books in shelves is not exposed in the API, so we cannot determine the order of the to-read list.
- Goodreads also offers a CSV export, which is currently not supported as an input format.
- Since the Goodreads API is a bit slow, and we are restricted to one request per second, for larger libraries the import can take a couple of minutes.
- The script currently re-syncs the entire library instead of just looking at newly changed data, to make sure we don't lose information after aborted syncs.
Thanks
This package is heavily inspired by github-to-sqlite by Simon Willison.
The terminal recording above was made with ASCIInema.
Metadata
Release files for goodreads-to-sqlite 0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| goodreads-to-sqlite-0.5.tar.gz | 7.1 kB | Without provenance | Details for goodreads-to-sqlite-0.5.tar.gz |
Release files / goodreads-to-sqlite-0.5.tar.gz
| Download URL | goodreads-to-sqlite-0.5.tar.gz |
|---|---|
| Size | 7.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3997d6631140a628ea2449434503c5d106f4bc2ffc3576a68a5aaecdc172ca9e
|
|
BLAKE2b-256 checksum How to use checksums |
42bd244ed28ab603019d946c1616f09cd49c83629e2d819ca5cf71cfb00ecaa4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2
|
Security for goodreads-to-sqlite 0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.