RETIRED, OpenStack Search (Searchlight) Client
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
liyingjun bcb1a14e14 Use seperate launchpad project for client 7 years ago
doc Use seperate launchpad project for client 7 years ago
searchlightclient Init searchlightclient base 7 years ago
tools Init searchlightclient base 7 years ago
.gitignore Init searchlightclient base 7 years ago
.gitreview Added .gitreview 7 years ago
.testr.conf Init searchlightclient base 7 years ago
CONTRIBUTING.rst Init searchlightclient base 7 years ago
LICENSE Init searchlightclient base 7 years ago
MANIFEST.in Init searchlightclient base 7 years ago
README.rst Use seperate launchpad project for client 7 years ago
babel.cfg Init searchlightclient base 7 years ago
openstack-common.conf Init searchlightclient base 7 years ago
requirements.txt Init searchlightclient base 7 years ago
setup.cfg Init searchlightclient base 7 years ago
setup.py Init searchlightclient base 7 years ago
test-requirements.txt Init searchlightclient base 7 years ago
tox.ini Init searchlightclient base 7 years ago

README.rst

python-searchlightclient

OpenStack Indexing and Search API Client Library

This is a client library for Searchlight built on the Searchlight API. It provides a Python API (the searchlightclient module) and a command-line tool (searchlight).

The project is hosted on Launchpad, where bugs can be filed. The code is hosted on Github. Patches must be submitted using Gerrit, not Github pull requests.

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

Contents:

Command-line API

Python API

To use with keystone as the authentication system:

>>> from keystoneclient.auth.identity import generic
>>> from keystoneclient import session
>>> from searchlightclient import client
>>> auth = generic.Password(auth_url=OS_AUTH_URL, username=OS_USERNAME, password=OS_PASSWORD, tenant_name=OS_TENANT_NAME)
>>> sc = client.Client('1', session=auth)
>>> sc.resource_types.list()
[...]

Testing

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