astrojuanlu / cookiecutter-pylib

cookiecutter template for pure Python libraries. As simple as possible. No magic.

cookiecutter-pylib

This project is archived, use https://github.com/astrojuanlu/copier-pylib instead

Cookiecutter template for pure Python libraries.

As simple as possible. No magic.

Features

• flit for simple packaging.
• pytest for testing.
• tox for automation of test runners and other stuff.
• Sphinx for documentation
• GitHub Actions for continuous integration and publishing to PyPI.
• Read the Docs for continuous documentation.
• mypy for type checks.
• black for automatic Python code formatting.
• flake8, isort and pydocstyle for style checks.
• pre-commit for optional automation of style checks.

Usage

Install cookiecutter:

pip install cookiecutter

Generate a Python package:

cookiecutter gh:astrojuanlu/cookiecutter-pylib

License

MIT License