RETIRED, Client for OpenStack Congress
Go to file
aimee.ukasick 77e875680c Add missing makefile so HTML docs can be generated
Also added instructions for generating the docs
to README.rst

Closes-bug: #1605678
Change-Id: I681a706e209308d29e1c04044ba7df702a8aea60
2016-07-22 11:59:15 -05:00
congressclient Remove white space between print and () 2016-07-05 16:23:30 +08:00
doc/source create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:44:25 +00:00
.gitignore Fixup gitignore 2014-09-03 08:19:14 -07:00
.gitreview Update .gitreview file to reflect repo rename 2015-04-18 00:37:36 +00:00
.mailmap create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
.testr.conf create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:46 +00:00
HACKING.rst create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07: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 Add missing makefile so HTML docs can be generated 2016-07-22 11:59:15 -05:00
babel.cfg create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
openstack-common.conf create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
requirements.txt Updated from global requirements 2016-07-09 19:26:26 +00:00
setup.cfg Drop py26 and py33 support 2015-12-15 19:14:22 +09:00
setup.py Updated from global requirements 2015-12-15 18:16:44 +00:00
tenant-list.log Initial congressclient 2014-09-10 15:11:09 -07:00
test-requirements.txt Updated from global requirements 2016-06-21 18:04:59 +00:00
tox.ini tox: rm all pyc before doing unit test 2015-12-07 13:47:56 +05:30

README.rst

python-congressclient

Client for Congress

Client for Standalone Congress

To execute CLI commands to standalone congress set with noauth:

  • Install python-openstackclient:

    $ pip install python-openstackclient
  • Clone repository & install python-congressclient:

    $ git clone 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