python-mistralclient

What it is and what it does

Python-mistralclient is the official Python client for OpenStack Mistral, a workflow orchestration service. It provides both a programmatic library and a command-line interface (CLI) for interacting with Mistral's REST API. Mistral itself manages complex business processes by accepting workflow definitions (sets of tasks and their transitions) and handling state management, execution order, parallelism, synchronization, and high availability. This client lets you upload workflows, manage workbooks, list and monitor executions, and trigger scheduled task runs from Python code or the shell.

The package integrates with OpenStack's authentication stack (keystoneauth1) and uses standard OpenStack libraries for configuration and serialization. It's designed for operators and developers working with OpenStack infrastructure who need to programmatically define, deploy, and monitor multi-step workflows in a distributed environment. The CLI is the primary user-facing interface, though the underlying library can be imported for automation.

Use it for:

• Automate multi-step business processes in OpenStack environments by uploading and managing workflow definitions via Python
• Monitor and list running workflow executions and their status from the command line or scripts
• Schedule recurring tasks (e.g., every Sunday at 4pm) by defining workflows with Mistral's scheduling capabilities
• Integrate workflow orchestration into CI/CD pipelines or infrastructure automation tools
• Query and manage workbooks and task definitions programmatically from custom Python applications

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Python client library and command-line interface for the Mistral workflow service REST API, enabling programmatic and CLI-based interaction with Mistral workflow management.

Yes, if you are working with OpenStack Mistral and need Python integration. The package is actively maintained, has low install friction, carries no licensing restrictions, and is the official client for Mistral's REST API. Install only if you have a Mistral server running and need to interact with it programmatically or via CLI; it is not useful standalone.

Install

python-mistralclient on PyPI

pip install python-mistralclient

uv add python-mistralclient

poetry add python-mistralclient

Installing python-mistralclient

Before you install

Low install friction with a pure-Python wheel distribution. Actively maintained with a recent release (171 days ago). Depends on 10 runtime packages including OpenStack ecosystem libraries (keystoneauth1, oslo.*, osc-lib) and common utilities (requests, PyYAML, cliff); these are standard OpenStack dependencies with established maintenance.

License in practice

Licensed under Apache Software License (permissive). No licensing restrictions on use, modification, or distribution in commercial or private projects.

Quickstart

pip install python-mistralclient

from mistralclient.v2 import client

mistral = client.Client(mistral_url='http://localhost:8989/v2')
workbooks = mistral.workbooks.list()

Requires Python 3.10 or later. Mistral server must be running and accessible at the configured URL; OpenStack authentication credentials (OS_AUTH_URL, OS_USERNAME, OS_PASSWORD, OS_TENANT_NAME) are required if Mistral authentication is enabled.

Verify before relying

• Whether the package works with Mistral server versions other than v2 API
• Performance characteristics when managing large numbers of workflows or tasks
• Compatibility with non-OpenStack Mistral deployments

Package facts

Evidence: python_mistralclient-6.2.0-py3-none-any.whl

Tags

More Distributed Computing packages