Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 1.75 KB

README.rst

File metadata and controls

56 lines (34 loc) · 1.75 KB

cookiecutter-pytask

MIT license https://readthedocs.org/projects/cookiecutter-pytask/badge/?version=latest https://img.shields.io/github/workflow/status/pytask-dev/cookiecutter-pytask/main/main pre-commit.ci status

This repository contains a minimal cookiecutter template for a project with pytask .

Usage

First, install cookiecutter.

$ pip install cookiecutter

$ conda install -c conda-forge cookiecutter

Then, set up the template with

$ cookiecutter https://github.com/pytask-dev/cookiecutter-pytask

FAQ

Q: Why are the source files nested in src/<project_slug>?

A: This is called the src layout and the advantages are discussed in this article by Hynek Schlawack.

Although the article discusses the src layout in terms of Python packages, it is also beneficial to structure a project the same way.