write-script-python3

Python scripts for Windmill require a standard main function with typed parameters, frontmatter metadata (name and description), and Windmill SDK imports. Use TypedDict for resource schemas and follow Windmill conventions for S3 helpers and preprocessor hooks to integrate scripts into flows and jobs.

A Windmill Python script must define a main function with explicit parameter types, include frontmatter with script name and description, import from the Windmill SDK, and use typing.TypedDict to define resource types. Deploy using wmill script generate-metadata and wmill sync push.

Yes. Windmill Python scripts use TypedDict to define typed resource schemas, enabling reliable data workflows and API integrations. This enforces consistency across scripts and ensures resources pass correctly between flow steps.

The Windmill SDK is required to follow Windmill conventions for Python scripts, including access to resource handling, S3 helpers, and preprocessor hooks. It enables scripts to integrate seamlessly into Windmill flows and jobs.

After writing your Python script with a main function and frontmatter, run wmill script generate-metadata to create metadata, then wmill sync push to deploy the script to your Windmill instance.

Common patterns include reading config resources, calling external APIs, returning structured results, and using S3 helpers for data operations. TypedDict typing and explicit main function signatures support reliable, reusable automation across flows.