prefect-collection-template

Welcome!

prefect-collection-template is a cookiecutter template for quickly bootstrapping a Prefect Collection.

When you bootstrap a Prefect Collection with prefect-collection-template you'll automatically be set up with the tools necessary to build and maintain your collection:

• mkdocs for automatic documentation generation
• black, isort, and flake8 for automatic code formatting and linting
• pytest for unit testing
• interrogate for documentation coverage analysis
• Coverage.py for code coverage analysis
• pre-commit to automatically run code formatting and linting prior to git commit
• versioneer for automatic package versioning
• GitHub Actions workflows for continuous integration and deployment of your collection and its documentation

We're excited to see what you build!

Quickstart

Install cruft if you have not already:

pip install cruft

Generate a Prefect Collection project:

cruft create https://github.com/PrefectHQ/prefect-collection-template

Refer to the MAINTAINERS.md in the generated project for how to get started developing Prefect tasks and flow.

Contributing

To start contributing to prefect-collection-template, run:

pip install -r requirements-dev.txt

To test generation of a Prefect Collection with your changes, run:

cruft create .

To run tests, from the base directory of the repository, run:

pytest tests