openstack
/
python-congressclient
Code Issues Proposed changes
RETIRED, Client for OpenStack Congress
281 Commits 1 Branch 44 Tags 2.2 MiB
Go to file
whoami-rajat c0e9f0308e Generate PDF documentation 
This commit adds a new tox target to build PDF documentation.
It's a part of community goal, see storyboard for more
information.

Change-Id: I58b1fb537c3758bba5a57d3cf7ce4cf10625bd89
Story: 2006076
Task: 34817
 		2019-09-17 13:23:24 +05:30
congressclient Update hacking version 2019-01-03 19:38:28 +08:00
doc Generate PDF documentation 2019-09-17 13:23:24 +05:30
releasenotes add releasenotes tox env and commands 2019-03-01 21:12:32 +00:00
.coveragerc no longer use oslo-incubator code 2016-11-11 00:47:23 -05:00
.gitignore Switch to stestr 2018-10-04 19:06:28 +05:30
.gitreview OpenDev Migration Patch 2019-04-19 19:40:48 +00:00
.mailmap create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
.stestr.conf Switch to stestr 2018-10-04 19:06:28 +05:30
.zuul.yaml Switch python3 versions of test jobs to match Train PTI 2019-05-21 11:33:40 +05:30
CONTRIBUTING.rst Update the documentation link for doc migration 2017-07-24 10:23:01 +08:00
HACKING.rst Update the documentation link for doc migration 2017-07-24 10:23:01 +08:00
LICENSE create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
Makefile Add missing makefile so HTML docs can be generated 2016-07-22 11:59:15 -05:00
NEWS Add api bindings for datasource request-request trigger 2015-03-31 15:33:53 -07:00
README.rst Generate PDF documentation 2019-09-17 13:23:24 +05:30
babel.cfg create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
lower-constraints.txt Switch to stestr 2018-10-04 19:06:28 +05:30
requirements.txt Updated from global requirements 2018-02-17 10:11:03 +00:00
setup.cfg Switch python3 versions of test jobs to match Train PTI 2019-05-21 11:33:40 +05:30
setup.py Updated from global requirements 2017-03-10 03:38:00 +00:00
tenant-list.log Initial congressclient 2014-09-10 15:11:09 -07:00
test-requirements.txt Update hacking version 2019-01-03 19:38:28 +08:00
tox.ini Generate PDF documentation 2019-09-17 13:23:24 +05:30

README.rst

Team and repository tags

html

image

latex

image

python-congressclient

Client for Congress

Client for Standalone Congress

Install the Congress CLI by cloning the repository and running the setup file. The master repository always contains the latest source code, so if you are installing and testing a specific branch of Congress, clone the matching branch of the python-congressclient.

To execute CLI commands to standalone Congress installed with noauth:

  • Install python-openstackclient:

    $ pip install python-openstackclient

  • Clone master repository & install python-congressclient:

    $ git clone https://github.com/openstack/python-congressclient.git
$ cd python-congressclient
$ python setup.py install

  • (Optional) Clone a branch; for example, if you are using the Ocata version of OpenStack and Congress:

    $ git clone -b stable/ocata https://github.com/openstack/python-congressclient.git
$ cd python-congressclient
$ python setup.py install

  • Read the HTML documentation. Install python-sphinx and the oslosphinx extension if missing:

    $ sudo pip install sphinx
$ sudo pip install oslosphinx

    Build the docs $ make docs

    Open doc/html/index.html in a browser

  • To execute CLI commands:

    $ cd python-congressclient

For example:
$ export CONGRESS_URL="http://127.0.0.1:1789"
$ openstack --os-token foo --os-url $CONGRESS_URL
(openstack) congress policy create test_policy
+--------------+--------------------------------------+
| Field        | Value                                |
+--------------+--------------------------------------+
| abbreviation | test_                                |
| description  |                                      |
| id           | 8595f24a-7d74-45ee-8168-0b3e937b8419 |
| kind         | nonrecursive                         |
| name         | test_policy                          |
| owner_id     | user                                 |
+--------------+--------------------------------------+

(openstack) congress policy rule create test_policy "p(5)"
+---------+--------------------------------------+
| Field   | Value                                |
+---------+--------------------------------------+
| comment | None                                 |
| id      | 5ce7fb18-a227-447e-bec8-93e99c0052a5 |
| name    | None                                 |
| rule    | p(5)                                 |
+---------+--------------------------------------+

(openstack) congress policy rule list test_policy
// ID: 5ce7fb18-a227-447e-bec8-93e99c0052a5
// Name: None
p(5)

(openstack) exit
$

Features

  • TODO