Viofo dashcam utilities

Basti Tee 5ce8d941d7 Update README		vor 3 Jahren
.github	47af1e67a3 make default	vor 4 Jahren
.vscode	c2c83abfdf Fix test discovery	vor 3 Jahren
my_module	3a55281f2c Add mypy and pylance	vor 3 Jahren
tests	c2c83abfdf Fix test discovery	vor 3 Jahren
.editorconfig	9cd846f725 Integrate different config files	vor 4 Jahren
.gitignore	7b38a1c22f Ignore IntelliJ project config	vor 4 Jahren
LICENSE.txt	2085931545 Merge pypi sample project	vor 5 Jahren
Makefile	3a55281f2c Add mypy and pylance	vor 3 Jahren
Pipfile	3a55281f2c Add mypy and pylance	vor 3 Jahren
README.md	5ce8d941d7 Update README	vor 3 Jahren
__rename__.sh	9231dfffce Harden rename script	vor 4 Jahren
setup.cfg	3a55281f2c Add mypy and pylance	vor 3 Jahren
setup.py	e10e97185a Update setup.py	vor 4 Jahren

python3-boilerplate

A best-practices template project for Python3 modules

Disclaimer: If you see this on pypi.org please note that the project is only published here for testing purposes. Please visit GitHub for the related template project.

Setup

Make sure that python3 and pip3 is installed and available on the path (on Ubuntu: sudo apt-get install python3 python3-pip)
On first checkout run make venv to initialize the project configuration
Refer to the Makefile to learn about the various operations available
To rename the project you can use the provided script

Features

Basic project/module organization according to https://packaging.python.org
Makefile management script
pipenv and virtual environments
distutils-based installer script
Unit testing with pytest
Multicore/-interpreter testing with tox
Linting (flake8) and code formatting (autopep8) support
isort support for automated import sorting
mpyp support for type checking
Publishing to PyPi.org at https://pypi.org/project/python3-boilerplate/
vscode editor configuration including plugin recommendations, debugging support, unit test discovery and on-save formatting
Github actions continuous integration

How to use in existing project

To use it in an existing project you can merge the remote changes to your project.

Add remote to access the template project

git remote add py3template git@github.com:BastiTee/python3-boilerplate.git
git pull py3template master --allow-unrelated-histories

Solve all merge conflicts and commit. Most likely there will be a lot
Do whatever is necessary to remove the boilerplate you don't need, e.g.
```
rm -rf my_module tests/test_utils.py __rename__.sh
```
Commit your changes and push to your project

Resources

Future ideas and todos

Optional static type hints (PEP 484) with mypy
Make sure tox is working as expected for supported Python versions
Introduce black in favour of other linters
Introduce pyproject.toml along with bleeding edge build tools like flit or poetry

Licensing

This project is licensed under Apache License 2.0.

README.md