Grayven


NameGrayven JSON
Version 0.3.1 PyPI version JSON
download
home_pageNone
SummaryA Python wrapper for the Grand Comics Database API.
upload_time2025-07-21 00:16:08
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT
keywords comic comics metadata
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Grayven

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

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-informational?logo=pre-commit&style=flat-square)](https://github.com/pre-commit/pre-commit)
[![Ruff](https://img.shields.io/badge/ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)

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

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

A [Python](https://www.python.org/) wrapper for the [Grand Comics Database API](https://github.com/GrandComicsDatabase/gcd-django/wiki/API).

## Installation

```console
pip install --user Grayven
```

### Example Usage

```python
from grayven.grand_comics_database import GrandComicsDatabase
from grayven.sqlite_cache import SQLiteCache

session = GrandComicsDatabase(
    email="email@example.com",
    password="password",
    cache=SQLiteCache()
)

# Search for Series
results = session.list_series(name="Green Lantern")
for series in results:
    print(f"{series.id} | {series.name} ({series.year_began})")

# Get an issue's release date
result = session.get_issue(id=242700)
print(result.on_sale_date)
```

## Documentation

- [Grayven](https://grayven.readthedocs.io/en/stable)
- [GrandComicsDatabase API](https://github.com/GrandComicsDatabase/gcd-django/wiki/API)

## Bugs/Requests

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

## Contributing

- When running a new test for the first time, set the environment variables `GCD_EMAIL` to your GCD email address and `GCD_PASSWORD` to your GCD password.
  The responses will be cached in the `tests/cache.sqlite` database without your credentials.

## 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)
[![Social - Matrix](https://img.shields.io/matrix/metron-devel:matrix.org?label=Metron%20Development&logo=matrix&style=for-the-badge)](https://matrix.to/#/#metron-development:matrix.org)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "Grayven",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "BuriedInCode <BuriedInCode@tuta.io>",
    "keywords": "comic, comics, metadata",
    "author": null,
    "author_email": "BuriedInCode <BuriedInCode@tuta.io>",
    "download_url": "https://files.pythonhosted.org/packages/a3/42/802f9d83512ea847929283d3cbbb40f6375f8eda405eb6fd3e2335689013/grayven-0.3.1.tar.gz",
    "platform": null,
    "description": "# Grayven\n\n[![PyPI - Python](https://img.shields.io/pypi/pyversions/Grayven.svg?logo=Python&label=Python&style=flat-square)](https://pypi.python.org/pypi/Grayven/)\n[![PyPI - Status](https://img.shields.io/pypi/status/Grayven.svg?logo=Python&label=Status&style=flat-square)](https://pypi.python.org/pypi/Grayven/)\n[![PyPI - Version](https://img.shields.io/pypi/v/Grayven.svg?logo=Python&label=Version&style=flat-square)](https://pypi.python.org/pypi/Grayven/)\n[![PyPI - License](https://img.shields.io/pypi/l/Grayven.svg?logo=Python&label=License&style=flat-square)](https://opensource.org/licenses/MIT)\n\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-informational?logo=pre-commit&style=flat-square)](https://github.com/pre-commit/pre-commit)\n[![Ruff](https://img.shields.io/badge/ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)\n\n[![Github - Contributors](https://img.shields.io/github/contributors/Metron-Project/Grayven.svg?logo=Github&label=Contributors&style=flat-square)](https://github.com/Metron-Project/Grayven/graphs/contributors)\n[![Github Action - Testing](https://img.shields.io/github/actions/workflow/status/Metron-Project/Grayven/testing.yaml?branch=main&logo=Github&label=Testing&style=flat-square)](https://github.com/Metron-Project/Grayven/actions/workflows/testing.yaml)\n[![Github Action - Publishing](https://img.shields.io/github/actions/workflow/status/Metron-Project/Grayven/publishing.yaml?branch=main&logo=Github&label=Publishing&style=flat-square)](https://github.com/Metron-Project/Grayven/actions/workflows/publishing.yaml)\n\n[![Read the Docs](https://img.shields.io/readthedocs/grayven?label=Read-the-Docs&logo=Read-the-Docs&style=flat-square)](https://grayven.readthedocs.io/en/stable)\n\nA [Python](https://www.python.org/) wrapper for the [Grand Comics Database API](https://github.com/GrandComicsDatabase/gcd-django/wiki/API).\n\n## Installation\n\n```console\npip install --user Grayven\n```\n\n### Example Usage\n\n```python\nfrom grayven.grand_comics_database import GrandComicsDatabase\nfrom grayven.sqlite_cache import SQLiteCache\n\nsession = GrandComicsDatabase(\n    email=\"email@example.com\",\n    password=\"password\",\n    cache=SQLiteCache()\n)\n\n# Search for Series\nresults = session.list_series(name=\"Green Lantern\")\nfor series in results:\n    print(f\"{series.id} | {series.name} ({series.year_began})\")\n\n# Get an issue's release date\nresult = session.get_issue(id=242700)\nprint(result.on_sale_date)\n```\n\n## Documentation\n\n- [Grayven](https://grayven.readthedocs.io/en/stable)\n- [GrandComicsDatabase API](https://github.com/GrandComicsDatabase/gcd-django/wiki/API)\n\n## Bugs/Requests\n\nPlease use the [GitHub issue tracker](https://github.com/Metron-Project/Grayven/issues) to submit bugs or request features.\n\n## Contributing\n\n- When running a new test for the first time, set the environment variables `GCD_EMAIL` to your GCD email address and `GCD_PASSWORD` to your GCD password.\n  The responses will be cached in the `tests/cache.sqlite` database without your credentials.\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[![Social - Matrix](https://img.shields.io/matrix/metron-devel:matrix.org?label=Metron%20Development&logo=matrix&style=for-the-badge)](https://matrix.to/#/#metron-development:matrix.org)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python wrapper for the Grand Comics Database API.",
    "version": "0.3.1",
    "project_urls": {
        "Homepage": "https://pypi.org/project/Grayven",
        "Issues": "https://github.com/Metron-Project/Grayven/issues",
        "Source": "https://github.com/Metron-Project/Grayven"
    },
    "split_keywords": [
        "comic",
        " comics",
        " metadata"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "60b1a36214607673d5cd81d89ef93653489a8f1c95a98a5090bc1d14b29a71be",
                "md5": "19b58ee07ff33f8b73600994249bda06",
                "sha256": "1d0dd096f20b3b3aede820f46dcce6407202ac958fd1243969bd87d271e90926"
            },
            "downloads": -1,
            "filename": "grayven-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "19b58ee07ff33f8b73600994249bda06",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 12424,
            "upload_time": "2025-07-21T00:16:06",
            "upload_time_iso_8601": "2025-07-21T00:16:06.228840Z",
            "url": "https://files.pythonhosted.org/packages/60/b1/a36214607673d5cd81d89ef93653489a8f1c95a98a5090bc1d14b29a71be/grayven-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a342802f9d83512ea847929283d3cbbb40f6375f8eda405eb6fd3e2335689013",
                "md5": "cd969ecc5cde2b5ed425a660c60ddb0d",
                "sha256": "a7251f322dd47f04338e03e276d50bf1b126a3ce89fbf9f2393dda3a0347d503"
            },
            "downloads": -1,
            "filename": "grayven-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "cd969ecc5cde2b5ed425a660c60ddb0d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 162441,
            "upload_time": "2025-07-21T00:16:08",
            "upload_time_iso_8601": "2025-07-21T00:16:08.111833Z",
            "url": "https://files.pythonhosted.org/packages/a3/42/802f9d83512ea847929283d3cbbb40f6375f8eda405eb6fd3e2335689013/grayven-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-21 00:16:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Metron-Project",
    "github_project": "Grayven",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "grayven"
}
        
Elapsed time: 1.30696s