Simyan


NameSimyan JSON
Version 1.2.1 PyPI version JSON
download
home_page
SummaryA Python wrapper for the Comicvine API.
upload_time2024-03-16 08:06:10
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords comic comics metadata
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Simyan

[![PyPI - Python](https://img.shields.io/pypi/pyversions/Simyan.svg?logo=Python&label=Python&style=flat-square)](https://pypi.python.org/pypi/Simyan/)
[![PyPI - Status](https://img.shields.io/pypi/status/Simyan.svg?logo=Python&label=Status&style=flat-square)](https://pypi.python.org/pypi/Simyan/)
[![PyPI - Version](https://img.shields.io/pypi/v/Simyan.svg?logo=Python&label=Version&style=flat-square)](https://pypi.python.org/pypi/Simyan/)
[![PyPI - License](https://img.shields.io/pypi/l/Simyan.svg?logo=Python&label=License&style=flat-square)](https://opensource.org/licenses/GPL-3.0)

[![Hatch](https://img.shields.io/badge/Packaging-Hatch-4051b5?style=flat-square)](https://github.com/pypa/hatch)
[![Pre-Commit](https://img.shields.io/badge/Pre--Commit-Enabled-informational?style=flat-square&logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Black](https://img.shields.io/badge/Code--Style-Black-000000?style=flat-square)](https://github.com/psf/black)
[![Ruff](https://img.shields.io/badge/Linter-Ruff-informational?style=flat-square)](https://github.com/charliermarsh/ruff)

[![Github - Contributors](https://img.shields.io/github/contributors/Metron-Project/Simyan.svg?logo=Github&label=Contributors&style=flat-square)](https://github.com/Metron-Project/Simyan/graphs/contributors)
[![Github Action - Testing](https://img.shields.io/github/actions/workflow/status/Metron-Project/Simyan/testing.yaml?branch=main&logo=Github&label=Testing&style=flat-square)](https://github.com/Metron-Project/Simyan/actions/workflows/testing.yaml)

[![Read the Docs](https://img.shields.io/readthedocs/simyan?label=Read-the-Docs&logo=Read-the-Docs&style=flat-square)](https://simyan.readthedocs.io/en/latest/?badge=latest)

A [Python](https://www.python.org/) wrapper for the [Comicvine](https://comicvine.gamespot.com/api/) API.

## Installation

```bash
pip install Simyan
```

## Documentation

[Read the project documentation](https://simyan.readthedocs.io/en/latest/?badge=latest)

### Example Usage

```python
from simyan.comicvine import Comicvine
from simyan.sqlite_cache import SQLiteCache

session = Comicvine(api_key="Comicvine API Key", cache=SQLiteCache())

# Search for Publisher
results = session.list_publishers(params={"filter": "name:DC Comics"})
for publisher in results:
    print(f"{publisher.publisher_id} | {publisher.name} - {publisher.site_url}")

# Get details for a Volume
result = session.get_volume(volume_id=26266)
print(result.summary)
```

## Bugs/Requests

Please use the [GitHub issue tracker](https://github.com/Metron-Project/Simyan/issues) to submit bugs or request features.

## Notes

Big thanks to [Mokkari](https://github.com/Metron-Project/mokkari) for the inspiration and template for this project.

Who or what is Simyan?

> Simyan along with his partner Mokkari, are the diminutive proprietors of the Evil Factory, an evil version of Project Cadmus created by Darkseid and his elite.
>
> More details at [Simyan (New Earth)](<https://dc.fandom.com/wiki/Simyan_(New_Earth)>)

## Socials

[![Social - Matrix](https://img.shields.io/matrix/metron-general:matrix.org?label=Metron%20General&logo=matrix&style=for-the-badge)](https://matrix.to/#/#metron-general:matrix.org)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "Simyan",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "BuriedInCode <BuriedInCode@tuta.io>",
    "keywords": "comic,comics,metadata",
    "author": "",
    "author_email": "BuriedInCode <BuriedInCode@tuta.io>",
    "download_url": "https://files.pythonhosted.org/packages/2d/30/7e7bb5e2c591b0e427a1ca862b10beb60354f00e34b09d07aefe0550eda4/simyan-1.2.1.tar.gz",
    "platform": null,
    "description": "# Simyan\n\n[![PyPI - Python](https://img.shields.io/pypi/pyversions/Simyan.svg?logo=Python&label=Python&style=flat-square)](https://pypi.python.org/pypi/Simyan/)\n[![PyPI - Status](https://img.shields.io/pypi/status/Simyan.svg?logo=Python&label=Status&style=flat-square)](https://pypi.python.org/pypi/Simyan/)\n[![PyPI - Version](https://img.shields.io/pypi/v/Simyan.svg?logo=Python&label=Version&style=flat-square)](https://pypi.python.org/pypi/Simyan/)\n[![PyPI - License](https://img.shields.io/pypi/l/Simyan.svg?logo=Python&label=License&style=flat-square)](https://opensource.org/licenses/GPL-3.0)\n\n[![Hatch](https://img.shields.io/badge/Packaging-Hatch-4051b5?style=flat-square)](https://github.com/pypa/hatch)\n[![Pre-Commit](https://img.shields.io/badge/Pre--Commit-Enabled-informational?style=flat-square&logo=pre-commit)](https://github.com/pre-commit/pre-commit)\n[![Black](https://img.shields.io/badge/Code--Style-Black-000000?style=flat-square)](https://github.com/psf/black)\n[![Ruff](https://img.shields.io/badge/Linter-Ruff-informational?style=flat-square)](https://github.com/charliermarsh/ruff)\n\n[![Github - Contributors](https://img.shields.io/github/contributors/Metron-Project/Simyan.svg?logo=Github&label=Contributors&style=flat-square)](https://github.com/Metron-Project/Simyan/graphs/contributors)\n[![Github Action - Testing](https://img.shields.io/github/actions/workflow/status/Metron-Project/Simyan/testing.yaml?branch=main&logo=Github&label=Testing&style=flat-square)](https://github.com/Metron-Project/Simyan/actions/workflows/testing.yaml)\n\n[![Read the Docs](https://img.shields.io/readthedocs/simyan?label=Read-the-Docs&logo=Read-the-Docs&style=flat-square)](https://simyan.readthedocs.io/en/latest/?badge=latest)\n\nA [Python](https://www.python.org/) wrapper for the [Comicvine](https://comicvine.gamespot.com/api/) API.\n\n## Installation\n\n```bash\npip install Simyan\n```\n\n## Documentation\n\n[Read the project documentation](https://simyan.readthedocs.io/en/latest/?badge=latest)\n\n### Example Usage\n\n```python\nfrom simyan.comicvine import Comicvine\nfrom simyan.sqlite_cache import SQLiteCache\n\nsession = Comicvine(api_key=\"Comicvine API Key\", cache=SQLiteCache())\n\n# Search for Publisher\nresults = session.list_publishers(params={\"filter\": \"name:DC Comics\"})\nfor publisher in results:\n    print(f\"{publisher.publisher_id} | {publisher.name} - {publisher.site_url}\")\n\n# Get details for a Volume\nresult = session.get_volume(volume_id=26266)\nprint(result.summary)\n```\n\n## Bugs/Requests\n\nPlease use the [GitHub issue tracker](https://github.com/Metron-Project/Simyan/issues) to submit bugs or request features.\n\n## Notes\n\nBig thanks to [Mokkari](https://github.com/Metron-Project/mokkari) for the inspiration and template for this project.\n\nWho or what is Simyan?\n\n> Simyan along with his partner Mokkari, are the diminutive proprietors of the Evil Factory, an evil version of Project Cadmus created by Darkseid and his elite.\n>\n> More details at [Simyan (New Earth)](<https://dc.fandom.com/wiki/Simyan_(New_Earth)>)\n\n## Socials\n\n[![Social - Matrix](https://img.shields.io/matrix/metron-general:matrix.org?label=Metron%20General&logo=matrix&style=for-the-badge)](https://matrix.to/#/#metron-general:matrix.org)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A Python wrapper for the Comicvine API.",
    "version": "1.2.1",
    "project_urls": {
        "Documentation": "https://simyan.readthedocs.io/en/latest/",
        "Homepage": "https://pypi.org/project/Simyan",
        "Issues": "https://github.com/Metron-Project/Simyan/issues",
        "Source": "https://github.com/Metron-Project/Simyan"
    },
    "split_keywords": [
        "comic",
        "comics",
        "metadata"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "22d39f2afecc99d6089fede774cad0dbcadea8f87cc8ae42da81c8e7c24284bc",
                "md5": "411e5d50d6610e230089f9203afc996c",
                "sha256": "fdfb048f165600c40e749566a0f71ceebf4eb9da3b506df4cb3f1f22a8a01f34"
            },
            "downloads": -1,
            "filename": "simyan-1.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "411e5d50d6610e230089f9203afc996c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 34085,
            "upload_time": "2024-03-16T08:06:08",
            "upload_time_iso_8601": "2024-03-16T08:06:08.593106Z",
            "url": "https://files.pythonhosted.org/packages/22/d3/9f2afecc99d6089fede774cad0dbcadea8f87cc8ae42da81c8e7c24284bc/simyan-1.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2d307e7bb5e2c591b0e427a1ca862b10beb60354f00e34b09d07aefe0550eda4",
                "md5": "cfe254f102bc61e9e18cfd5b9c8dee39",
                "sha256": "36daa666ff9357a0c9f464590f69ec87ff24510df3f111ac6fb4fb95c726cf30"
            },
            "downloads": -1,
            "filename": "simyan-1.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "cfe254f102bc61e9e18cfd5b9c8dee39",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 4126717,
            "upload_time": "2024-03-16T08:06:10",
            "upload_time_iso_8601": "2024-03-16T08:06:10.897516Z",
            "url": "https://files.pythonhosted.org/packages/2d/30/7e7bb5e2c591b0e427a1ca862b10beb60354f00e34b09d07aefe0550eda4/simyan-1.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-16 08:06:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Metron-Project",
    "github_project": "Simyan",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "simyan"
}
        
Elapsed time: 0.21117s