Home

An awesome template for python projects using cutting edge tools

Documentation: nullhack.github.io/pyproj

PyProj¶

This project is made to be clean, simple to use and make the simplest Hello World ready for production. To achieve this, I stand on the shoulder of giants using, modifying and creating code from multiple sources and projects, into a cookiecutter project ready to be used.

Quick start¶

cookiecutter gh:nullhack/pyproj

Running¶

nullhack.github.io/pyproj/usage/running/

Testing¶

nullhack.github.io/pyproj/usage/testing/

Features¶

Behave: Behavior driven development (BDD)
Black: Code formatter
Cookiecutter: Create a project from a project template
Coverage: Measure, collect, and report on code coverage
Darglint: Check docstring validity
Flake8: Runs all the tools by launching the single command
Isort: Sort Python import definitions
Material mkdocs: Technical documentation using material design
Nox: Automation toolkit
Poetry: Dependency management and packaging
Pre-commit: Manage and maintain pre-commit hooks
Safety: Checks installed dependencies for known security vulnerabilities
Xdoctest: Discover and run doctests within a python package