A boilerplate project to use when bootstrapping new Python 3 projects.
Copy the source code (no need to fork it), edit all occurrences of project_name, tweak the
setup.py file to suit your needs and start doing things.
- Test automation and environment provisioning using Tox
- Static code analysis using Flake8 with useful plugins and sane defaults
- Static type checking using Mypy
- Unit testing using pytest
- Enforced code coverage threshold using coverage
- Dependencies pinned to the major version, allowing for backwards-compatible updates when upstream projects respect Semantic Versioning
- Costless continuous integration for Open-Source projects using Travis-CI
- Costless code coverage reports for Open-Source projects using Coveralls
- Project dependencies are checked for security vulnerabilities using Safety
- Licensed under CC0 Public Domain Dedication, you can copy/paste anything and not worry about a thing, not even giving original authors attribution.
Remember only to follow those instructions after editing the source code to bootstrap your new project.
Set up your virtualenv, then install the package in development mode, including the extra development and testing dependencies:
pip install -e '.[dev,test]'
From your virtualenv, you may start the full test suite using the following command:
tox
You also may only run a subset of the test suite by overriding the default tox environments to create and execute:
tox -e py36,coverage
Here is a listing of supported tox environments that complement the default ones:
coverage: Merges all default test environments-issues coverage files and generates both a CLI and XML report. Fails if coverage is under 100%safety: Runs the Safety checker against all project dependencies. Fails if any security vulnerability is found.
Written in 2018 by Mickaël 'lastmikoi' FALCK <[email protected]>
To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.