Skip to main content

Convert goodreads books to markdown files, for example for Obsidian.

Project description

Build Status Coverage

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

  1. Install Pre-commit:

    pip install pre-commit
    
  2. 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

goodreads-export-1.7.4.tar.gz (21.6 kB view hashes)

Uploaded Source

Built Distribution

goodreads_export-1.7.4-py3-none-any.whl (22.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page