whereis-client/README.md

whereis-client

A simple Python client library to interact easyly with the WhereIs REST API.

Install

pip install --index-url https://gitea.thegux.fr/api/packages/rmanach/pypi/simple/ whereis-client==<version> --extra-index-url https://pypi.org/simple

How to ?

In order to use the client you need to provide some environments variables defined in .env.example. You can either:

• Copy the .env.example into .env and feed the variables (.env should be next to your main script using the lib)
• Add those environments variables to your environment profile.

Once it's done, you're good to use the client.

from whereis_client import Client

cli = Client.from_env()
lst_gps_positions = cli.get_gps_positions(
    date_start="2022-12-25", date_end="2022-12-30"
)

For some code samples on how to use the client, take a look at the main.py sample script.

Enjoy !

Contact

If you have any issues, feel free to contact admin@thegux.fr for fixes or upgrades.