========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/python-mistralclient.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
Mistral
=======
.. image:: https://img.shields.io/pypi/v/python-mistralclient.svg
:target: https://pypi.org/project/python-mistralclient/
:alt: 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
============
* `PyPi`_ - package installation
* `Launchpad project`_ - release management
* `Blueprints`_ - feature specifications
* `Bugs`_ - issue tracking
* `Source`_
* `Specs`_
* `How to Contribute`_
.. _PyPi: https://pypi.org/project/python-mistralclient
.. _Launchpad project: https://launchpad.net/python-mistralclient
.. _Blueprints: https://blueprints.launchpad.net/python-mistralclient
.. _Bugs: https://bugs.launchpad.net/python-mistralclient
.. _Source: https://opendev.org/openstack/python-mistralclient
.. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html
.. _Specs: https://specs.openstack.org/openstack/mistral-specs/
.. _Release Notes: https://docs.openstack.org/releasenotes/python-mistralclient
Raw data
{
"_id": null,
"home_page": "https://docs.openstack.org/python-mistralclient/latest/",
"name": "python-mistralclient",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/d1/c5/e3f5be0fb37baacdb7d90cac594d359ac8f2151064d6b4b5f155ebd4dc4f/python-mistralclient-5.2.0.tar.gz",
"platform": null,
"description": "========================\nTeam and repository tags\n========================\n\n.. image:: https://governance.openstack.org/tc/badges/python-mistralclient.svg\n :target: https://governance.openstack.org/tc/reference/tags/index.html\n\nMistral\n=======\n\n.. image:: https://img.shields.io/pypi/v/python-mistralclient.svg\n :target: https://pypi.org/project/python-mistralclient/\n :alt: Latest Version\n\nMistral is a workflow service. Most business processes consist of multiple\ndistinct interconnected steps that need to be executed in a particular\norder in a distributed environment. A user can describe such a process as a set\nof tasks and their transitions. After that, it is possible to upload such a\ndescription to Mistral, which will take care of state management, correct\nexecution order, parallelism, synchronization and high availability.\n\nMistral also provides flexible task scheduling so that it can run a process\naccording to a specified schedule (for example, every Sunday at 4.00pm) instead\nof running it immediately. In Mistral terminology such a set of tasks and\nrelations between them is called a workflow.\n\nMistral client\n==============\n\nPython client for Mistral REST API. Includes python library for Mistral API and\nCommand Line Interface (CLI) library.\n\nInstallation\n------------\n\nFirst of all, clone the repo and go to the repo directory::\n\n $ git clone https://opendev.org/openstack/python-mistralclient.git\n $ cd python-mistralclient\n\nThen just run::\n\n $ pip install -e .\n\nor::\n\n $ pip install -r requirements.txt\n $ python setup.py install\n\n\nRunning Mistral client\n----------------------\n\nIf Mistral authentication is enabled, provide the information about OpenStack\nauth to environment variables. Type::\n\n $ export OS_AUTH_URL=http://<Keystone_host>:5000/v2.0\n $ export OS_USERNAME=admin\n $ export OS_TENANT_NAME=tenant\n $ export OS_PASSWORD=secret\n $ export OS_MISTRAL_URL=http://<Mistral host>:8989/v2 (optional, by\n default URL=http://localhost:8989/v2)\n\nand in the case that you are authenticating against keystone over https:\n\n $ export OS_CACERT=<path_to_ca_cert>\n\n.. note:: In client, we can use both Keystone auth versions - v2.0 and v3. But\n server supports only v3.*\n\nTo make sure Mistral client works, type::\n\n $ mistral workbook-list\n\nYou can see the list of available commands typing::\n\n $ mistral --help\n\nUseful Links\n============\n\n* `PyPi`_ - package installation\n* `Launchpad project`_ - release management\n* `Blueprints`_ - feature specifications\n* `Bugs`_ - issue tracking\n* `Source`_\n* `Specs`_\n* `How to Contribute`_\n\n.. _PyPi: https://pypi.org/project/python-mistralclient\n.. _Launchpad project: https://launchpad.net/python-mistralclient\n.. _Blueprints: https://blueprints.launchpad.net/python-mistralclient\n.. _Bugs: https://bugs.launchpad.net/python-mistralclient\n.. _Source: https://opendev.org/openstack/python-mistralclient\n.. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html\n.. _Specs: https://specs.openstack.org/openstack/mistral-specs/\n.. _Release Notes: https://docs.openstack.org/releasenotes/python-mistralclient\n\n\n\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Mistral Client Library",
"version": "5.2.0",
"project_urls": {
"Homepage": "https://docs.openstack.org/python-mistralclient/latest/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "108bfa7625bdc5186106d0c5b4e150d575914276536a8087a683453517a5e3ce",
"md5": "b044f50a1078e417a94ab429ca77304f",
"sha256": "7a32431e77bd743af4a757d055fe7e8f59abd69632021a9f870a1272f2a60088"
},
"downloads": -1,
"filename": "python_mistralclient-5.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b044f50a1078e417a94ab429ca77304f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 143259,
"upload_time": "2024-03-01T14:22:48",
"upload_time_iso_8601": "2024-03-01T14:22:48.864982Z",
"url": "https://files.pythonhosted.org/packages/10/8b/fa7625bdc5186106d0c5b4e150d575914276536a8087a683453517a5e3ce/python_mistralclient-5.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d1c5e3f5be0fb37baacdb7d90cac594d359ac8f2151064d6b4b5f155ebd4dc4f",
"md5": "a0a4def709b46e941f34fcb1c9ea8c57",
"sha256": "fe2b2add1057e6bb9f3efddcfa700d9bf1a9b35d06e194ba4ce0747d693abae1"
},
"downloads": -1,
"filename": "python-mistralclient-5.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a0a4def709b46e941f34fcb1c9ea8c57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 108290,
"upload_time": "2024-03-01T14:22:51",
"upload_time_iso_8601": "2024-03-01T14:22:51.037461Z",
"url": "https://files.pythonhosted.org/packages/d1/c5/e3f5be0fb37baacdb7d90cac594d359ac8f2151064d6b4b5f155ebd4dc4f/python-mistralclient-5.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-01 14:22:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "python-mistralclient"
}