[](https://github.com/andgineer/goodreads-export/actions)
[](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)
Raw data
{
"_id": null,
"home_page": "https://andgineer.github.io/goodreads-export/en/",
"name": "goodreads-export",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "goodreads book markdown obsidian",
"author": "Andrey Sorokin",
"author_email": "andrey@sorokin.engineer",
"download_url": "https://files.pythonhosted.org/packages/1a/40/84d6a9d2b8a03af9fb00f7a48c0862d65e43e067fb57dd38a3825aa693b3/goodreads-export-1.7.4.tar.gz",
"platform": null,
"description": "[](https://github.com/andgineer/goodreads-export/actions)\n[](https://htmlpreview.github.io/?https://github.com/andgineer/goodreads-export/blob/python-coverage-comment-action-data/htmlcov/index.html)\n# Export goodreads books into markdown files (Obsidian etc)\n\nTransform your goodreads.com book reviews into structured markdown files,\nideal for use in [Obsidian](https://obsidian.md/) and other markdown-based applications.\n\n- **Goodreads Book Page Links:** Each markdown file contains a direct link to the corresponding book's page on Goodreads.\n- **Calibre Integration:** Includes a [Calibre](https://calibre-ebook.com/) URL for each book, allowing quick searches\nin your local Calibre collection.\n- **Tagging Based on Goodreads Shelves:** Reviews are automatically categorized with tags derived from your Goodreads shelves.\n- **Customizable Templates:** Utilizing Jinja2 templates, the output format can be easily customized to suit your specific needs or preferences.\n\n# User manual\n\n[goodreads-export](https://andgineer.github.io/goodreads-export/en/)\n\n# Developers\n### Codebase structure\n[Auto-generated reference](https://andgineer.github.io/goodreads-export/docstrings/).\n\n### Create / activate environment\n . ./activate.sh\n\nIt will also install the package in [edit mode](https://realpython.com/what-is-pip/#installing-packages-in-editable-mode-to-ease-development).\n\n### Setting Up Pre-commit for Formatting and Static Checks\n\n1. **Install Pre-commit**:\n ```bash\n pip install pre-commit\n ```\n\n2. **Configure Pre-commit**:\n ```bash\n pre-commit install\n ```\n\nThis sets up `pre-commit` in your local environment to run the same static checks as the `static` GitHub Action.\n\n### Scripts\n make help\n\n## Coverage report\n* [Codecov](https://app.codecov.io/gh/andgineer/goodreads-export/tree/main/src%2Fgoodreads_export)\n* [Coveralls](https://coveralls.io/github/andgineer/goodreads-export)\n",
"bugtrack_url": null,
"license": "",
"summary": "Convert goodreads books to markdown files, for example for Obsidian.",
"version": "1.7.4",
"project_urls": {
"Homepage": "https://andgineer.github.io/goodreads-export/en/"
},
"split_keywords": [
"goodreads",
"book",
"markdown",
"obsidian"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31ea0b3c72c0cc43b58eb97ffdcc78047c8566ec7d7508f0f2bc0425d568b1c6",
"md5": "bb5b7abde4455e4e8e0cbed076f1b576",
"sha256": "bc55c092c82bf24ddc9b55a33687124b1910aad1f2ee1e6fced62738d340392e"
},
"downloads": -1,
"filename": "goodreads_export-1.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bb5b7abde4455e4e8e0cbed076f1b576",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 22654,
"upload_time": "2024-01-25T05:32:40",
"upload_time_iso_8601": "2024-01-25T05:32:40.772767Z",
"url": "https://files.pythonhosted.org/packages/31/ea/0b3c72c0cc43b58eb97ffdcc78047c8566ec7d7508f0f2bc0425d568b1c6/goodreads_export-1.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a4084d6a9d2b8a03af9fb00f7a48c0862d65e43e067fb57dd38a3825aa693b3",
"md5": "52d5c485b9fdaea8b4ad59119cdee8d4",
"sha256": "474e44fdaad26c08725a813947a7b7f5b9d1c0c1e6f9b0d0647b357f7fa476de"
},
"downloads": -1,
"filename": "goodreads-export-1.7.4.tar.gz",
"has_sig": false,
"md5_digest": "52d5c485b9fdaea8b4ad59119cdee8d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 21559,
"upload_time": "2024-01-25T05:32:42",
"upload_time_iso_8601": "2024-01-25T05:32:42.463879Z",
"url": "https://files.pythonhosted.org/packages/1a/40/84d6a9d2b8a03af9fb00f7a48c0862d65e43e067fb57dd38a3825aa693b3/goodreads-export-1.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-25 05:32:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "goodreads-export"
}
JSON