# Kindle Annotations to Markdown
> A simple program to convert Kindle HTML annotations to a Markdown file
## Features
- Conversion of page bookmarks, text highlights, and notes to Markdown
- Included reference positions of annotations
- Automatic detection of annotation file's language ([currently supported](kindle_to_markdown/languages.py))
## Usage
```shell
$ kindle_to_markdown --help
Usage: kindle_to_markdown [OPTIONS]
A simple program to convert Kindle HTML annotations to a Markdown file.
Options:
-i, --input-file PATH Path to the Kindle annotations HTML file.
[required]
-o, --output-file PATH Path to the Markdown file.
-p, --print-only Only print Markdown to the console.
--help Show this message and exit.
```
## Installation
### From PyPi
```shell
pip install kindle-to-markdown
```
### From Source
Prerequisites:
- `python` in a [supported version](pyproject.toml) available on your path.
- Package manager `poetry` installed (e.g., `python -m pip install poetry`)
```shell
make
poetry run python -m kindle_to_markdown --help
```
Raw data
{
"_id": null,
"home_page": "https://github.com/BastiTee/kindle-to-markdown",
"name": "kindle-to-markdown",
"maintainer": "Basti Tee",
"docs_url": null,
"requires_python": "<4.0.0,>=3.9.0",
"maintainer_email": "basti.tee@icloud.com",
"keywords": "kindle, markdown, converter, python",
"author": "Basti Tee",
"author_email": "basti.tee@icloud.com",
"download_url": null,
"platform": null,
"description": "# Kindle Annotations to Markdown\n\n> A simple program to convert Kindle HTML annotations to a Markdown file\n\n## Features\n\n- Conversion of page bookmarks, text highlights, and notes to Markdown\n- Included reference positions of annotations\n- Automatic detection of annotation file's language ([currently supported](kindle_to_markdown/languages.py))\n\n## Usage\n\n```shell\n$ kindle_to_markdown --help\nUsage: kindle_to_markdown [OPTIONS]\n\n A simple program to convert Kindle HTML annotations to a Markdown file.\n\nOptions:\n -i, --input-file PATH Path to the Kindle annotations HTML file.\n [required]\n -o, --output-file PATH Path to the Markdown file.\n -p, --print-only Only print Markdown to the console.\n --help Show this message and exit.\n```\n\n## Installation\n\n### From PyPi\n\n```shell\npip install kindle-to-markdown\n```\n\n### From Source\n\nPrerequisites:\n\n- `python` in a [supported version](pyproject.toml) available on your path.\n- Package manager `poetry` installed (e.g., `python -m pip install poetry`)\n\n```shell\nmake\npoetry run python -m kindle_to_markdown --help\n```\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "A simple program to convert Kindle HTML annotations to a Markdown file.",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/BastiTee/kindle-to-markdown",
"Repository": "https://github.com/BastiTee/kindle-to-markdown"
},
"split_keywords": [
"kindle",
" markdown",
" converter",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6e86044f20a76a46eca45baee37d37bf5d0d3e5e6e128bc1a9e830eebda6b4ee",
"md5": "e1b2a7b94976dd3cf9aa961a8133d59a",
"sha256": "67aeeefe4d823be9135560e8cab921d85ee9b7d8d09e685e45c7ba960e2048bd"
},
"downloads": -1,
"filename": "kindle_to_markdown-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e1b2a7b94976dd3cf9aa961a8133d59a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.9.0",
"size": 9196,
"upload_time": "2024-12-28T12:56:25",
"upload_time_iso_8601": "2024-12-28T12:56:25.809816Z",
"url": "https://files.pythonhosted.org/packages/6e/86/044f20a76a46eca45baee37d37bf5d0d3e5e6e128bc1a9e830eebda6b4ee/kindle_to_markdown-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-28 12:56:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BastiTee",
"github_project": "kindle-to-markdown",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kindle-to-markdown"
}
JSON
