| Name | esak JSON |
| Version |
2.0.0
JSON |
| download |
| home_page | None |
| Summary | Python wrapper for the Marvel API. |
| upload_time | 2024-11-26 16:56:17 |
| maintainer | Brian Pepple |
| docs_url | None |
| author | Brian Pepple |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# esak - Python wrapper for Marvel API
[](https://pypi.python.org/pypi/esak/)
[](https://pypi.python.org/pypi/esak/)
[](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/esak/graphs/contributors)
[](https://github.com/Metron-Project/esak/actions/workflows/testing.yml)
[](https://codecov.io/gh/Metron-Project/esak)
[](https://esak.readthedocs.io/en/stable)
This project is a fork of [marvelous](https://github.com/rkuykendall/marvelous) with the goal of supporting the full Marvel API.
## Installation
```console
pip install --user esak
```
## Example Usage
```python
import esak
# Your own config file to keep your private key local and secret
from config import public_key, private_key
# Authenticate with Marvel, with keys I got from http://developer.marvel.com/
m = esak.api(public_key, private_key)
# Get all comics from this week, sorted alphabetically by title
pulls = sorted(m.comics_list({
'format': "comic",
'formatType': "comic",
'noVariants': True,
'dateDescriptor': "thisWeek",
'limit': 100}),
key=lambda comic: comic.title)
for comic in pulls:
# Write a line to the file with the name of the issue, and the id of the series
print(f'{comic.title} (series #{comic.series.id})')
```
## Documentation
- [esak](https://esak.readthedocs.io/en/stable)
- [Marvel API](https://developer.marvel.com/docs)
## Bugs/Requests
Please use the [GitHub issue tracker](https://github.com/Metron-Project/esak/issues) to submit bugs or request features.
## Contributing
- When running a new test for the first time, set the environment variables `PUBLIC_KEY` and `PRIVATE_KEY` to your Marvel API keys.
The responses will be cached in the `tests/testing_mock.sqlite` database without your keys.
## Socials
[](https://matrix.to/#/#metron-general:matrix.org)
[](https://matrix.to/#/#metron-development:matrix.org)
Raw data
{
"_id": null,
"home_page": null,
"name": "esak",
"maintainer": "Brian Pepple",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": "bdpepple@gmail.com",
"keywords": null,
"author": "Brian Pepple",
"author_email": "bdpepple@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ec/43/8548361d99e50883c96813e5d8a4b954ef54baf236ea28039a1fa13a9b43/esak-2.0.0.tar.gz",
"platform": null,
"description": "# esak - Python wrapper for Marvel API\n\n[](https://pypi.python.org/pypi/esak/)\n[](https://pypi.python.org/pypi/esak/)\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/esak/graphs/contributors)\n[](https://github.com/Metron-Project/esak/actions/workflows/testing.yml)\n[](https://codecov.io/gh/Metron-Project/esak)\n\n[](https://esak.readthedocs.io/en/stable)\n\nThis project is a fork of [marvelous](https://github.com/rkuykendall/marvelous) with the goal of supporting the full Marvel API.\n\n## Installation\n\n```console\npip install --user esak\n```\n\n## Example Usage\n\n```python\nimport esak\n\n# Your own config file to keep your private key local and secret\nfrom config import public_key, private_key\n\n# Authenticate with Marvel, with keys I got from http://developer.marvel.com/\nm = esak.api(public_key, private_key)\n\n# Get all comics from this week, sorted alphabetically by title\npulls = sorted(m.comics_list({\n 'format': \"comic\",\n 'formatType': \"comic\",\n 'noVariants': True,\n 'dateDescriptor': \"thisWeek\",\n 'limit': 100}),\n key=lambda comic: comic.title)\n\nfor comic in pulls:\n # Write a line to the file with the name of the issue, and the id of the series\n print(f'{comic.title} (series #{comic.series.id})')\n```\n\n## Documentation\n\n- [esak](https://esak.readthedocs.io/en/stable)\n- [Marvel API](https://developer.marvel.com/docs)\n\n## Bugs/Requests\n\nPlease use the [GitHub issue tracker](https://github.com/Metron-Project/esak/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 `PUBLIC_KEY` and `PRIVATE_KEY` to your Marvel API keys.\n The responses will be cached in the `tests/testing_mock.sqlite` database without your keys.\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": "MIT",
"summary": "Python wrapper for the Marvel API.",
"version": "2.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/Metron-Project/esak/issues",
"Homepage": "https://github.com/Metron-Project/esak"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3754da4abf304f5bd0e8efc3c5c6923fa53c750dd05207eecb8ec7445c95958c",
"md5": "b12eda987ae5d88748ea4de22f5b2c30",
"sha256": "84d838d6c4472f4608169e634a330b3c375e7bbbbe2ffb804363e2608850b1b4"
},
"downloads": -1,
"filename": "esak-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b12eda987ae5d88748ea4de22f5b2c30",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 16971,
"upload_time": "2024-11-26T16:56:15",
"upload_time_iso_8601": "2024-11-26T16:56:15.952979Z",
"url": "https://files.pythonhosted.org/packages/37/54/da4abf304f5bd0e8efc3c5c6923fa53c750dd05207eecb8ec7445c95958c/esak-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec438548361d99e50883c96813e5d8a4b954ef54baf236ea28039a1fa13a9b43",
"md5": "8369a04ca7954ac75166b89fad13a6e6",
"sha256": "3caeff8b6b69c9c2ac27990623dad4e868f631ecdcfdbb9b7c34733407cf7256"
},
"downloads": -1,
"filename": "esak-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8369a04ca7954ac75166b89fad13a6e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 336486,
"upload_time": "2024-11-26T16:56:17",
"upload_time_iso_8601": "2024-11-26T16:56:17.999798Z",
"url": "https://files.pythonhosted.org/packages/ec/43/8548361d99e50883c96813e5d8a4b954ef54baf236ea28039a1fa13a9b43/esak-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 16:56:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Metron-Project",
"github_project": "esak",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "esak"
}
