# Comicon
Comicon is a lightweight comic converter library between CBZ, PDF, EPUB, and MOBI that preserves metadata. Once Comicon has converted a comic, it is **guaranteed** that the reverse conversion will restore the original comic with all of its original metadata.
## Usage
For a command line interface, please see [Mandown](https://github.com/potatoeggy/mandown).
```python
import comicon
comicon.convert("comic.cbz", "comic.epub")
```
## Installation
Amazon's **Kindlegen** is required if you want to convert to MOBI. See [here](https://github.com/ciromattia/kcc/issues/371) for more information.
Comicon is available from PyPI:
```
pip install comicon
```
## Supported conversions
| Format | Convert from? | Convert to? |
| ------ | ------------------ | ------------------ |
| CBZ | :heavy_check_mark: | :heavy_check_mark: |
| EPUB | :heavy_check_mark: | :heavy_check_mark: |
| PDF | :heavy_check_mark: | :heavy_check_mark: |
| MOBI | :x: | :heavy_check_mark: |
### Format discrepancies
- Only EPUB supports a table of contents. CBZ and PDF will encode the table of contents so that it is restored upon converting to EPUB.
- PDF does not support importing genre data due to a lack of library support. This may be worked around in the future.
## Notes
Under the hood, Comicon converts each format into the **Comicon Intermediate Representation (CIR)** — more or less a strictly structured folder, which allows for many guarantees to be made for each input and output plugin. See `comicon.cirtools` for more information.
For new input and output formats to be added, they should be added in `comicon.inputs` or `comicon.outputs` respectively as a new module and in the `__init__.py` file(s).
Raw data
{
"_id": null,
"home_page": "https://github.com/potatoeggy/comicon",
"name": "comicon",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "converter,comic,cbz,epub,pdf,mobi",
"author": "Daniel Chen",
"author_email": "danielchen04@hotmail.ca",
"download_url": "https://files.pythonhosted.org/packages/25/39/f59a75b2a3ee64bc4c51d3eb84858ade433d8c8bfc7e80e5cc107fd77360/comicon-1.0.1.tar.gz",
"platform": null,
"description": "# Comicon\n\nComicon is a lightweight comic converter library between CBZ, PDF, EPUB, and MOBI that preserves metadata. Once Comicon has converted a comic, it is **guaranteed** that the reverse conversion will restore the original comic with all of its original metadata.\n\n## Usage\n\nFor a command line interface, please see [Mandown](https://github.com/potatoeggy/mandown).\n\n```python\nimport comicon\n\ncomicon.convert(\"comic.cbz\", \"comic.epub\")\n```\n\n## Installation\n\nAmazon's **Kindlegen** is required if you want to convert to MOBI. See [here](https://github.com/ciromattia/kcc/issues/371) for more information.\n\nComicon is available from PyPI:\n\n```\npip install comicon\n```\n\n## Supported conversions\n\n| Format | Convert from? | Convert to? |\n| ------ | ------------------ | ------------------ |\n| CBZ | :heavy_check_mark: | :heavy_check_mark: |\n| EPUB | :heavy_check_mark: | :heavy_check_mark: |\n| PDF | :heavy_check_mark: | :heavy_check_mark: |\n| MOBI | :x: | :heavy_check_mark: |\n\n### Format discrepancies\n\n- Only EPUB supports a table of contents. CBZ and PDF will encode the table of contents so that it is restored upon converting to EPUB.\n- PDF does not support importing genre data due to a lack of library support. This may be worked around in the future.\n\n## Notes\n\nUnder the hood, Comicon converts each format into the **Comicon Intermediate Representation (CIR)** \u2014 more or less a strictly structured folder, which allows for many guarantees to be made for each input and output plugin. See `comicon.cirtools` for more information.\n\nFor new input and output formats to be added, they should be added in `comicon.inputs` or `comicon.outputs` respectively as a new module and in the `__init__.py` file(s).\n",
"bugtrack_url": null,
"license": "AGPL-3.0-only",
"summary": "A simple comic conversion library between CBZ/EPUB/MOBI/PDF",
"version": "1.0.1",
"project_urls": {
"Documentation": "https://github.com/potatoeggy/comicon",
"Homepage": "https://github.com/potatoeggy/comicon",
"Repository": "https://github.com/potatoeggy/comicon"
},
"split_keywords": [
"converter",
"comic",
"cbz",
"epub",
"pdf",
"mobi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3127bc9afb5255fa8013a908b947476fc203fad9324b05e2eca3648e854028d6",
"md5": "18bd169d78059644024a98217d038362",
"sha256": "daf78dd444f1de4492ec24c98cced7fa09f59e4dbc1f80a6d90654d6efb2bfe0"
},
"downloads": -1,
"filename": "comicon-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "18bd169d78059644024a98217d038362",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 30266,
"upload_time": "2024-01-11T01:41:52",
"upload_time_iso_8601": "2024-01-11T01:41:52.209008Z",
"url": "https://files.pythonhosted.org/packages/31/27/bc9afb5255fa8013a908b947476fc203fad9324b05e2eca3648e854028d6/comicon-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2539f59a75b2a3ee64bc4c51d3eb84858ade433d8c8bfc7e80e5cc107fd77360",
"md5": "58051e572bc94360f0c3322dd7d489d9",
"sha256": "ddc1fd19a676af8c9e7738e075d58ffbebb516a2e579c67a23a7c759effba6cc"
},
"downloads": -1,
"filename": "comicon-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "58051e572bc94360f0c3322dd7d489d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 24966,
"upload_time": "2024-01-11T01:41:53",
"upload_time_iso_8601": "2024-01-11T01:41:53.962511Z",
"url": "https://files.pythonhosted.org/packages/25/39/f59a75b2a3ee64bc4c51d3eb84858ade433d8c8bfc7e80e5cc107fd77360/comicon-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-11 01:41:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "potatoeggy",
"github_project": "comicon",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "comicon"
}
JSON
