diff --git a/README.md b/README.md index 8f4090b..2f7748d 100644 --- a/README.md +++ b/README.md @@ -10,35 +10,38 @@ - 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. +- Activate the project's virtual environment. You can use `poetry shell`. +- Test that everything is working by running `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. +To set up your environment, you should create a `.env` file and place it in `~/.xexe/.env`. You will have to run `xexe` as the right user to ensure the `.env` file is found. 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. +Once you have done this, you can run `xexe xe-healthcheck`. If the connection to the API was successful, you will see some output telling you so. ## Using +Remember to activate the project virtual environment. + You can use `xexe` to get rates and store them locally like this: ```bash -poetry run xexe get-rates --start-date "2024-01-01" --end-date "2024-01-10" --output my_rates.csv +xexe get-rates --start-date "2024-01-01" --end-date "2024-01-10" --output my_rates.csv ``` You can also run without specifying dates. Not specifying `end-date` will get rates up to today. Not specifying `start-date` will get dates up to last week. ```bash -poetry run xexe get-rates --output my_rates.csv +xexe get-rates --output my_rates.csv ``` `xexe` comes with a set of default currencies, but you can also specify the currencies you want to get data for by passing them like this: ```bash # Currencies must be valid ISO 4217 codes and be comma-separated -poetry run xexe get-rates --currencies USD,EUR,GBP --output my_rates.csv +xexe get-rates --currencies USD,EUR,GBP --output my_rates.csv ``` The output file will follow this schema: