Metadata-Version: 2.1
Name: goodreads-export
Version: 1.7.4
Summary: Convert goodreads books to markdown files, for example for Obsidian.
Home-page: https://andgineer.github.io/goodreads-export/en/
Author: Andrey Sorokin
Author-email: andrey@sorokin.engineer
Keywords: goodreads book markdown obsidian
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pandas
Requires-Dist: requests
Requires-Dist: markdownify
Requires-Dist: click
Requires-Dist: rich-click
Requires-Dist: tqdm
Requires-Dist: Jinja2
Provides-Extra: test
Requires-Dist: lazydocs; extra == "test"
Requires-Dist: mkdocs; extra == "test"
Requires-Dist: mkdocs-awesome-pages-plugin; extra == "test"
Requires-Dist: mkdocs-material; extra == "test"
Requires-Dist: pymdown-extensions; extra == "test"
Requires-Dist: pre-commit; extra == "test"
Requires-Dist: pylint; extra == "test"
Requires-Dist: mypy; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-asyncio; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: coveralls; extra == "test"
Requires-Dist: twine; extra == "test"
Requires-Dist: pip-tools; extra == "test"

[![Build Status](https://github.com/andgineer/goodreads-export/workflows/Test/badge.svg)](https://github.com/andgineer/goodreads-export/actions)
[![Coverage](https://raw.githubusercontent.com/andgineer/goodreads-export/python-coverage-comment-action-data/badge.svg)](https://htmlpreview.github.io/?https://github.com/andgineer/goodreads-export/blob/python-coverage-comment-action-data/htmlcov/index.html)
# Export goodreads books into markdown files (Obsidian etc)

Transform your goodreads.com book reviews into structured markdown files,
ideal for use in [Obsidian](https://obsidian.md/) 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](https://calibre-ebook.com/) 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](https://andgineer.github.io/goodreads-export/en/)

# Developers
### Codebase structure
[Auto-generated reference](https://andgineer.github.io/goodreads-export/docstrings/).

### Create / activate environment
    . ./activate.sh

It will also install the package in [edit mode](https://realpython.com/what-is-pip/#installing-packages-in-editable-mode-to-ease-development).

### Setting Up Pre-commit for Formatting and Static Checks

1. **Install Pre-commit**:
   ```bash
   pip install pre-commit
   ```

2. **Configure Pre-commit**:
   ```bash
   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
* [Codecov](https://app.codecov.io/gh/andgineer/goodreads-export/tree/main/src%2Fgoodreads_export)
* [Coveralls](https://coveralls.io/github/andgineer/goodreads-export)
