| Name | Simyan JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | A Python wrapper for the Comicvine API. |
| upload_time | 2024-10-03 01:17:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
comic
comics
metadata
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Simyan
[](https://pypi.python.org/pypi/Simyan/)
[](https://pypi.python.org/pypi/Simyan/)
[](https://pypi.python.org/pypi/Simyan/)
[](https://opensource.org/licenses/GPL-3.0)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/astral-sh/ruff)
[](https://github.com/Metron-Project/Simyan/graphs/contributors)
[](https://github.com/Metron-Project/Simyan/actions/workflows/testing.yaml)
[](https://github.com/Metron-Project/Simyan/actions/workflows/publishing.yaml)
[](https://simyan.readthedocs.io/en/stable)
A [Python](https://www.python.org/) wrapper for the [Comicvine API](https://comicvine.gamespot.com/api/).
## Installation
```console
pip install --user Simyan
```
### 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.id} | {publisher.name} - {publisher.site_url}")
# Get details for a Volume
result = session.get_volume(volume_id=26266)
print(result.summary)
```
## Documentation
- [Simyan](https://simyan.readthedocs.io/en/stable)
- [Comicvine API](https://comicvine.gamespot.com/api/documentation)
## Bugs/Requests
Please use the [GitHub issue tracker](https://github.com/Metron-Project/Simyan/issues) 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
[](https://matrix.to/#/#metron-general:matrix.org)
[](https://matrix.to/#/#metron-development:matrix.org)
Raw data
{
"_id": null,
"home_page": null,
"name": "Simyan",
"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/2c/7b/322fa9224bd657ad65a7960a499f4102b15230122026f26cec8870e07c6c/simyan-1.3.0.tar.gz",
"platform": null,
"description": "# Simyan\n\n[](https://pypi.python.org/pypi/Simyan/)\n[](https://pypi.python.org/pypi/Simyan/)\n[](https://pypi.python.org/pypi/Simyan/)\n[](https://opensource.org/licenses/GPL-3.0)\n\n[](https://github.com/pre-commit/pre-commit)\n[](https://github.com/astral-sh/ruff)\n\n[](https://github.com/Metron-Project/Simyan/graphs/contributors)\n[](https://github.com/Metron-Project/Simyan/actions/workflows/testing.yaml)\n[](https://github.com/Metron-Project/Simyan/actions/workflows/publishing.yaml)\n\n[](https://simyan.readthedocs.io/en/stable)\n\nA [Python](https://www.python.org/) wrapper for the [Comicvine API](https://comicvine.gamespot.com/api/).\n\n## Installation\n\n```console\npip install --user Simyan\n```\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.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## Documentation\n\n- [Simyan](https://simyan.readthedocs.io/en/stable)\n- [Comicvine API](https://comicvine.gamespot.com/api/documentation)\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## Contributing\n\n- When running a new test for the first time, set the environment variable `COMICVINE__API_KEY` to your Comicvine API key.\n The responses will be cached in the `tests/cache.sqlite` database without your key.\n\n## Socials\n\n[](https://matrix.to/#/#metron-general:matrix.org)\n[](https://matrix.to/#/#metron-development:matrix.org)\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python wrapper for the Comicvine API.",
"version": "1.3.0",
"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": "f1de316584c7c3b96749838d19d7bdac2bbc2a4750c0b2ab2ac54947e1c62ce9",
"md5": "05f1df54169e6242aeefe632a61ea49d",
"sha256": "9cf18d4254d1640cd4167e6984120dcf681a6c3678e6ea9ee7bc4e2f4cb67898"
},
"downloads": -1,
"filename": "simyan-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05f1df54169e6242aeefe632a61ea49d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 33795,
"upload_time": "2024-10-03T01:17:37",
"upload_time_iso_8601": "2024-10-03T01:17:37.588300Z",
"url": "https://files.pythonhosted.org/packages/f1/de/316584c7c3b96749838d19d7bdac2bbc2a4750c0b2ab2ac54947e1c62ce9/simyan-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c7b322fa9224bd657ad65a7960a499f4102b15230122026f26cec8870e07c6c",
"md5": "90abe7f105991e59b5eaf520b333a154",
"sha256": "5ed9aacafcfa028e1ff652620ff5fe71453eb26a9990e1670d50c8c34b469f2c"
},
"downloads": -1,
"filename": "simyan-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "90abe7f105991e59b5eaf520b333a154",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4126579,
"upload_time": "2024-10-03T01:17:39",
"upload_time_iso_8601": "2024-10-03T01:17:39.606948Z",
"url": "https://files.pythonhosted.org/packages/2c/7b/322fa9224bd657ad65a7960a499f4102b15230122026f26cec8870e07c6c/simyan-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-03 01:17:39",
"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"
}
