mka142/python-template

template repository for python projects

project title

Development environment

You will need to install python at least version 3.10 amd python3.10-venv.

Steps:

1. Clone the repository
2. Create virtual environment

   python3.10 -m venv venv

3. Activate virtual environment

   source venv/bin/activate

4. Install dependencies and dev dependencies

   pip install -r requirements.txt -r requirements-dev.txt

5. Now try to run tests:

   cd YOUR_PROJECT_DIRECTORY/ && pytest

Production environment

Our production environment is based on docker. If you want to run project service locally you will need to install docker.

After installing first build docker image:

./build.docker.sh

Then run docker container:

docker run --rm -it -p 8000:8000 YOUR_PROJECT_IMAGE:latest

How to Contribute to the Project

If you want to contribute to the project, please read the CONTRIBUTING.md file.

License

MIT