python-tackerclient/README.rst
Sean McGinnis c6f918cc51 Fix errors in README
Pypi now enforces some package checks and will reject uploads if errors
are found, causing problems with new releases. Most projects by default
set their README as the source for the package description, so any RST
formatting errors in the README can be the source of these validation
failures.

The README file for python-tackerclient would fail validation since it
would appear the numbered bullet list was not formatted correcting,
making the second bullet not appear to be part of the same list and
getting the validation error:

warning: check: Enumerated list start value not ordinal-1: "2" (ordinal 2)

To make this section of the README consistent with the following
section, the numbered bullets are just removed, getting rid of the
validation errors.

Change-Id: I653f98b0b5b5c223cb15bfb2b2fe5400c61a1714
2018-07-23 07:51:44 -05:00

70 lines
1.6 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/python-tackerclient.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
NFV Orchestration (Tacker) Client
=================================
CLI and Client Library for OpenStack Tacker
Installation
============
**Note:** The paths we are using for configuration files in these steps
are with reference to Ubuntu Operating System. The paths may vary for
other Operating Systems.
The branch_name which is used in commands, specify the branch_name
as stable/<branch> for any stable branch installation. For eg:
stable/queens, stable/pike. If unspecified the default will be
master branch.
Using python install
--------------------
Clone python-tackerclient repository.
::
$ cd ~/
$ git clone https://github.com/openstack/python-tackerclient -b <branch_name>
Install python-tackerclient.
::
$ cd python-tackerclient
$ sudo python setup.py install
Using pip
---------
You can also install the latest version by using ``pip`` command:
::
$ pip install python-tackerclient
Or, if it is needed to install ``python-tackerclient`` from master branch,
type
::
$ pip install git+https://github.com/openstack/python-tackerclient.git
More Information
================
* Python-tackerclient documentation: https://docs.openstack.org/python-tackerclient/
* Tacker Documentation: https://docs.openstack.org/tacker/
* Tacker Wiki: https://wiki.openstack.org/wiki/Tacker
* Release Notes: https://docs.openstack.org/releasenotes/python-tackerclient