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

dev env instructions

Browse source
This commit is contained in:
Pablo Martin 2024-06-03 18:41:34 +02:00
parent d4a78ea4ea
commit 6494c0ce58
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,3 +1,14 @@
# xexe
`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 setup dev environment
*Note: the app has only been used so far in a Linux environment. Windows support is dubious.*
- Ensure you have Python 3.10> and `poetry` installed.
- Run `poetry install` to install dependencies.
- Create a valid `.env` file
- You can use the template at `.env.example`
- Make sure to run a `chmod 600` on it to protect secrets.
- Test that everything is working by running `poetry run xexe smoke-test`. You should see a happy pig.