From 6494c0ce584bd7a869d75ce4959403c830222936 Mon Sep 17 00:00:00 2001 From: Pablo Martin Date: Mon, 3 Jun 2024 18:41:34 +0200 Subject: [PATCH] dev env instructions --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 4647a9b..bcddf9a 100644 --- a/README.md +++ b/README.md @@ -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.