| Name | pyrchidekt JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | |
| Summary | Archidekt API Wrapper for Python |
| upload_time | 2024-02-22 19:52:50 |
| maintainer | |
| docs_url | None |
| author | |
| 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": "",
"name": "pyrchidekt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "archidekt,mtg,magic",
"author": "",
"author_email": "Ian Drake <linkian209@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8a/d7/b65d562b4b037960adca3fb0a5fe833fd450c364473c3bb87e29716e6a2e/pyrchidekt-1.1.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": "1.1.0",
"project_urls": null,
"split_keywords": [
"archidekt",
"mtg",
"magic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2b1694c285817957ec1f6af98cc29abe123440adf342e1150ab2b65ad1b1697",
"md5": "441cd83161ad7b2c5d6f75955903fee6",
"sha256": "5d4b9b10917de5195e708536a9426022167589619c58d25b54844177f2ed1a1e"
},
"downloads": -1,
"filename": "pyrchidekt-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "441cd83161ad7b2c5d6f75955903fee6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 13710,
"upload_time": "2024-02-22T19:52:48",
"upload_time_iso_8601": "2024-02-22T19:52:48.622502Z",
"url": "https://files.pythonhosted.org/packages/f2/b1/694c285817957ec1f6af98cc29abe123440adf342e1150ab2b65ad1b1697/pyrchidekt-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8ad7b65d562b4b037960adca3fb0a5fe833fd450c364473c3bb87e29716e6a2e",
"md5": "364e536911d4471aac85e3324a22e295",
"sha256": "d866c8aefd55590ba1d8d6b2daceed0a5713bb7bbb85286a530817b39b8098e4"
},
"downloads": -1,
"filename": "pyrchidekt-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "364e536911d4471aac85e3324a22e295",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 16700,
"upload_time": "2024-02-22T19:52:50",
"upload_time_iso_8601": "2024-02-22T19:52:50.303747Z",
"url": "https://files.pythonhosted.org/packages/8a/d7/b65d562b4b037960adca3fb0a5fe833fd450c364473c3bb87e29716e6a2e/pyrchidekt-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 19:52:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyrchidekt"
}
