A python CLI client for accessing Bioto data
Project description
PyClient
Python Client for retrieving Bioto sensor data
Goals
Auth0 login
- As a user I can login via auth0 to get a valid access token
Both of these steps can be accomplished by enabling device authentication.
Retrieving sensor data
- As a user I can find a garden
- As a user I can subscribe to that garden
- As a user I can see my subscribtion state for that garden (pending/approved/declined)
- As a iser I can get an overview of "my gardens"
- As a user I can retrieve sensor data from my gardens
- current
- raw data up to 7 days ago
- downsampled data when more than 7 days ago
Getting started
Software is installed via make (see below), this will setup a virtual python
environments managed via poetry
% pip install --user bioto-client
How to use
When not installed as a python package but via make install
run poetry shell
from the root of the project first. Otherwise the first step can be skipped.
# Call the client with the `user` command to assert a valid session
% bioto-client user
Loading session
Not logged in, please take the following steps:
1. On your computer or mobile device navigate to: https://biotoco.eu.auth0.com/activate?user_code=NEWT-OKEN
2. Enter the following code: NEWT-OKEN
Succesfully logged in.
Bioto CLI client
Session token ***5OFd09w
Tip Use
bioto-client --help
to see other available commands
Improve the client
If you want to improve the client or add something which you think is missing to the project you can either open an issue or develop the feature yourself and open a pull request with your changes.
To get started clone this project and create a branch. Now fix the bug or create the feature you want and write some tests for it to prove it works. This can be done by executing:
% make check
Note This will run both tests and linters, use
make test
when you're inred - green - refactor
mode
When the checks are all passing, please open a PR
Project details
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
Hashes for bioto_client-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96c16b6c76cc88971b18acb285164a9fceaa8e74a61b580ffbf73486ed53fd50 |
|
MD5 | adbae155238f315893491cfb028cff85 |
|
BLAKE2b-256 | a2f9c9d7e49465f24f9956ec44a67c5cf346497634b2f9b6cf43d7c9c43d8952 |