Skip to content

Latest commit

 

History

History
18 lines (12 loc) · 1.21 KB

README.md

File metadata and controls

18 lines (12 loc) · 1.21 KB

Cookiecutter Python Project

Cookiecutter template for a Python project.

How to use

Install cookiecutter.

Then run cookiecutter gh:lucasmelin/cookiecutter-pyproject. You'll be prompted for project configuration values, which will be used to generate a new project in the current directory.

What is included

  • Low-dependency Python project structure with many developer tools.
  • 🤖 A nox configuration with commands to publish your documentations to GitHub Pages and lint, format and test your project.
  • 📃 Documentation using Material for MkDocs and MkDocstrings to automatically generate documentation based off of your function docstrings.
  • 🧪 Testing structure using pytest.
  • ✅ Code linting using flake8.
  • 👮 Bandit and Safety to check for vulnerabilities in your code and your dependencies.