Cookiecutter-python is a template developed by Open Science Labs that creates projects from project templates and is based on Cookiecutter command-line utility . It serves as a boilerplate which can be used by beginners as well as full fledged developers to simplify the project creation process and save considerable amount of time. Cookiecutter enables projects with an initial layout that includes recommended tools, workflows, and project structure.
Cookiecutter also offers other features that can enhance the workflow of the development process.Features such as automatic documentation generation, automated testing, and project-specific configuration are part of this. Overall, Cookiecutter is an efficient tool that gives users the ability to effortlessly create consistent, high-quality projects.
Open Science Labs Scientific Python cookiecutter template is primarily based on the PyOpenSci recommendations who is actively conducting research to determine the tools, libraries, best practices, and workflows utilized by significant scientific Python groups. As a result, this template offers to authors a starting point for their project that adheres with industry standards and can be adjusted to meet particular project requirements
Cookiecutter template for a Python package.
- GitHub repo: https://github.com/osl-incubator/cookiecutter-python/
- Free software: BSD license
- Allows package slug (use
_instead of-) - Licenses supported: MIT, BSD 3 Clause, ISC License, Apache Software License 2.0, and GPL 3
- Documentation engines: mkdocs, sphinx, jupyter-boook
- Test library: pytest
- Auto format code tool: blue, and black
- Initial integration with git
- Support to conda (as base environment) and poetry as packaging and dependency management
- Support to pre-commit
- CI with github actions
- Release workflow with semantic release and github actions
Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):
pip install -U cookiecutteror, using conda/mamba:
mamba create -n cookiecutter cookiecutter
conda activate cookiecutterGo to a desired folder to create your new project, for example:
cd ~/dev/my-python-projectsGenerate a Python package project:
cookiecutter https://github.com/osl-incubator/cookiecutter-python.gitor, using ssh:
cookiecutter git@github.com:osl-incubator/cookiecutter-python.gitFor testing your changes locally, you can run:
make test-template