RETIRED, Client for OpenStack Congress
Go to file
Corey Bryant b689a98636 add python 3.7 unit test job
This is a mechanically generated patch to add a unit test job running
under Python 3.7.

See ML discussion here [1] for context.

[1] http://lists.openstack.org/pipermail/openstack-dev/2018-October/135626.html

Change-Id: I99b66b38e1a0718d4b0d1fe20c57954049da3f7c
Story: #2004073
Task: #27408
2019-03-02 05:32:24 +00:00
congressclient Update hacking version 2019-01-03 19:38:28 +08:00
doc add releasenotes tox env and commands 2019-03-01 21:12:32 +00:00
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 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
.stestr.conf Switch to stestr 2018-10-04 19:06:28 +05:30
.zuul.yaml add python 3.7 unit test job 2019-03-02 05:32:24 +00:00
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 Update links in README 2018-03-02 18:45:38 +08:00
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 Merge "Add Python 3.6 classifier to setup.cfg" 2018-12-14 01:38:04 +00:00
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 add releasenotes tox env and commands 2019-03-01 21:12:32 +00:00

README.rst

Team and repository tags

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