Enhanced, asyncio-compatible client for AWS Step Functions.
Project description
sfn_workflow_client
Enhanced, asyncio-compatible client for AWS Step Functions.
Features:
- Trigger new executions
- Query for state machine execution status
- Wait for an execution to complete
- Fetch execution history
Table of Contents:
Installation
sfn_workflow_client requires Python 3.6 or above.
pip install sfn_workflow_client
Guide
from sfn_workflow_client.enums import ExecutionStatus
from sfn_workflow_client.workflow import Workflow
# Initialize a workflow client
workflow = Workflow("my-state-machine")
# Fetch all executions
collection = await workflow.executions.fetch()
# Fetch currently running executions
collection = await workflow.executions.fetch(status=ExecutionStatus.running)
# Start a new execution
execution = await workflow.executions.create().start()
# Start a new execution and wait until it completes (useful for tests)
execution = await workflow.executions.start_sync()
# Find an execution by trace ID (for tests)
execution = await workflow.executions.fetch().find_by_trace_id("abc")
# Fetch the event history of an execution
events = await execution.events.fetch()
Development
To develop sfn_workflow_client, install dependencies and enable the pre-commit hook:
pip install pre-commit tox
pre-commit install
To run functional tests, you need to create an AWS IAM role with permissions to:
- Create/update/delete state machines
- Start/stop executions
Set the following environment variables:
AWS_ACCOUNT_ID
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_DEFAULT_REGION
AWS_IAM_ROLE_ARN
To run tests:
tox
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sfn_workflow_client-0.4.4.tar.gz
(11.6 kB
view hashes)
Built Distribution
Close
Hashes for sfn_workflow_client-0.4.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 652930781f6dda8f496f6e574355ff2f58ae52157465871a562adc654f2e01d2 |
|
MD5 | 87cca64619702f7029235276f5375d9f |
|
BLAKE2b-256 | 36e037a3ceaa5ff2bf2c89efaa843eb4a45402ac00e812e409e5b0048bb355f7 |
Close
Hashes for sfn_workflow_client-0.4.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64373948f61204b47797c96205979bbed3a515ab4361c277ea087be62c5afe4f |
|
MD5 | cbe119edcb9ab2590ec9065462c0d08a |
|
BLAKE2b-256 | d90485a5545d024e253565d7c1f956c56324fb2af4ee4a37e64498d248541050 |