Python client for Mistral REST API.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
wu.shiming 152fc795fa requirements: Drop os-testr 2 months ago
doc Switch to newer openstackdocstheme and reno versions 6 months ago
functionaltests/resources/v2 remove unused gate code 1 year ago
mistralclient Merge "Remove all usage of six library" 6 months ago
releasenotes Update master for stable/victoria 2 months ago
tools Avoid for constraints support 3 years ago
.coveragerc Add script for unit test coverage job 10 months ago
.gitignore Switch to using stestr 2 years ago
.gitreview OpenDev Migration Patch 1 year ago
.stestr.conf Migrate python-mistralclient jobs to Zuul v3 2 years ago
.zuul.yaml Add Python3 wallaby unit tests 2 months ago
CONTRIBUTING.rst Update and optimize documentation links 3 years ago
LICENSE Moving Mistral Client code from main Mistral repository 6 years ago
README.rst Replace URLs with URLs 1 year ago
functional_creds.conf.sample Fixing launching mistralclient tests 5 years ago
lower-constraints.txt requirements: Drop os-testr 2 months ago
requirements.txt [goal] Migrate testing to ubuntu focal 2 months ago Add script to run functional CLI and client tests locally 6 years ago
setup.cfg Add py38 package metadata 7 months ago Cleanup py27 support 7 months ago
test-requirements.txt Fix hacking min version to 3.0.1 6 months ago
tox.ini Remove install unnecessary packages 2 months ago


Team and repository tags



Latest Version

Mistral is a workflow service. Most business processes consist of multiple distinct interconnected steps that need to be executed in a particular order in a distributed environment. A user can describe such a process as a set of tasks and their transitions. After that, it is possible to upload such a description to Mistral, which will take care of state management, correct execution order, parallelism, synchronization and high availability.

Mistral also provides flexible task scheduling so that it can run a process according to a specified schedule (for example, every Sunday at 4.00pm) instead of running it immediately. In Mistral terminology such a set of tasks and relations between them is called a workflow.

Mistral client

Python client for Mistral REST API. Includes python library for Mistral API and Command Line Interface (CLI) library.


First of all, clone the repo and go to the repo directory:

$ git clone
$ cd python-mistralclient

Then just run:

$ pip install -e .


$ pip install -r requirements.txt
$ python install

Running Mistral client

If Mistral authentication is enabled, provide the information about OpenStack auth to environment variables. Type:

$ export OS_AUTH_URL=http://<Keystone_host>:5000/v2.0
$ export OS_USERNAME=admin
$ export OS_TENANT_NAME=tenant
$ export OS_PASSWORD=secret
$ export OS_MISTRAL_URL=http://<Mistral host>:8989/v2  (optional, by
  default URL=http://localhost:8989/v2)

and in the case that you are authenticating against keystone over https:

$ export OS_CACERT=<path_to_ca_cert>


In client, we can use both Keystone auth versions - v2.0 and v3. But server supports only v3.*

To make sure Mistral client works, type:

$ mistral workbook-list

You can see the list of available commands typing:

$ mistral --help