Helium Api Wrapper
Project description
Helium Api Wrapper
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
Installation
You can install Helium Api Wrapper via [pip] from [PyPI]:
$ pip install helium-api-wrapper
Usage
You can import different modules to load data from the Helium Blockchain API or the Helium Console API.
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.
```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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for helium_api_wrapper-0.0.1.dev1675266436.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c094e1271f30d9d158f387955c8383ce60ced3ff41cb20b921194c5ed59d75b2 |
|
| MD5 | 52864e5467fb6e96011aa91fc1e1de35 |
|
| BLAKE2b-256 | af22dc9610304b64316803c71b1aafaa7c605e6621fca3fb66325b0b9d2d0b42 |
Close
Hashes for helium_api_wrapper-0.0.1.dev1675266436-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0161c87bf694677f66db2077217ce5ea475971f8c69b487ccf44ec2379f0368d |
|
| MD5 | 9f6da38e7bf78fd526d75263c30edd38 |
|
| BLAKE2b-256 | 5d350f8e72c9008b39dd99ad5d7ba221009d5f8e0f77d84885a54cf33da8f68b |
