Viofo dashcam utilities

Basti Tee f76015fdf3 Add import statements breaking linter		4 년 전
.github	47af1e67a3 make default	4 년 전
.vscode	d18f77c663 Support for isort	4 년 전
my_module	93d6e361ec Add main executor	4 년 전
tests	f76015fdf3 Add import statements breaking linter	4 년 전
.editorconfig	9cd846f725 Integrate different config files	4 년 전
.gitignore	7b38a1c22f Ignore IntelliJ project config	4 년 전
LICENSE.txt	2085931545 Merge pypi sample project	5 년 전
Makefile	593cabb917 Improve make clean	4 년 전
Pipfile	9cd846f725 Integrate different config files	4 년 전
README.md	abcb99daec Update README.md	4 년 전
__rename__.sh	9a87cb36e1 Improve rename script	4 년 전
setup.cfg	bea9500f04 Add isort reference	4 년 전
setup.py	6bf23c7add Bump version to 0.0.4	4 년 전

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
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 typing for Python 2 and 3 (PEP 484) https://github.com/python/mypy
Reflect current state of Python multi-threading
Make sure tox is working as expected for supported Python versions

Licensing

This project is licensed under Apache License 2.0.

README.md