python-searchlightclient 2.1.1

从PyPI安装客户端

程序python-searchlightclient软件包发布在PyPI上，因此可以使用pip工具安装，这将管理安装所有Python依赖项。

$ pip install python-searchlightclient

从源设置客户端

• 克隆python-searchlightclient仓库

  $ git clone https://opendev.org/openstack/python-searchlightclient.git
  $ cd python-searchlightclient

• 设置虚拟环境

$ tox -evenv --notest

在您想要在其中工作的任何时候激活虚拟环境。本节中所有后续命令都应在venv激活状态下运行

$ source .tox/venv/bin/activate

• 安装Searchlightclient及其依赖项

  (venv) $ python setup.py develop

命令行API

设置Keystone环境变量以执行针对searchlight的CLI命令。

• 要执行CLI命令

  $ export OS_USERNAME=<user>
  $ export OS_PASSWORD=<password>
  $ export OS_TENANT_NAME=<project>
  $ export OS_AUTH_URL='http://localhost:5000/v2.0/'

$ openstack
(openstack) search resource type list
+--------------------------+--------------------------+
| Name                     | Type                     |
+--------------------------+--------------------------+
| OS::Designate::RecordSet | OS::Designate::RecordSet |
| OS::Designate::Zone      | OS::Designate::Zone      |
| OS::Glance::Image        | OS::Glance::Image        |
| OS::Glance::Metadef      | OS::Glance::Metadef      |
| OS::Nova::Server         | OS::Nova::Server         |
+--------------------------+--------------------------+

以下是完整的子命令列表，使用-h查看选项

子命令	描述
search facet list	列出Searchlight Facet
search resource type list	列出Searchlight资源类型（插件）
search query	搜索Searchlight资源

Python API

用于与keystone作为认证系统一起使用

>>> 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)
>>> keystone_session = session.Session(auth=auth)
>>> sc = client.Client('1', session=keystone_session)
>>> sc.resource_types.list()
[...]

• 许可证：Apache License，版本2.0

• 文档：https://docs.openstack.org/developer/python-searchlightclient

• 源：https://opendev.org/openstack/python-searchlightclient

• 错误：https://storyboard.openstack.org/#!/project_group/searchlight

测试

可以运行多个测试目标来验证代码。

• tox -e pep8 - 遵守风格指南

• tox -e py36 - 使用Python 3.6进行传统单元测试

• tox -e py37 - 使用Python 3.7进行传统单元测试