| Name | riitag-sdk JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | RiiTag Python SDK |
| upload_time | 2023-07-20 09:39:13 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.11.0 |
| license | |
| keywords |
riitag
sdk
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# RiiTag Python
[![Latest Version on PyPi][ico-version]][link-pypi]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-github-actions]][link-github-actions]
[![Buy us a tree][ico-treeware-gifting]][link-treeware-gifting]
An SDK to easily work with the [RiiTag API](https://tag.rc24.xyz)
## Install
Via Pip
```shell
pip install riitag-sdk
```
## Usage
```python
from riitag import RiiTag
riitag = RiiTag()
tag = riitag.tags.get("206054190127120386")
```
| Available Methods | Description |
|:----------------------------|:------------------------------------------------|
| `riitag.tags.get(username)` | Retrieve a `Tag` dict with details about a tag. |
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
```shell
hatch shell
hatch run test
```
## Security
If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.
## Credits
- [Owen Voke][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Treeware
You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.
It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
You can buy trees [here][link-treeware-gifting].
Read more about Treeware at [treeware.earth][link-treeware].
[ico-version]: https://img.shields.io/pypi/v/riitag-sdk.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-github-actions]: https://img.shields.io/github/actions/workflow/status/owenvoke/riitag-python-sdk/tests.yml?branch=main&style=flat-square
[ico-treeware-gifting]: https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=flat-square
[link-pypi]: https://pypi.org/project/riitag-sdk
[link-github-actions]: https://github.com/owenvoke/riitag-python-sdk/actions
[link-treeware]: https://treeware.earth
[link-treeware-gifting]: https://ecologi.com/owenvoke?gift-trees
[link-author]: https://github.com/owenvoke
[link-contributors]: https://github.com/owenvoke/riitag-python-sdk/contributors
Raw data
{
"_id": null,
"home_page": "",
"name": "riitag-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11.0",
"maintainer_email": "",
"keywords": "riitag,sdk",
"author": "",
"author_email": "Owen Voke <development@voke.dev>",
"download_url": "https://files.pythonhosted.org/packages/6c/19/fee5c419d13062e57e29ca8bf50f990738d464fb617c4a7af4d78d3b87c0/riitag_sdk-0.1.0.tar.gz",
"platform": null,
"description": "# RiiTag Python\n\n[![Latest Version on PyPi][ico-version]][link-pypi]\n[![Software License][ico-license]](LICENSE.md)\n[![Build Status][ico-github-actions]][link-github-actions]\n[![Buy us a tree][ico-treeware-gifting]][link-treeware-gifting]\n\nAn SDK to easily work with the [RiiTag API](https://tag.rc24.xyz)\n\n## Install\n\nVia Pip\n\n```shell\npip install riitag-sdk\n```\n\n## Usage\n\n```python\nfrom riitag import RiiTag\n\nriitag = RiiTag()\n\ntag = riitag.tags.get(\"206054190127120386\")\n```\n\n| Available Methods | Description |\n|:----------------------------|:------------------------------------------------|\n| `riitag.tags.get(username)` | Retrieve a `Tag` dict with details about a tag. |\n\n## Change log\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Testing\n\n```shell\nhatch shell\n\nhatch run test\n```\n\n## Security\n\nIf you discover any security related issues, please email security@voke.dev instead of using the issue tracker.\n\n## Credits\n\n- [Owen Voke][link-author]\n- [All Contributors][link-contributors]\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n\n## Treeware\n\nYou're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.\n\nIt\u2019s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you\u2019ll be creating employment for local families and restoring wildlife habitats.\n\nYou can buy trees [here][link-treeware-gifting].\n\nRead more about Treeware at [treeware.earth][link-treeware].\n\n[ico-version]: https://img.shields.io/pypi/v/riitag-sdk.svg?style=flat-square\n[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\n[ico-github-actions]: https://img.shields.io/github/actions/workflow/status/owenvoke/riitag-python-sdk/tests.yml?branch=main&style=flat-square\n[ico-treeware-gifting]: https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=flat-square\n\n[link-pypi]: https://pypi.org/project/riitag-sdk\n[link-github-actions]: https://github.com/owenvoke/riitag-python-sdk/actions\n[link-treeware]: https://treeware.earth\n[link-treeware-gifting]: https://ecologi.com/owenvoke?gift-trees\n[link-author]: https://github.com/owenvoke\n[link-contributors]: https://github.com/owenvoke/riitag-python-sdk/contributors\n",
"bugtrack_url": null,
"license": "",
"summary": "RiiTag Python SDK",
"version": "0.1.0",
"project_urls": {
"Issues": "https://github.com/owenvoke/riitag-python-sdk/issues",
"Source Code": "https://github.com/owenvoke/riitag-python-sdk"
},
"split_keywords": [
"riitag",
"sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89aed29767d5e20d7b0b2857c84489c4dd669f6574f65aa5e4a5edd9cbb45326",
"md5": "136aa5d096ec7d9e16d4abbe5a2b2517",
"sha256": "13113b0f138bde84d716ad81f948cafc586c6561cc39d675aa8cbe0e26f8d0a9"
},
"downloads": -1,
"filename": "riitag_sdk-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "136aa5d096ec7d9e16d4abbe5a2b2517",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11.0",
"size": 5036,
"upload_time": "2023-07-20T09:39:12",
"upload_time_iso_8601": "2023-07-20T09:39:12.001348Z",
"url": "https://files.pythonhosted.org/packages/89/ae/d29767d5e20d7b0b2857c84489c4dd669f6574f65aa5e4a5edd9cbb45326/riitag_sdk-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6c19fee5c419d13062e57e29ca8bf50f990738d464fb617c4a7af4d78d3b87c0",
"md5": "971e7ff3afe5dac003c2565033511e6b",
"sha256": "d0344d4e6fa9e2b1e9fee7403d26ea14718aedd4b1d2b3040daa9c2a4e093c4a"
},
"downloads": -1,
"filename": "riitag_sdk-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "971e7ff3afe5dac003c2565033511e6b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11.0",
"size": 6404,
"upload_time": "2023-07-20T09:39:13",
"upload_time_iso_8601": "2023-07-20T09:39:13.319147Z",
"url": "https://files.pythonhosted.org/packages/6c/19/fee5c419d13062e57e29ca8bf50f990738d464fb617c4a7af4d78d3b87c0/riitag_sdk-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-20 09:39:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "owenvoke",
"github_project": "riitag-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "riitag-sdk"
}
