openstack
/
python-mistralclient
Code Issues Proposed changes
Python client for Mistral REST API.
737 Commits 9 Branches 27 Tags 8.1 MiB
Python 99.2%
Shell 0.8%
Go to file
Sean McGinnis b43202c893
Bump default tox env from py37 to py38 
Python 3.8 is now our highest level supported python runtime.
This updates the default tox target environments to swap out
py37 for py38 to make sure local development testing is
covering this version.

This does not impact zuul jobs in any way, nor prevent local
tests against py37. It just changes the default if none is
explicitly provided.

Change-Id: I815832f2766531b9c32bd006bbabc2c96cd11b42
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
 		2020-04-24 10:25:55 -05:00
doc Cleanup py27 support 2020-04-04 17:00:08 +02:00
functionaltests/resources/v2 remove unused gate code 2019-09-01 11:27:54 +03:00
mistralclient Use unittest.mock instead of third party mock 2020-04-18 11:58:46 -05:00
releasenotes Update master for stable/ussuri 2020-04-11 18:44:55 +00:00
tools Avoid tox_install.sh for constraints support 2017-12-02 16:58:08 +00:00
.coveragerc Add script for unit test coverage job 2020-01-01 13:01:28 +02:00
.gitignore Switch to using stestr 2018-05-30 17:13:56 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:42:33 +00:00
.stestr.conf Migrate python-mistralclient jobs to Zuul v3 2018-08-01 19:04:32 -04:00
.zuul.yaml Add Python3 victoria unit tests 2020-04-13 11:24:41 +00:00
CONTRIBUTING.rst Update and optimize documentation links 2017-07-21 09:57:38 +08:00
LICENSE Moving Mistral Client code from main Mistral repository 2014-01-17 07:15:03 -08:00
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-04-28 14:04:48 +08:00
functional_creds.conf.sample Fixing launching mistralclient tests 2015-07-11 14:11:10 +03:00
lower-constraints.txt Add script for unit test coverage job 2020-01-01 13:01:28 +02:00
requirements.txt Add missing oslo.serialization requirement 2018-07-09 11:27:20 +01:00
run_functional_tests.sh Add script to run functional CLI and client tests locally 2014-09-30 13:17:58 +04:00
setup.cfg Cleanup py27 support 2020-04-04 17:00:08 +02:00
setup.py Cleanup py27 support 2020-04-04 17:00:08 +02:00
test-requirements.txt Use unittest.mock instead of third party mock 2020-04-18 11:58:46 -05:00
tox.ini Bump default tox env from py37 to py38 2020-04-24 10:25:55 -05:00

README.rst

Team and repository tags

image

Mistral

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.

Installation

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

$ git clone https://opendev.org/openstack/python-mistralclient.git
$ cd python-mistralclient

Then just run:

$ pip install -e .

or:

$ pip install -r requirements.txt
$ python setup.py 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>

Note

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

Useful Links