Bessa Group Cookiecutter Python repository template

| GitHub |

First publication: July 31, 2025

---

Summary

This repository serves as a cookiecutter template for Python code. Cookiecutter is a command-line utility that creates projects from project templates, e.g., Python packages. It is a great way to quickly set up a new Python package with a standard structure and best practices, and it replaces the need to manually create the boilerplate code for a new Python package.

Upon running the template, it will prompt you for some information about your new package, such as the package name, author name, and email address. After you provide this information, Cookiecutter will generate a new directory with the structure of a Python package.

The template is compliant to the Bessa Research Group Python Development Code of Conduct. This template is adopted from the cookiecutter-pypackage template by Audrey M. Roy Greenfeld.

Statement of need

Members of the Bessa Research Group can use this cookiecutter template to create new Python repositories. The template is compliant to the Bessa Research Group Python Development Code of Conduct.

Authorship

Authors:

• Martin van der Schelling (M.P.vanderSchelling@tudelft.nl)

Authors afilliation:

• Bessa Research Group @ Delft University of Technology

Maintainer:

• Martin van der Schelling (M.P.vanderSchelling@tudelft.nl)

Maintainer afilliation:

• Bessa Research Group @ Delft University of Technology

Getting started

Install Cookiecutter in your Python environment:

pip install cookiecutter

Navigate to the directory where you want to create your new Python package project, and run the following command:

cookiecutter https://github.com/bessagroup/cookiecutter-bessapypackage.git

You will be prompted to enter some information about your new package, such as the package name, author name, and email address. After you provide this information, Cookiecutter will generate a new directory with the structure of a Python package.

Community Support

If you find any issues, bugs or problems with this template, please use the GitHub issue tracker to report them.

License

Copyright 2025, Martin van der Schelling

All rights reserved.

This project is licensed under the BSD 3-Clause License. See LICENSE for the full license text.