This is a Python project that uses pytest for testing and is configured for development in Visual Studio Code. It also includes a Dockerfile for containerization.
The main application code is located in the app
directory, with the entry point in app/main.py
. The app
directory also contains a core
subdirectory for core functionality and an adapter
subdirectory for adapters.
The tests
directory contains unit, integration, and end-to-end tests.
- Python 3.10
- pip
- Clone the repository.
- Install the dependencies:
pip install -r dev_requirements.txt
To run the application:
python app/main.py
To run the tests:
pytest
This project is configured for development in Visual Studio Code with settings for the Python extension, including formatting and linting settings. The .vscode
directory contains the configuration files.
A Dockerfile is included for building a Docker image of the application. To build the image:
docker build -t <image-name> .
To run the application in a Docker container:
docker run -p 80:80 <image-name>
The project includes a GitHub Actions workflow for continuous integration, which runs tests and security checks on push and pull request events to the main branch.
The application uses Python's built-in logging module, with configuration in app/adapter/logger/config_log.json
.
To create the package, run the following command:
python setup.py sdist bdist_wheel
The package is available on whl file in the dist folder. To install it, run the following command:
pip install dist/<app-name>-0.1-py3-none-any.whl
Note : 0.1 is the version of the package, change it if needed.
Contributions are welcome. Please submit a pull request or create an issue to discuss the changes.