vfedotovs / poetry-demo-calc

This demo application with python project setup best practices and template files

Project Name

A brief description of what the project does.

Table of Contents

• Installation
• Usage
• Contributing
• License

Installation

Clone the repository:

git clone https://github.com/username/project.git
cd project
poetry install

Usage:

```bash
poetry shell
python app.py
```

Contributing:

Contributions are welcome! Please see the Contributing Guidelines.

License:

This project is licensed under the MIT License.

Python project checklist

• Source code in separate folder
• Tests code in test folder
• README file wich contains usefull information
• Code documentation in docs folder
• Makefile for more productive work:
  • Target for setup and activate env using poetry
    • poetry env use python3.9 # creates venv
    • poetry shell # activate venv
    • poetry add package_name # adds dependency
    • poetry install # install dependencies in venv
    • simply type exit or press Ctrl + D. # deactivates venv
  • Target for running tests with pytest
  • Target for running test coverage with pytest
  • Target for code formating using black
  • Target for linting code with pylint to get code quality assesment and error check
  • Target for building application from Dockerfile to containerize app
  • Target for running container locally
  • Traget for pushing container image to dockerhub
  • Target for post deployment tests Push docker container
  • Target for creating docs
  • Target for cleanup after tests
• Contribute.md file for guidelines
• Github actions automation to trigger tests and formarating, continerization and push on commit
• Security to protect main branche that does not allow push to main branche without PR