Temporal Python SDK Project Template

Introduction

A modern, production-ready template for building Temporal applications using Temporal Python SDK. This template provides a solid foundation for developing Workflow-based applications with comprehensive testing, linting, and modern Python tooling.

What's Included

• Complete testing setup (pytest) with async support
• Pre-configured development tooling (e.g. ruff, pre-commit) and CI
• Comprehensive documentation and guides
• AGENTS.md to provide the context and instructions to help AI coding agents work on your project

Getting Started

Prerequisites

• uv
• Temporal CLI

Quick Start

1. Clone and setup the project:

   git clone https://github.com/kawofong/temporal-python-template.git
   cd temporal-python-template
   uv sync --dev

2. Install development hooks:

   uv run poe pre-commit-install

3. Run tests:

   uv run poe test

4. Start Temporal Server:

   temporal server start-dev

5. Run the example workflow (in a separate terminal):

   # Start the worker
   uv run -m src.workflows.http.worker
   
   # In another terminal, execute a workflow
   uv run -m src.workflows.http.http_workflow

Next Steps

• Check out some example prompts to generate Temporal Workflows using your favorite tool.
• After you have built your first Temporal Workflow, read DEVELOPERS.md to learn about development tips & tricks using this template.
• See docs/temporal-patterns.md for advanced Temporal patterns
• Check docs/testing.md for Temporal testing best practices

License

MIT License.