Vitrage API Client library.
Go to file
Andreas Jaeger a034ce54c2 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Set openstackdocs_auto_name to use 'project' as name.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Change-Id: I8de23470cda92374f7b6df89548bbbe23570805f
2020-05-19 08:05:16 +02:00
doc Switch to newer openstackdocstheme and reno versions 2020-05-19 08:05:16 +02:00
releasenotes Switch to newer openstackdocstheme and reno versions 2020-05-19 08:05:16 +02:00
tools Add new api vitrage status 2019-07-01 13:10:03 +03:00
vitrageclient Use unittest.mock instead of third party mock 2020-04-18 11:59:50 -05:00
.coveragerc Update .coveragerc after the removal of openstack directory 2017-11-12 10:19:38 +00:00
.gitignore add .iml to git ignore 2015-12-24 14:28:13 +02:00
.gitreview OpenDev Migration Patch 2019-04-19 19:43:50 +00:00
.mailmap python-vitrageclient project init 2015-11-15 13:29:00 +02:00
.testr.conf python-vitrageclient project init 2015-11-15 13:29:00 +02:00
.zuul.yaml Add Python3 victoria unit tests 2020-04-11 18:49:03 +00:00
CONTRIBUTING.rst Update the bugs link to storyboard 2018-12-31 12:20:13 +00:00
HACKING.rst Update the old doc links 2018-03-21 02:10:47 -07:00
LICENSE python-vitrageclient project init 2015-11-15 13:29:00 +02:00
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-04-30 13:21:45 +08:00
babel.cfg python-vitrageclient project init 2015-11-15 13:29:00 +02:00
lower-constraints.txt Cleanup py27 support 2020-04-04 17:21:22 +02:00
requirements.txt Cleanup py27 support 2020-04-04 17:21:22 +02:00
setup.cfg Add py38 package metadata 2020-04-24 08:23:19 -05:00
setup.py Cleanup py27 support 2020-04-04 17:21:22 +02:00
test-requirements.txt Fix hacking min version to 3.0.1 2020-05-12 21:32:20 -05:00
tox.ini Bump default tox env from py37 to py38 2020-04-24 10:25:59 -05:00

README.rst

Team and repository tags

image

Python bindings to the Vitrage API

This is a client library for Vitrage built to interface with the Vitrage API . It provides a Python API (the vitrageclient module) and a command-line tool (vitrage).

Contents:

Ubuntu Install

At the moment only manual install is available

Manual Install Steps:
  • cd to your python-vitrageclient repo
  • sudo pip install -r requirements.txt
  • python setup.py install

Building and Packaging

Install the tool dependencies

sudo apt-get install python-pip python-virtualenv

In the python-vitrageclient source directory

virtualenv --no-site-packages .venv

source ./.venv/bin/activate

pip install wheel

python setup.py bdist_wheel

pip install $(ls -1rt dist/*.whl | tail -1) --upgrade

References

Detailed documentation for the CLI see CLI Spec