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
Project details
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.dev1675011779.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20b04d9ac2de6f6700beb0b1e56dd3e03311be44927988462567d0662699846e |
|
MD5 | 3f0312d8690ca9b887d8d7da2609c482 |
|
BLAKE2b-256 | 5c0fd10467749b56e74ab69df0242b3022952f120602e224495b29912b362fd2 |
Close
Hashes for helium_api_wrapper-0.0.1.dev1675011779-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a1622da95856d35595972ff0a156939194099f7956c6493d00cbf418f4c8490 |
|
MD5 | c5cdeb958ab9aff50b66901e3307146c |
|
BLAKE2b-256 | 920d556e4be70d36ff81c3365c3e379bfe000c091f8fd589051939ed24c08a35 |