- Python 3.9
- Docker
- Install pre-commit and commit-linter
pip install pre-commit pip install commit-linter
- Install necessary packages for development purposes locally using pipenv
pipenv shell pipenv install --dev
- Create a
.env
file by duplicating.env.example
. Put the values according to your system setup. - Create a file to capture logs while development. The file path should be
logs/app.log
inside the project root directory. - Run Docker environment
Note: The
docker compose up --build
--build
is only need when you make any dependencies changes in the project.
After creating virtual environment using pipenv. Execute the following command to run test cases
- Run all the test cases
pytest .
- Run test cases of specific module
pytest tests/<module_name>
-
- Run a specific test cases of
pytest tests/<module_name>::<function_name>