Files

Luigi Toscano 889cbb5613 Reorganize the documentation following the new structure

- move api as "reference" guide and reword as Python client;
- consolidate shell and cli as part of the "CLI" guide;
- remove the "how_to_participate" page and use part of
  the content from the old index for a minimal "contributor"
  guide which redirect to the sahara contributor guide
  (no need to duplicate the information);
- remove few references to doc/source/api from tox.ini and
  .gitignore (for some reason the directory was cleaned).

Change-Id: Iff049ab32a7695a7a58bd370a1517b1ed7d2f048

2017-09-04 18:43:22 +02:00

804 B

Raw Blame History

Python bindings to the OpenStack Sahara API

This is a client for OpenStack Sahara API. There's a Python API client <reference/index> (the saharaclient module), and a command-line utility <cli/index> (installed as an OpenStackClient plugin). Each implements the entire OpenStack Sahara API.

You'll need credentials for an OpenStack cloud that implements the Data Processing API, in order to use the sahara client.

You may want to read the OpenStack Sahara Docs__ -- the overview, at least -- to get an idea of the concepts. By understanding the concepts this library should make more sense.

__ https://docs.openstack.org/sahara/latest/

Contents:

reference/index cli/index contributor/index

804 B Raw Blame History

Python bindings to the OpenStack Sahara API

804 B

Raw Blame History