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 Search in 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.8.0.tar.gz (22.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

goodreads_export-1.8.0-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file goodreads_export-1.8.0.tar.gz.

File metadata

  • Download URL: goodreads_export-1.8.0.tar.gz
  • Upload date:
  • Size: 22.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for goodreads_export-1.8.0.tar.gz
Algorithm Hash digest
SHA256 00e507e866c34f2bee358b224197858a4e7001e25e8af45cce73dea4da4b0de8
MD5 63bd00e43fc18561264f03170415c417
BLAKE2b-256 8e748b4ad590a84b208aff1521e02ed8af68ef8d86ebc84ad2c642d2e1e97a74

See more details on using hashes here.

File details

Details for the file goodreads_export-1.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for goodreads_export-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 26395dacc7d2edec2d53ac79f4789b275355aad2f2a447cc58711449614e2813
MD5 9ebe800c66143f5cdf4b9475d98452fd
BLAKE2b-256 5f8dc7423e6c0e1d0a4edabb98b18bb0dab1af008eab675e6ac721bb521f1dce

See more details on using hashes here.

Supported by

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