Delivers regular emails of cost management data in an HTML format
This is a Python project developed using Python 3.11. Make sure you have at least this version installed.
After following the setup steps described below the following components and flow will be in place for your development environment.
+----------------------------+ +-------------------------+
| +---------------------------------->+ |
| koku-report-emailer | | cloud.redhat.com |
| | | |
| +<----------------------------------+ |
+----------------------------+ +-------------------------+
|
|
|
|
|
| +-----------------+
| | |
| | gmail.com |
+-------------------->+ |
| |
+-----------------+
To get started developing the koku-report-emailer first clone a local copy of the git repository.
git clone https://github.com/project-koku/koku-report-emailer.git
Many configuration settings can be read in from a .env file. An example file .env.dev.example is provided in the repository. To use the defaults simply run:
cp .env.dev.example .env
Modify as you see fit.
A Pipfile is provided. Pipenv is recommended for combining virtual environment (virtualenv) and dependency management (pip). To install pipenv, use pip :
pip3 install pipenv
Then project dependencies and a virtual environment can be created using:
pipenv install --dev
Install the pre-commit hooks for the repository:
pre-commit install