python-cookiecutter

A tool to automatically create a Python project structure ready to release via GitHub and PyPI.

python-cookiecutter automatically creates a structured project and sets up essential tools, including:

• A blank README.md file for documentation.
• A LICENSE file to define usage rights.
• Pre-commit hooks to maintain code quality.
• Automatic versioning with setuptools_scm.
• A test setup using pytest.
• Automated formatting, testing, and publishing via GitHub Actions.
• A documentation setup with Sphinx.

Quick Install

First, install cookiecutter in your desired environment. Running in the terminal in your environment, with Pip:

pip install cookiecutter

# or conda:

conda install -c conda-forge cookiecutter

Creating a cookiecutter project

In the folder, you want to create the repo run:

cookiecutter https://github.com/neuroinformatics-unit/python-cookiecutter

You will be then asked a series of questions about how you want to set up your project.

View Full Documentation →

Contributing

We welcome contributions! See our Contribution Guidelines for workflow details.

License

⚖️ BSD 3-Clause