Simyan

A Python wrapper for the Comicvine API.

Installation

pip install Simyan

Example Usage

from datetime import timedelta
from pathlib import Path

from simyan.comicvine import Comicvine

session = Comicvine(
    api_key="Comicvine API Key",
    cache_path=Path("cache.sqlite"),  # Optional, defaults to ~/.cache/simyan/cache.sqlite
    cache_expiry=timedelta(days=1),  # Optional, defaults to 14 days
    ratelimit_path=Path(
        "ratelimits.sqlite"
    ),  # Optional, defaults to ~/.cache/simyan/ratelimits.sqlite
)

# 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

• Simyan
• Comicvine API

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