Skip to main content

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

Metadata

Release files for goodreads-export 1.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for goodreads-export 1.10.0
File Size Uploaded Provenance
goodreads_export-1.10.0.tar.gz 28.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for goodreads-export 1.10.0
File Interpreter ABI Platform
goodreads_export-1.10.0-py3-none-any.whl Python 3 none any Details

Total release size: 55.7 kB

Release files / goodreads_export-1.10.0.tar.gz

Download URL goodreads_export-1.10.0.tar.gz
Size 28.7 kB
Tags Source
SHA-256 checksum
How to use checksums
dcc30d2e8f805cbe28ea64538aa7eccfb73080d33ece87cc105594482656c1a2
BLAKE2b-256 checksum
How to use checksums
99c30161f6fd5783e0bb732421326d95690e9f05a30919caae1573f382480894
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.12

Release files / goodreads_export-1.10.0-py3-none-any.whl

Download URL goodreads_export-1.10.0-py3-none-any.whl
Size 27.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7b6329ff3209c23ac12d7d6d670e15869a2decf1dfc3841c59c35bb40ab6446e
BLAKE2b-256 checksum
How to use checksums
62fb4525c3e779c5f07d19e280ebaf1f53f0e17ba94ba762dfbb9c2f26fba066
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.12

Security for goodreads-export 1.10.0

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page