igor-toga / knobclient Goto Github PK

OpenStack Indexing and Search API Client Library

This is a client library for Knob built. It provides a Python API (the knobclient module)

python-knobclient is licensed under the Apache License like the rest of OpenStack.

The :program:`python-knobclient` package is published on PyPI and so can be installed using the pip tool, which will manage installing all python dependencies:

$ pip install python-knobclient

• Clone repository for python-knobclient:

  $ git clone https://github.com/openstack/python-knobclient.git
  $ cd python-knobclient
  

• Setup a virtualenv

$ tox -evenv --notest

Activate the virtual environment whenever you want to work in it. All further commands in this section should be run with the venv active:

$ source .tox/venv/bin/activate

• Install knobclient and its dependencies:

  (venv) $ python setup.py develop
  

There are multiple test targets that can be run to validate the code.

• tox -e pep8 - style guidelines enforcement
• tox -e py27 - traditional unit testing