| Name | tier-sdk JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | TIER Python SDK |
| upload_time | 2023-07-05 11:07:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11.0 |
| license | None |
| keywords |
sdk
tier
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# TIER 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 [TIER API](https://api-documentation.tier-services.io)
## Install
Via Pip
```shell
pip install tier-sdk
```
## Usage
```python
from tier import TIER
tier = TIER(api_token="your-token")
sites = tier.vehicles.in_radius(52.548977, 13.437837, 500)
```
| Available Methods | Description |
|:-------------------------------------------------------|:----------------------------------------------------------------------------------------------------|
| `tier.vehicles.in_radius(latitude, longitude, radius)` | Retrieve a `VehiclesCollection` dict with details about vehicles for a specific radius. |
| `tier.vehicles.in_zone(zone_id)` | Retrieve a `VehiclesCollection` dict with details about vehicles for a specific radius. |
| `tier.vehicles.get(vehicle_id)` | Retrieve a `Vehicle` dict with details about a specific vehicle. |
| `tier.zones.all()` | Retrieve a `RootZonesCollection` dict with details about all zones. |
| `tier.zones.near(latitude, longitude)` | Retrieve a `RootZonesCollection` dict with details about zones within 50km of a set of coordinates. |
| `tier.zones.get(zone_id)` | Retrieve a `RootZone` dict with details about a specific zone. |
## 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/tier-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/tier-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/tier-sdk
[link-github-actions]: https://github.com/owenvoke/tier-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/tier-python-sdk/contributors
Raw data
{
"_id": null,
"home_page": null,
"name": "tier-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11.0",
"maintainer_email": null,
"keywords": "sdk,tier",
"author": null,
"author_email": "Owen Voke <development@voke.dev>",
"download_url": "https://files.pythonhosted.org/packages/da/e4/6229a74d47275e8e30e530a79fd7691d44273c48d4047ce4f1ac62239f93/tier_sdk-0.1.2.tar.gz",
"platform": null,
"description": "# TIER 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 [TIER API](https://api-documentation.tier-services.io)\n\n## Install\n\nVia Pip\n\n```shell\npip install tier-sdk\n```\n\n## Usage\n\n```python\nfrom tier import TIER\n\ntier = TIER(api_token=\"your-token\")\n\nsites = tier.vehicles.in_radius(52.548977, 13.437837, 500)\n```\n\n| Available Methods | Description |\n|:-------------------------------------------------------|:----------------------------------------------------------------------------------------------------|\n| `tier.vehicles.in_radius(latitude, longitude, radius)` | Retrieve a `VehiclesCollection` dict with details about vehicles for a specific radius. |\n| `tier.vehicles.in_zone(zone_id)` | Retrieve a `VehiclesCollection` dict with details about vehicles for a specific radius. |\n| `tier.vehicles.get(vehicle_id)` | Retrieve a `Vehicle` dict with details about a specific vehicle. |\n| `tier.zones.all()` | Retrieve a `RootZonesCollection` dict with details about all zones. |\n| `tier.zones.near(latitude, longitude)` | Retrieve a `RootZonesCollection` dict with details about zones within 50km of a set of coordinates. |\n| `tier.zones.get(zone_id)` | Retrieve a `RootZone` dict with details about a specific zone. |\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/tier-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/tier-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/tier-sdk\n[link-github-actions]: https://github.com/owenvoke/tier-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/tier-python-sdk/contributors\n",
"bugtrack_url": null,
"license": null,
"summary": "TIER Python SDK",
"version": "0.1.2",
"project_urls": {
"Issues": "https://github.com/owenvoke/tier-python-sdk/issues",
"Source Code": "https://github.com/owenvoke/tier-python-sdk"
},
"split_keywords": [
"sdk",
"tier"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0c076d04b6d113e8c7a43d20a771c29aade52e26d714428330d1a1b04151bcd3",
"md5": "c440e50d29ad1aeabdc360fed0dd8865",
"sha256": "e0c3f650e9f0eff693552ba7b8c6206e84417b5ce576f409322f76cfa32746a0"
},
"downloads": -1,
"filename": "tier_sdk-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c440e50d29ad1aeabdc360fed0dd8865",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11.0",
"size": 5024,
"upload_time": "2023-07-05T11:07:29",
"upload_time_iso_8601": "2023-07-05T11:07:29.473663Z",
"url": "https://files.pythonhosted.org/packages/0c/07/6d04b6d113e8c7a43d20a771c29aade52e26d714428330d1a1b04151bcd3/tier_sdk-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dae46229a74d47275e8e30e530a79fd7691d44273c48d4047ce4f1ac62239f93",
"md5": "412d94fb8d729ad9d90b4a4fd7a38576",
"sha256": "aafe5e533702d6c46ffe19e5e8265b35fb7efed1bf21043e81485178248d182f"
},
"downloads": -1,
"filename": "tier_sdk-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "412d94fb8d729ad9d90b4a4fd7a38576",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11.0",
"size": 4761,
"upload_time": "2023-07-05T11:07:27",
"upload_time_iso_8601": "2023-07-05T11:07:27.792366Z",
"url": "https://files.pythonhosted.org/packages/da/e4/6229a74d47275e8e30e530a79fd7691d44273c48d4047ce4f1ac62239f93/tier_sdk-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-05 11:07:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "owenvoke",
"github_project": "tier-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tier-sdk"
}
