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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file goodreads-export-1.7.4.tar.gz.

File metadata

  • Download URL: goodreads-export-1.7.4.tar.gz
  • Upload date:
  • Size: 21.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for goodreads-export-1.7.4.tar.gz
Algorithm Hash digest
SHA256 474e44fdaad26c08725a813947a7b7f5b9d1c0c1e6f9b0d0647b357f7fa476de
MD5 52d5c485b9fdaea8b4ad59119cdee8d4
BLAKE2b-256 1a4084d6a9d2b8a03af9fb00f7a48c0862d65e43e067fb57dd38a3825aa693b3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for goodreads_export-1.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bc55c092c82bf24ddc9b55a33687124b1910aad1f2ee1e6fced62738d340392e
MD5 bb5b7abde4455e4e8e0cbed076f1b576
BLAKE2b-256 31ea0b3c72c0cc43b58eb97ffdcc78047c8566ec7d7508f0f2bc0425d568b1c6

See more details on using hashes here.

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