/cookiecutter-lux-python

Cookiecutter Python project template for the ages

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

cookiecutter-lux-python

Cookiecutter template for a Python package.

The boilerplate Python project that aims to create facility for maintaining of the package easily. It considering tools for building, testing and distribution.

Get Started

This template provides a basic structure for an idiomatic Python package with a convenient Makefile-facility and additional helpers.

Template can be configured using Cookiecutter's CLI or by altering parameters directly in cookiecutter.json.

Features

  • Auto creation of virtual environment: make venv.
  • Building and packaging: make dist, make sdist, make install, make uninstall.
  • Testing: make test.
  • Render project's documentation using Sphinx: make html, make pdf.
  • Managing Vagrant virtual machines: make up, make ssh, make halt, make destroy.
  • GNU-style cleaners: make clean, make distclean, make mostlyclean.