https://github.com/maksimzayats/python-project-template

https://github.com/maksimzayats/python-project-template

ci docker pytest template web workflows

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/maksimzayats/python-project-template
• Owner: MaksimZayats
• Created: 2021-11-01T19:22:08.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-05T17:42:14.000Z (almost 3 years ago)
• Last Synced: 2023-12-05T07:23:16.920Z (about 1 year ago)
• Topics: ci, docker, pytest, template, web, workflows
• Language: Python
• Homepage:
• Size: 10.7 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Python Project Template

## Features

* [pre-commit](.pre-commit-config.yaml)

* [CI: GitHub Actions](.github/workflows/code_checks.yml)

* Code checks

  * `flake8`

  * `isort`

  * `black`

  * `mypy`

* [Docker](docker-compose.yml)

  * Database (`PostgreSQL`)

  * Reverse proxy (`Traefik`)

  * SSL Certificate (`letsencrypt`)

* [Tests (`Pytest`)](tests)

## Usage

* Docker

  * Configure `environment variables` or `.env` file as [`.env.docker-example`](.env.docker-example)

  * `docker-compose up --build --force-recreate`

* Default run

  * Configure `environment variables` or `.env` file as [`.env.no-docker-example`](.env.no-docker-example)

  * `python run_server.py`