Temporal Python SDK Samples

This is a collection of samples showing how to use the Python SDK.

Usage

Prerequisites:

• uv
• Temporal CLI installed
• Local Temporal server running

The SDK requires Python >= 3.9. You can install Python using uv. For example,

uv python install 3.13

With this repository cloned, run the following at the root of the directory:

uv sync

That loads all required dependencies. Then to run a sample, usually you just run it under uv. For example:

uv run hello/hello_activity.py

Some examples require extra dependencies. See each sample's directory for specific instructions.

Samples

• hello - All of the basic features. <!-- Keep this list in alphabetical order and in sync on hello/README.md and root README.md -->
  • hello_activity - Execute an activity from a workflow.
  • helloactivitychoice - Execute certain activities inside a workflow based on dynamic input.
  • helloactivitymethod - Demonstrate an activity that is an instance method on a class and can access class state.
  • helloactivitymultiprocess - Execute a synchronous activity on a process pool.
  • helloactivityretry - Demonstrate activity retry by failing until a certain number of attempts.
  • helloactivitythreaded - Execute a synchronous activity on a thread pool.
  • helloasyncactivity_completion - Complete an activity outside of the function that was called.
  • hello_cancellation - Manually react to cancellation inside workflows and activities.
  • hellochildworkflow - Execute a child workflow from a workflow.
  • hellocontinueas_new - Use continue as new to restart a workflow.
  • hello_cron - Execute a workflow once a minute.
  • hello_exception - Execute an activity that raises an error out of the workflow and out of the program.
  • hellolocalactivity - Execute a local activity from a workflow.
  • hello_mtls - Accept URL, namespace, and certificate info as CLI args and use mTLS for connecting to server.
  • helloparallelactivity - Execute multiple activities at once.
  • hello_query - Invoke queries on a workflow.
  • hellosearchattributes - Start workflow with search attributes then change while running.
  • hello_signal - Send signals to a workflow. <!-- Keep this list in alphabetical order -->
• activity_worker - Use Python activities from a workflow in another language.
• bedrock - Orchestrate a chatbot with Amazon Bedrock.
• cloudexportto_parquet - Set up schedule workflow to process exported files on an hourly basis
• context_propagation - Context propagation through workflows/activities via interceptor.
• custom_converter - Use a custom payload converter to handle custom types.
• custom_decorator - Custom decorator to auto-heartbeat a long-running activity.
• custom_metric - Custom metric to record the workflow type in the activity schedule to start latency.
• dsl - DSL workflow that executes steps defined in a YAML file.
• encryption - Apply end-to-end encryption for all input/output.
• gevent_async - Combine gevent and Temporal.
• langchain - Orchestrate workflows for LangChain.
• message_passing/introduction - Introduction to queries, signals, and updates.
• messagepassing/safemessage_handlers - Safely handling updates and signals.
• messagepassing/updatewithstart/lazyinitialization - Use update-with-start to update a Shopping Cart, starting it if it does not exist.
• open_telemetry - Trace workflows with OpenTelemetry.
• patching - Alter workflows safely with patch and deprecate_patch.
• polling - Recommended implementation of an activity that needs to periodically poll an external resource waiting its successful completion.
• prometheus - Configure Prometheus metrics on clients/workers.
• pydantic_converter - Data converter for using Pydantic models.
• schedules - Demonstrates a Workflow Execution that occurs according to a schedule.
• sentry - Report errors to Sentry.
• trio_async - Use asyncio Temporal in Trio-based environments.
• updatable_timer - A timer that can be updated while sleeping.
• workerspecifictask_queues - Use unique task queues to ensure activities run on specific workers.
• worker_versioning - Use the Worker Versioning feature to more easily version your workflows & other code.

Test

Running the tests requires poe to be installed.

uv tool install poethepoet

Once you have poe installed you can run:

poe test