# Helium Api Wrapper
[][pypi_]
[][status]
[][python version]
[][license]
[][read the docs]
[][test]
[][pre-commit]
[][black]
[pypi_]: https://pypi.org/project/helium-api-wrapper/
[status]: https://pypi.org/project/helium-api-wrapper/
[python version]: https://pypi.org/project/helium-api-wrapper
[read the docs]: https://helium-api-wrapper.readthedocs.io/
[test]: https://github.com/emergotechnologies/helium-api-wrapper/actions?workflow=Test
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
## Features
- Load data from the Helium Blockchain API
- Get hotspots by address
- Get hotspots by location
- Get a list of hotspots
- Get challenges of a hotspot
- Get a list of challenges
- Load Data from the Helium Console API
- Get device information by uuid
## Requirements
- Python 3.8+
- [Poetry](https://python-poetry.org/)
## Installation
You can install _Helium Api Wrapper_ via [pip] from [PyPI]:
```console
$ pip install helium-api-wrapper
```
## Usage
You can import different modules to load data from the Helium Blockchain API or the Helium Console API.
```python
from helium_api_wrapper import hotspots, devices
hotspots.get_hotspot_by_address("some_address")
devices.get_device_by_uuid("some_uuid")
```
In order to use the Device API, you need to set the `API_KEY` environment variable.
It is also possible to set different API endpoints for the Helium Blockchain API and the Helium Console API.
````python
```console
You can run the wrapper as a python module:
````
python -m helium_api_wrapper --help
python -m helium_api_wrapper get-hotspots
python -m helium_api_wrapper get-hotspot --address your-hotspot-address
```
To personalise the settings command the file (using -, -- or CAPS to specify your settings) in a preferred terminal.
To list all possible settings run the --help command.
## Contributing
Contributions are very welcome.
To learn more, see the [Contributor Guide].
## License
Distributed under the terms of the [MIT license][license],
_Helium Api Wrapper_ is free and open source software.
## Issues
If you encounter any problems,
please [file an issue] along with a detailed description.
## Credits
This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.
[@cjolowicz]: https://github.com/cjolowicz
[pypi]: https://pypi.org/
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[file an issue]: https://github.com/emergotechnologies/helium-api-wrapper/issues
[pip]: https://pip.pypa.io/
<!-- github-only -->
[license]: https://github.com/emergotechnologies/helium-api-wrapper/blob/main/LICENSE
[contributor guide]: https://github.com/emergotechnologies/helium-api-wrapper/blob/main/CONTRIBUTING.md
[command-line reference]: https://helium-api-wrapper.readthedocs.io/en/latest/usage.html
```
Raw data
{
"_id": null,
"home_page": "https://github.com/emergotechnologies/helium-api-wrapper",
"name": "helium-api-wrapper",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Lukas Huber",
"author_email": "lukas.huber@fh-kufstein.ac.at",
"download_url": "https://files.pythonhosted.org/packages/af/22/dc9610304b64316803c71b1aafaa7c605e6621fca3fb66325b0b9d2d0b42/helium_api_wrapper-0.0.1.dev1675266436.tar.gz",
"platform": null,
"description": "# Helium Api Wrapper\n\n[][pypi_]\n[][status]\n[][python version]\n[][license]\n\n[][read the docs]\n[][test]\n\n[][pre-commit]\n[][black]\n\n[pypi_]: https://pypi.org/project/helium-api-wrapper/\n[status]: https://pypi.org/project/helium-api-wrapper/\n[python version]: https://pypi.org/project/helium-api-wrapper\n[read the docs]: https://helium-api-wrapper.readthedocs.io/\n[test]: https://github.com/emergotechnologies/helium-api-wrapper/actions?workflow=Test\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[black]: https://github.com/psf/black\n\n## Features\n\n- Load data from the Helium Blockchain API\n - Get hotspots by address\n - Get hotspots by location\n - Get a list of hotspots\n - Get challenges of a hotspot\n - Get a list of challenges\n- Load Data from the Helium Console API\n - Get device information by uuid\n\n## Requirements\n\n- Python 3.8+\n- [Poetry](https://python-poetry.org/)\n\n## Installation\n\nYou can install _Helium Api Wrapper_ via [pip] from [PyPI]:\n\n```console\n$ pip install helium-api-wrapper\n```\n\n## Usage\n\nYou can import different modules to load data from the Helium Blockchain API or the Helium Console API.\n\n```python\nfrom helium_api_wrapper import hotspots, devices\n\nhotspots.get_hotspot_by_address(\"some_address\")\ndevices.get_device_by_uuid(\"some_uuid\")\n```\n\nIn order to use the Device API, you need to set the `API_KEY` environment variable.\nIt is also possible to set different API endpoints for the Helium Blockchain API and the Helium Console API.\n\n````python\n\n```console\n\nYou can run the wrapper as a python module:\n\n````\n\npython -m helium_api_wrapper --help\npython -m helium_api_wrapper get-hotspots\npython -m helium_api_wrapper get-hotspot --address your-hotspot-address\n\n```\n\nTo personalise the settings command the file (using -, -- or CAPS to specify your settings) in a preferred terminal.\nTo list all possible settings run the --help command.\n\n## Contributing\n\nContributions are very welcome.\nTo learn more, see the [Contributor Guide].\n\n## License\n\nDistributed under the terms of the [MIT license][license],\n_Helium Api Wrapper_ is free and open source software.\n\n## Issues\n\nIf you encounter any problems,\nplease [file an issue] along with a detailed description.\n\n## Credits\n\nThis project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.\n\n[@cjolowicz]: https://github.com/cjolowicz\n[pypi]: https://pypi.org/\n[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python\n[file an issue]: https://github.com/emergotechnologies/helium-api-wrapper/issues\n[pip]: https://pip.pypa.io/\n\n<!-- github-only -->\n\n[license]: https://github.com/emergotechnologies/helium-api-wrapper/blob/main/LICENSE\n[contributor guide]: https://github.com/emergotechnologies/helium-api-wrapper/blob/main/CONTRIBUTING.md\n[command-line reference]: https://helium-api-wrapper.readthedocs.io/en/latest/usage.html\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Helium Api Wrapper",
"version": "0.0.1.dev1675266436",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5d350f8e72c9008b39dd99ad5d7ba221009d5f8e0f77d84885a54cf33da8f68b",
"md5": "9f6da38e7bf78fd526d75263c30edd38",
"sha256": "0161c87bf694677f66db2077217ce5ea475971f8c69b487ccf44ec2379f0368d"
},
"downloads": -1,
"filename": "helium_api_wrapper-0.0.1.dev1675266436-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9f6da38e7bf78fd526d75263c30edd38",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 13905,
"upload_time": "2023-02-01T15:47:20",
"upload_time_iso_8601": "2023-02-01T15:47:20.613567Z",
"url": "https://files.pythonhosted.org/packages/5d/35/0f8e72c9008b39dd99ad5d7ba221009d5f8e0f77d84885a54cf33da8f68b/helium_api_wrapper-0.0.1.dev1675266436-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "af22dc9610304b64316803c71b1aafaa7c605e6621fca3fb66325b0b9d2d0b42",
"md5": "52864e5467fb6e96011aa91fc1e1de35",
"sha256": "c094e1271f30d9d158f387955c8383ce60ced3ff41cb20b921194c5ed59d75b2"
},
"downloads": -1,
"filename": "helium_api_wrapper-0.0.1.dev1675266436.tar.gz",
"has_sig": false,
"md5_digest": "52864e5467fb6e96011aa91fc1e1de35",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 12517,
"upload_time": "2023-02-01T15:47:21",
"upload_time_iso_8601": "2023-02-01T15:47:21.775472Z",
"url": "https://files.pythonhosted.org/packages/af/22/dc9610304b64316803c71b1aafaa7c605e6621fca3fb66325b0b9d2d0b42/helium_api_wrapper-0.0.1.dev1675266436.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-01 15:47:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "emergotechnologies",
"github_project": "helium-api-wrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "helium-api-wrapper"
}
JSON
