# Darkseid
[](https://pypi.org/project/darkseid/)
[](https://pypi.org/project/darkseid/)
[](https://github.com/charliermarsh/ruff)
[](https://github.com/pre-commit/pre-commit)
A [Python](https://www.python.org/) library to interact with comic archives.
## Installation
```bash
pip install darkseid
```
There are optional dependencies which can be installed by specifying one or more
of them in braces e.g. darkseid[7zip]
The optional dependencies are:
- **7zip**: Provides support for reading/writing to CB7 files.
- **pillow**: Provides support for getting page information that is used with
ComicInfo.xml metadata.
## Example
```python
from pathlib import Path
from darkseid.comic import Comic, MetadataFormat
comic = Comic(Path("my_comic.cbz"))
# Check if it's a valid comic
if comic.is_valid_comic():
print(f"Comic '{comic.name}' has {comic.get_number_of_pages()} pages")
# Read metadata
if comic.has_metadata(MetadataFormat.COMIC_INFO):
metadata = comic.read_metadata(MetadataFormat.COMIC_INFO)
print(f"Series: {metadata.series.name}")
# Get a page
page_data = comic.get_page(0) # First page
if page_data:
with open("cover.jpg", "wb") as f:
f.write(page_data)
```
## Documentation
[Read the project documentation](https://darkseid.readthedocs.io/en/stable/?badge=latest)
## Bugs/Requests
Please use the
[GitHub issue tracker](https://github.com/Metron-Project/darkseid/issues) to
submit bugs or request features.
Raw data
{
"_id": null,
"home_page": null,
"name": "darkseid",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Brian Pepple <bpepple@metron.cloud>",
"keywords": "cb7, cbr, cbt, cbz, comic, comicinfo, metadata, metroninfo",
"author": null,
"author_email": "Brian Pepple <bpepple@metron.cloud>",
"download_url": "https://files.pythonhosted.org/packages/de/de/1b6293211787d4cc57bf268bafaac90c49e759232d8e5fcc7448a5401c5e/darkseid-7.0.0.tar.gz",
"platform": null,
"description": "# Darkseid\n\n[](https://pypi.org/project/darkseid/)\n[](https://pypi.org/project/darkseid/)\n[](https://github.com/charliermarsh/ruff)\n[](https://github.com/pre-commit/pre-commit)\n\nA [Python](https://www.python.org/) library to interact with comic archives.\n\n## Installation\n\n```bash\npip install darkseid\n```\n\nThere are optional dependencies which can be installed by specifying one or more\nof them in braces e.g. darkseid[7zip]\n\nThe optional dependencies are:\n\n- **7zip**: Provides support for reading/writing to CB7 files.\n- **pillow**: Provides support for getting page information that is used with\n ComicInfo.xml metadata.\n\n## Example\n\n```python\nfrom pathlib import Path\nfrom darkseid.comic import Comic, MetadataFormat\n\ncomic = Comic(Path(\"my_comic.cbz\"))\n\n# Check if it's a valid comic\nif comic.is_valid_comic():\n print(f\"Comic '{comic.name}' has {comic.get_number_of_pages()} pages\")\n\n# Read metadata\nif comic.has_metadata(MetadataFormat.COMIC_INFO):\n metadata = comic.read_metadata(MetadataFormat.COMIC_INFO)\n print(f\"Series: {metadata.series.name}\")\n\n# Get a page\npage_data = comic.get_page(0) # First page\nif page_data:\n with open(\"cover.jpg\", \"wb\") as f:\n f.write(page_data)\n```\n\n## Documentation\n\n[Read the project documentation](https://darkseid.readthedocs.io/en/stable/?badge=latest)\n\n## Bugs/Requests\n\nPlease use the\n[GitHub issue tracker](https://github.com/Metron-Project/darkseid/issues) to\nsubmit bugs or request features.\n",
"bugtrack_url": null,
"license": null,
"summary": "A library to interact with comic archives",
"version": "7.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/Metron-Project/darkseid/issues",
"Homepage": "https://github.com/Metron-Project/darkseid"
},
"split_keywords": [
"cb7",
" cbr",
" cbt",
" cbz",
" comic",
" comicinfo",
" metadata",
" metroninfo"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "eb41f3d50c8282f40d763eeb63ce3218ca9ee00bc188ef9f83771f7dca845d7b",
"md5": "d23809298acc850210203c4e21aeeb55",
"sha256": "f093a90dc0adf300a737a1af9b50f571bf61c46c51926ac32dd7b2ad4c643417"
},
"downloads": -1,
"filename": "darkseid-7.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d23809298acc850210203c4e21aeeb55",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 91288,
"upload_time": "2025-07-20T14:24:42",
"upload_time_iso_8601": "2025-07-20T14:24:42.914652Z",
"url": "https://files.pythonhosted.org/packages/eb/41/f3d50c8282f40d763eeb63ce3218ca9ee00bc188ef9f83771f7dca845d7b/darkseid-7.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dede1b6293211787d4cc57bf268bafaac90c49e759232d8e5fcc7448a5401c5e",
"md5": "8c303a88a5995417d69d7bc2ecad275c",
"sha256": "5eefb37b8a19e84fcdb5455681aebd6e9048f8536453753c3b3051d4cd95cdb7"
},
"downloads": -1,
"filename": "darkseid-7.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8c303a88a5995417d69d7bc2ecad275c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 111046,
"upload_time": "2025-07-20T14:24:44",
"upload_time_iso_8601": "2025-07-20T14:24:44.199087Z",
"url": "https://files.pythonhosted.org/packages/de/de/1b6293211787d4cc57bf268bafaac90c49e759232d8e5fcc7448a5401c5e/darkseid-7.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-20 14:24:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Metron-Project",
"github_project": "darkseid",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "darkseid"
}
JSON
