counterweight/data-xexe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

more readme, env template

Browse source
This commit is contained in:
Pablo Martin 2024-06-06 11:41:05 +02:00
parent d552e92fbe
commit c146458876
2 changed files with 21 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -2,6 +2,25 @@
`xexe` is Superhog's tool to ingest currency rates from xe.com into our DWH. `xexe` is a Python CLI application, and this is the repository where it lives.
## How to use the tool
*Note: the app has only been used so far in a Linux environment. Windows support is dubious.*
### Install
- Ensure you have Python 3.10> and `poetry` installed.
- Run `poetry install` to install dependencies.
- Test that everything is working by running `poetry run xexe smoke-test`. You should see a happy pig.
### Set up credentials
To use `xexe`, you will need to have credentials for the `xe.com` API. Specifically, you need an account id and it's matching api key.
To set up your environment, you should create a `.env` file in the root of this repository. You can use the `.env-example` file as a reference. We also recommend running `chmod 400` or `chmod 600` on it for safety.
Once you have done this, you can run `poetry run xexe xe-healthcheck`. If the connection to the API was successful, you will see some output telling you so.
## How to setup dev environment
*Note: the app has only been used so far in a Linux environment. Windows support is dubious.*