Skip to content

Metron-Project/Simyan

Repository files navigation

Simyan

PyPI - Python PyPI - Status PyPI - Version PyPI - License

pre-commit Ruff

Github - Contributors Github Action - Testing Github Action - Publishing

Read the Docs

A Python wrapper for the Comicvine API.

Installation

pip install --user Simyan

Example Usage

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.id} | {publisher.name} - {publisher.site_url}")

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

Documentation

Bugs/Requests

Please use the GitHub issue tracker to submit bugs or request features.

Contributing

  • When running a new test for the first time, set the environment variable COMICVINE__API_KEY to your Comicvine API key. The responses will be cached in the tests/cache.sqlite database without your key.

Socials

Social - Matrix Social - Matrix