RETIRED, Client for OpenStack Congress
Go to file
Flavio Percoco 129c7915a1 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/99cdb23eb3f1e889f3bd084ef2cf1a18\n'

Change-Id: I9c0c6e5165257ecf3f76522cd6a6d6555add0ed2
2016-11-25 14:00:08 +01:00
congressclient no longer use oslo-incubator code 2016-11-11 00:47:23 -05:00
doc/source create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
releasenotes/notes Add release notes 2016-09-01 09:13:48 -07:00
.coveragerc no longer use oslo-incubator code 2016-11-11 00:47:23 -05: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 Show team and repo badges on README 2016-11-25 14:00:08 +01:00
babel.cfg create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
requirements.txt Updated from global requirements 2016-11-16 22:15:51 +00:00
setup.cfg Support push rows to datasources 2016-08-30 14:26:31 +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-10-22 01:26:39 +00:00
tox.ini no longer use oslo-incubator code 2016-11-11 00:47:23 -05:00

README.rst

Team and repository tags

image

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