python-vitrageclient/README.rst
M V P Nitesh 4a3c5d9791 Optimize the link address
Use https instead of http to ensure the safety

Change-Id: I9591192bce3e088f89dbd968952218135031084c
2017-04-10 16:10:50 +05:30

67 lines
1.8 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/badges/python-vitrageclient.svg
:target: https://governance.openstack.org/reference/tags/index.html
:remote:
.. Change things from this point on
..
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
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:: Contents:
:local:
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 <https://github.com/openstack/python-vitrageclient/blob/master/doc/source/cli.rst/>`_