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

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.10.0.tar.gz (28.7 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.10.0-py3-none-any.whl (27.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: goodreads_export-1.10.0.tar.gz
  • Upload date:
  • Size: 28.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for goodreads_export-1.10.0.tar.gz
Algorithm Hash digest
SHA256 dcc30d2e8f805cbe28ea64538aa7eccfb73080d33ece87cc105594482656c1a2
MD5 91c07590138fada6332a4c89fc6f0984
BLAKE2b-256 99c30161f6fd5783e0bb732421326d95690e9f05a30919caae1573f382480894

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for goodreads_export-1.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b6329ff3209c23ac12d7d6d670e15869a2decf1dfc3841c59c35bb40ab6446e
MD5 19f244a0955f76244f749afc23d68e2d
BLAKE2b-256 62fb4525c3e779c5f07d19e280ebaf1f53f0e17ba94ba762dfbb9c2f26fba066

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