From 8755ef2f7cda9e2327cbdc740e6efcbb97557641 Mon Sep 17 00:00:00 2001 From: rmanach Date: Wed, 18 Dec 2024 11:49:29 +0100 Subject: [PATCH] add README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3e1855a --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# whereis-client + +A simple Python client library to interact easyly with the WhereIs REST API. + +## Install + +```bash +pip install whereis_client== -i https://gitea.thegux.fr/api/packages/whereis-client/pypi/simple/ --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. + +For some code samples on how to use the client, take a look at the [main.py](main.py) sample script. + +Enjoy ! + +## Contact + +If you have any issues, feel free to contact **admin@thegux.fr** for fixes or upgrades.