/cookiecutter-pathway

Cookiecutter Pathway is a framework for jumpstarting production-ready Pathway projects quickly.

Primary LanguagePythonMIT LicenseMIT



Contributors Linux macOS
chat on Discord follow on Twitter

Cookiecutter Pathway

Powered by Cookiecutter, Cookiecutter Pathway is a framework for jumpstarting production-ready Pathway projects quickly.

Features

  • Works with Python 3.11
  • Generates runnable Python project both in batch and streaming mode
  • 12-Factor based settings via pydantic and python-dotenv
  • Optimized development and production settings
  • Comes with sample application ready to go
  • Choose between kafka and redpanda for production
  • Docker support using docker-compose for development and production
  • Run tests with pytest

Usage

First, get Cookiecutter.

$ pip install "cookiecutter>=1.7.0"

Now run it against this repo:

$ cookiecutter https://github.com/pathwaycom/cookiecutter-pathway

You'll be prompted for some values. Provide them, then a Pathway project will be created for you. Enter the generated directory, read the README.md and start developing!