Export goodreads books into markdown files (Obsidian etc)
Transform your goodreads.com book reviews into structured markdown files,
ideal for use in Obsidian and other markdown-based applications.
-
Goodreads Book Page Links: Each markdown file contains a direct link to the corresponding book's page on Goodreads.
-
Calibre Integration: Includes a Calibre URL for each book, allowing quick searches
in your local Calibre collection.
-
Tagging Based on Goodreads Shelves: Reviews are automatically categorized with tags derived from your Goodreads shelves.
-
Customizable Templates: Utilizing Jinja2 templates, the output format can be easily customized to suit your specific needs or preferences.
User manual
goodreads-export
Developers
Codebase structure
Auto-generated reference.
Create / activate environment
. ./activate.sh
It will also install the package in edit mode.
Setting Up Pre-commit for Formatting and Static Checks
-
Install Pre-commit:
pip install pre-commit
-
Configure Pre-commit:
pre-commit install
This sets up pre-commit
in your local environment to run the same static checks as the static
GitHub Action.
Scripts
make help
Coverage report