helium-api-wrapper 0.0.1.dev1675259166

Helium Api Wrapper

Helium Api Wrapper

[][license]

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