| Name | pyrchidekt JSON |
| Version |
2.0.0
JSON |
| download |
| home_page | None |
| Summary | Archidekt API Wrapper for Python |
| upload_time | 2024-11-24 16:25:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT License |
| keywords |
archidekt
mtg
magic
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Pyrchidekt
Pyrchidekt is a Python library for interfacing with decks from the website [Archidekt](https://www.archidekt.com).
# Installation
```shell
pip install pyrchidekt
```
# Example
The following example shows how to use `pyrchidekt` to query a deck and iterate through all cards in each category.
```python
from pyrchidekt.api import getDeckById
deck = getDeckById(1)
for category in deck.categories:
print(f"{category.name}")
for card in category.cards:
print(f"\t{card.quantity} {card.card.oracle_card.name}")
print("")
```
# Developing
It is encouraged to use virtual environments to develop `pyrchidekt`. To start developing, install the requirements:
```shell
pip install -r requirements/dev.txt
```
# Testing
Testing will be run on PRs and before deploys for new releases. For local testing, see below.
## Setup
You must additionally install the testing dependencies:
```shell
pip install -r requirements/test.txt
```
All tests can be run as follows:
```shell
coverage run -m pytest tests
```
With reporting then checked using:
```shell
coverage report
```
There are two types of tests: unit and integration.
## Unit Tests
Unit tests ensure that the basic data `dict` conversion works correctly from how the inferred API works. These are run as follows:
```shell
coverage run -m pytest tests/unit
```
These tests should be run often when changing the dataclasses
## Integration Tests
Integration tests ensure that `pyrchidekt` works with the current API of Archidekt. They are run as follows:
```shell
coverage run -m pytest tests/integration
```
These tests can be run less frequently. So long as Archidekt doesn't change their API data structures, these will pass.
Raw data
{
"_id": null,
"home_page": null,
"name": "pyrchidekt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "archidekt, mtg, magic",
"author": null,
"author_email": "Ian Drake <linkian209@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c4/cc/2402bedfc6a8b600e1c2dd5f12d1ea5cde04843b791152b71ed8e37ae0ba/pyrchidekt-2.0.0.tar.gz",
"platform": null,
"description": "# Pyrchidekt\nPyrchidekt is a Python library for interfacing with decks from the website [Archidekt](https://www.archidekt.com).\n\n# Installation\n```shell\npip install pyrchidekt\n```\n\n# Example\nThe following example shows how to use `pyrchidekt` to query a deck and iterate through all cards in each category.\n```python\nfrom pyrchidekt.api import getDeckById\n\ndeck = getDeckById(1)\nfor category in deck.categories:\n print(f\"{category.name}\")\n for card in category.cards:\n print(f\"\\t{card.quantity} {card.card.oracle_card.name}\")\n print(\"\")\n```\n\n# Developing\nIt is encouraged to use virtual environments to develop `pyrchidekt`. To start developing, install the requirements:\n```shell\npip install -r requirements/dev.txt\n```\n\n# Testing\nTesting will be run on PRs and before deploys for new releases. For local testing, see below.\n\n## Setup\nYou must additionally install the testing dependencies:\n```shell\npip install -r requirements/test.txt\n```\nAll tests can be run as follows:\n```shell\ncoverage run -m pytest tests\n```\nWith reporting then checked using:\n```shell \ncoverage report\n```\nThere are two types of tests: unit and integration. \n\n## Unit Tests\nUnit tests ensure that the basic data `dict` conversion works correctly from how the inferred API works. These are run as follows:\n```shell\ncoverage run -m pytest tests/unit\n```\nThese tests should be run often when changing the dataclasses\n\n## Integration Tests\nIntegration tests ensure that `pyrchidekt` works with the current API of Archidekt. They are run as follows:\n```shell\ncoverage run -m pytest tests/integration\n```\nThese tests can be run less frequently. So long as Archidekt doesn't change their API data structures, these will pass.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Archidekt API Wrapper for Python",
"version": "2.0.0",
"project_urls": null,
"split_keywords": [
"archidekt",
" mtg",
" magic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f412c6264c09cd694d4fb41dc7afa694084b94fa1541a99608a3e812e00478d2",
"md5": "0fb510edc0c7894da85508dbce25099d",
"sha256": "c195f6f2339f87fc02a349a1da1cf7738c36f79831596dfe3ae783ca190723b3"
},
"downloads": -1,
"filename": "pyrchidekt-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0fb510edc0c7894da85508dbce25099d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 13712,
"upload_time": "2024-11-24T16:25:28",
"upload_time_iso_8601": "2024-11-24T16:25:28.315021Z",
"url": "https://files.pythonhosted.org/packages/f4/12/c6264c09cd694d4fb41dc7afa694084b94fa1541a99608a3e812e00478d2/pyrchidekt-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4cc2402bedfc6a8b600e1c2dd5f12d1ea5cde04843b791152b71ed8e37ae0ba",
"md5": "7a32ad7d4619d9e2a90839b964abf58e",
"sha256": "8623b0783f41db54520169ea88b25415e0bf1abef3a2ddbae727b9b46e580a93"
},
"downloads": -1,
"filename": "pyrchidekt-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "7a32ad7d4619d9e2a90839b964abf58e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 16687,
"upload_time": "2024-11-24T16:25:29",
"upload_time_iso_8601": "2024-11-24T16:25:29.924161Z",
"url": "https://files.pythonhosted.org/packages/c4/cc/2402bedfc6a8b600e1c2dd5f12d1ea5cde04843b791152b71ed8e37ae0ba/pyrchidekt-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-24 16:25:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyrchidekt"
}
