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

remove redundant stuff

Browse source
This commit is contained in:
Pablo Martin 2024-06-06 16:40:35 +02:00
parent 464349be09
commit 69fdb1a15e
1 changed files with 0 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -20,14 +20,3 @@ To use `xexe`, you will need to have credentials for the `xe.com` API. Specifica
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.*
- 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.