- Python 96.6%
- Dockerfile 3.4%
3b5fbf1ad1Bumps [idna](https://github.com/kjd/idna) from 3.6 to 3.7. - [Release notes](https://github.com/kjd/idna/releases) - [Changelog](https://github.com/kjd/idna/blob/master/HISTORY.rst) - [Commits](https://github.com/kjd/idna/compare/v3.6...v3.7) --- updated-dependencies: - dependency-name: idna dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> |
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| boreas | ||
| tests | ||
| .DS_Store | ||
| .env.example | ||
| .gitignore | ||
| asgi.py | ||
| Dockerfile | ||
| poetry.lock | ||
| pyproject.toml | ||
| README.md | ||
| tox.ini | ||
Boreas
Boreas is a simple service enabling Harmonia to accept transactions from retailers via an API.
Pre-requisites
- Python >= 3.10
- poetry
Configuration
The project is configured through environment variables. A convenient way
of setting these is via the .env file found in the project root. See settings.py for
configuration options that can be set in this file.
Your code editor should support loading environment variables from the .env
file either out of the box or with a plugin. For shell usages, you can have poetry
automatically load these environment variables by using
poetry-dotenv-plugin, or
use a tool like direnv.
Running the Project
uvicorn asgi:app --host 0.0.0.0 --port 8001
python dlx_consumer.py
The consumer is used for retrying queued transactions that for whatever reason didn't make it into Harmonia.
Deployment
There is a Dockerfile provided in the project root. Build an image from this to get a deployment-ready version of the project.
Unit Tests
pytest tests
Tests will be autodiscovered.