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

Template for creating pytask plugins
https://github.com/pytask-dev/cookiecutter-pytask-plugin

cookiecutter pytask

Last synced: over 1 year ago
JSON representation

Template for creating pytask plugins

• Host: GitHub
• URL: https://github.com/pytask-dev/cookiecutter-pytask-plugin
• Owner: pytask-dev
• License: mit
• Created: 2022-01-13T13:40:24.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-03-17T17:54:41.000Z (over 1 year ago)
• Last Synced: 2025-03-17T18:50:47.397Z (over 1 year ago)
• Topics: cookiecutter, pytask
• Language: Python
• Homepage: https://cookiecutter-pytask-plugin.readthedocs.io/en/latest
• Size: 56.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# cookiecutter-pytask-plugin

[![MIT license](https://img.shields.io/github/license/pytask-dev/cookiecutter-pytask-plugin)](https://github.com/pytask-dev/cookiecutter-pytask-plugin)

[![image](https://readthedocs.org/projects/cookiecutter-pytask-plugin/badge/?version=latest)](https://cookiecutter-pytask-plugin.readthedocs.io/en/latest)

[![image](https://img.shields.io/github/actions/workflow/status/pytask-dev/cookiecutter-pytask-plugin/main.yml?branch=main)](https://github.com/pytask-dev/cookiecutter-pytask-plugin/actions?query=branch%3Amain)

[![image](https://codecov.io/gh/pytask-dev/cookiecutter-pytask-plugin/branch/main/graph/badge.svg)](https://codecov.io/gh/pytask-dev/cookiecutter-pytask-plugin)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pytask-dev/cookiecutter-pytask-plugin/main.svg)](https://results.pre-commit.ci/latest/github/pytask-dev/cookiecutter-pytask-plugin/main)

[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

This repository contains a minimal cookiecutter template for a plugin for

[pytask](https://github.com/pytask-dev/pytask) .

## Usage

First, install cookiecutter.

```console

$ pip install cookiecutter

$ conda install -c conda-forge cookiecutter

```

Then, set up the template for the new plugin with

```console

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

```

## FAQ

Q: Why are the source files nested in `src/<{{ cookiecutter.__package_name }}>`?

A: This is called the src layout. This

[article by Hynek Schlawack](https://hynek.me/articles/testing-packaging/) discusses the

advantages of this layout in detail.