Gino's Python project template

A Python3 project template with pipenv to hande dependencies.

Inspired by Kenneth Reitz's project template.

Features

• Support for Python 3.8 and greater
• Support for Linux and MacOS
• GitHub workflow templates
• Linting with flake8 and mypy
• Formatting with yapf
• Test-driven development with PyTest, with mocking and code coverage support

Requirements

• Python 3.8 or better

Quick Start

python3 ./bootstrap.py --project your_new_project_name

The bootstrapping script will create your new project's root directory. Follow all of the TODOs embedded in the newly-created files:

• All *.py files.
• pyproject.toml

Consider changing the project licence with yours, and adjust the licencing metadata in setup.cfg.

This project can be installed to your system or virtual environments via pip install . or ./setup.py install. To know more, see the setuptools documentation.

Finally, take ownership of this template project and replace this README!

Maintaining this Project

./bootstrap --dev
source .venv/bin/activate

You may then continue working in the files local to this project.

If you are going to update pyproject.toml, make sure to reflect those changes in pyproject.toml.template.