openstack/osc-lib
Code Issues Proposed changes

Rename to osc-lib

Browse Source 
* add fresh README and doc tree
* remove references to OSC and commands
This commit is contained in:
Dean Troyer 2016-05-10 07:46:39 -05:00
parent 8818f4cf69
commit f78173f0e1
7 changed files with 234 additions and 517 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.coveragerc
View File

@ -1,7 +1,6 @@
[run]
branch = True
source = openstackclient
omit = openstackclient/openstack/*
source = osc_lib
[report]
ignore_errors = True

2
.gitreview
View File

@ -1,4 +1,4 @@
[gerrit]
host=review.openstack.org
port=29418
project=openstack/python-openstackclient.git
project=openstack/osc-lib.git

41
README.rst Normal file
View File

@ -0,0 +1,41 @@
=======
osc-lib
=======
.. image:: https://img.shields.io/pypi/v/osc-lib.svg
:target: https://pypi.python.org/pypi/osc-lib/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/dm/osc-lib.svg
:target: https://pypi.python.org/pypi/osc-lib/
:alt: Downloads
OpenStackClient (aka OSC) is a command-line client for OpenStack. osc-lib
is a package of common support modules for writing OSC plugins.
* `PyPi`_ - package installation
* `Online Documentation`_
* `Launchpad project`_ - part of OpenStackClient
* `Bugs`_ - issue tracking
* `Source`_
* `Developer` - getting started as a developer
* `Contributing` - contributing code
* `Testing` - testing code
* IRC: #openstack-sdks on Freenode (irc.freenode.net)
* License: Apache 2.0
.. _PyPi: https://pypi.python.org/pypi/osc-lib
.. _Online Documentation: http://docs.openstack.org/developer/osc-lib/
.. _Launchpad project: https://launchpad.net/python-openstackclient
.. _Bugs: https://bugs.launchpad.net/python-openstackclient
.. _Source: https://git.openstack.org/cgit/openstack/osc-lib
.. _Developer: http://docs.openstack.org/project-team-guide/project-setup/python.html
.. _Contributing: http://docs.openstack.org/infra/manual/developers.html
.. _Testing: http://docs.openstack.org/developer/osc-lib/developing.html#testing
Getting Started
===============
osc-lib can be installed from PyPI using pip::
pip install osc-lib

136
doc/Makefile Normal file
View File

@ -0,0 +1,136 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html pdf dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " pdf to make pdf with rst2pdf"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
pdf:
$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
@echo
@echo "Build finished. The PDFs are in $(BUILDDIR)/pdf."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NebulaDocs.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NebulaDocs.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/NebulaDocs"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NebulaDocs"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
make -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

49
doc/source/index.rst Normal file
View File

@ -0,0 +1,49 @@
=========================================
osc-lib -- OpenStackClient Plugin Library
=========================================
OpenStackClient (aka OSC) is a command-line client for OpenStack. osc-lib
is a package of common support modules for writing OSC plugins.
Contents:
.. toctree::
:maxdepth: 2
introduction
demoapp
list_commands
show_commands
complete
interactive_mode
classes
install
developers
history
Contributing
============
osc-lib utilizes all of the usual OpenStack processes and requirements for
contributions. The code is hosted `on OpenStack's Git server`_. `Bug reports`_
and `blueprints`_ may be submitted to the :code:`python-openstackclient` project
on `Launchpad`_. Code may be submitted to the
:code:`openstack/osc-lib` project using `Gerrit`_.
Developers may also be found in the `IRC channel`_ ``#openstack-sdks``.
.. _`on OpenStack's Git server`: https://git.openstack.org/cgit/openstack/python-openstackclient/tree
.. _Launchpad: https://launchpad.net/python-openstackclient
.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
.. _Bug reports: https://bugs.launchpad.net/python-openstackclient/+bugs
.. _blueprints: https://blueprints.launchpad.net/python-openstackclient
.. _PyPi: https://pypi.python.org/pypi/osc-lib
.. _tarball: http://tarballs.openstack.org/osc-lib
.. _IRC channel: https://wiki.openstack.org/wiki/IRC
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

483
setup.cfg
View File

@ -1,11 +1,11 @@
[metadata]
name = python-openstackclient
summary = OpenStack Command-line Client
name = osc-lib
summary = OpenStackClient Library
description-file =
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = http://docs.openstack.org/developer/python-openstackclient
home-page = http://docs.openstack.org/developer/osc-lib
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
@ -20,484 +20,9 @@ classifier =
[files]
packages =
openstackclient
[entry_points]
console_scripts =
openstack = openstackclient.shell:main
keystoneclient.auth.plugin =
token_endpoint = openstackclient.api.auth_plugin:TokenEndpoint
osc_password = openstackclient.api.auth_plugin:OSCGenericPassword
openstack.cli =
command_list = openstackclient.common.module:ListCommand
module_list = openstackclient.common.module:ListModule
openstack.cli.base =
compute = openstackclient.compute.client
identity = openstackclient.identity.client
image = openstackclient.image.client
network = openstackclient.network.client
object_store = openstackclient.object.client
volume = openstackclient.volume.client
openstack.common =
availability_zone_list = openstackclient.common.availability_zone:ListAvailabilityZone
configuration_show = openstackclient.common.configuration:ShowConfiguration
extension_list = openstackclient.common.extension:ListExtension
limits_show = openstackclient.common.limits:ShowLimits
quota_set = openstackclient.common.quota:SetQuota
quota_show = openstackclient.common.quota:ShowQuota
openstack.compute.v2 =
compute_agent_create = openstackclient.compute.v2.agent:CreateAgent
compute_agent_delete = openstackclient.compute.v2.agent:DeleteAgent
compute_agent_list = openstackclient.compute.v2.agent:ListAgent
compute_agent_set = openstackclient.compute.v2.agent:SetAgent
aggregate_add_host = openstackclient.compute.v2.aggregate:AddAggregateHost
aggregate_create = openstackclient.compute.v2.aggregate:CreateAggregate
aggregate_delete = openstackclient.compute.v2.aggregate:DeleteAggregate
aggregate_list = openstackclient.compute.v2.aggregate:ListAggregate
aggregate_remove_host = openstackclient.compute.v2.aggregate:RemoveAggregateHost
aggregate_set = openstackclient.compute.v2.aggregate:SetAggregate
aggregate_show = openstackclient.compute.v2.aggregate:ShowAggregate
aggregate_unset = openstackclient.compute.v2.aggregate:UnsetAggregate
compute_service_delete = openstackclient.compute.v2.service:DeleteService
compute_service_list = openstackclient.compute.v2.service:ListService
compute_service_set = openstackclient.compute.v2.service:SetService
console_log_show = openstackclient.compute.v2.console:ShowConsoleLog
console_url_show = openstackclient.compute.v2.console:ShowConsoleURL
flavor_create = openstackclient.compute.v2.flavor:CreateFlavor
flavor_delete = openstackclient.compute.v2.flavor:DeleteFlavor
flavor_list = openstackclient.compute.v2.flavor:ListFlavor
flavor_show = openstackclient.compute.v2.flavor:ShowFlavor
flavor_set = openstackclient.compute.v2.flavor:SetFlavor
flavor_unset = openstackclient.compute.v2.flavor:UnsetFlavor
host_list = openstackclient.compute.v2.host:ListHost
host_set = openstackclient.compute.v2.host:SetHost
host_show = openstackclient.compute.v2.host:ShowHost
hypervisor_list = openstackclient.compute.v2.hypervisor:ListHypervisor
hypervisor_show = openstackclient.compute.v2.hypervisor:ShowHypervisor
hypervisor_stats_show = openstackclient.compute.v2.hypervisor_stats:ShowHypervisorStats
ip_fixed_add = openstackclient.compute.v2.fixedip:AddFixedIP
ip_fixed_remove = openstackclient.compute.v2.fixedip:RemoveFixedIP
ip_floating_add = openstackclient.compute.v2.floatingip:AddFloatingIP
ip_floating_remove = openstackclient.compute.v2.floatingip:RemoveFloatingIP
ip_floating_pool_list = openstackclient.compute.v2.floatingippool:ListFloatingIPPool
keypair_create = openstackclient.compute.v2.keypair:CreateKeypair
keypair_delete = openstackclient.compute.v2.keypair:DeleteKeypair
keypair_list = openstackclient.compute.v2.keypair:ListKeypair
keypair_show = openstackclient.compute.v2.keypair:ShowKeypair
server_add_security_group = openstackclient.compute.v2.server:AddServerSecurityGroup
server_add_volume = openstackclient.compute.v2.server:AddServerVolume
server_create = openstackclient.compute.v2.server:CreateServer
server_delete = openstackclient.compute.v2.server:DeleteServer
server_image_create = openstackclient.compute.v2.server:CreateServerImage
server_list = openstackclient.compute.v2.server:ListServer
server_lock = openstackclient.compute.v2.server:LockServer
server_migrate = openstackclient.compute.v2.server:MigrateServer
server_pause = openstackclient.compute.v2.server:PauseServer
server_reboot = openstackclient.compute.v2.server:RebootServer
server_rebuild = openstackclient.compute.v2.server:RebuildServer
server_remove_security_group = openstackclient.compute.v2.server:RemoveServerSecurityGroup
server_remove_volume = openstackclient.compute.v2.server:RemoveServerVolume
server_rescue = openstackclient.compute.v2.server:RescueServer
server_resize = openstackclient.compute.v2.server:ResizeServer
server_restore = openstackclient.compute.v2.server:RestoreServer
server_resume = openstackclient.compute.v2.server:ResumeServer
server_set = openstackclient.compute.v2.server:SetServer
server_shelve = openstackclient.compute.v2.server:ShelveServer
server_show = openstackclient.compute.v2.server:ShowServer
server_ssh = openstackclient.compute.v2.server:SshServer
server_start = openstackclient.compute.v2.server:StartServer
server_stop = openstackclient.compute.v2.server:StopServer
server_suspend = openstackclient.compute.v2.server:SuspendServer
server_dump_create = openstackclient.compute.v2.server:CreateServerDump
server_unlock = openstackclient.compute.v2.server:UnlockServer
server_unpause = openstackclient.compute.v2.server:UnpauseServer
server_unrescue = openstackclient.compute.v2.server:UnrescueServer
server_unset = openstackclient.compute.v2.server:UnsetServer
server_unshelve = openstackclient.compute.v2.server:UnshelveServer
server_group_create = openstackclient.compute.v2.server_group:CreateServerGroup
server_group_delete = openstackclient.compute.v2.server_group:DeleteServerGroup
server_group_list = openstackclient.compute.v2.server_group:ListServerGroup
server_group_show = openstackclient.compute.v2.server_group:ShowServerGroup
usage_list = openstackclient.compute.v2.usage:ListUsage
usage_show = openstackclient.compute.v2.usage:ShowUsage
openstack.identity.v2 =
catalog_list = openstackclient.identity.v2_0.catalog:ListCatalog
catalog_show = openstackclient.identity.v2_0.catalog:ShowCatalog
ec2_credentials_create = openstackclient.identity.v2_0.ec2creds:CreateEC2Creds
ec2_credentials_delete = openstackclient.identity.v2_0.ec2creds:DeleteEC2Creds
ec2_credentials_list = openstackclient.identity.v2_0.ec2creds:ListEC2Creds
ec2_credentials_show = openstackclient.identity.v2_0.ec2creds:ShowEC2Creds
endpoint_create = openstackclient.identity.v2_0.endpoint:CreateEndpoint
endpoint_delete = openstackclient.identity.v2_0.endpoint:DeleteEndpoint
endpoint_list = openstackclient.identity.v2_0.endpoint:ListEndpoint
endpoint_show = openstackclient.identity.v2_0.endpoint:ShowEndpoint
project_create = openstackclient.identity.v2_0.project:CreateProject
project_delete = openstackclient.identity.v2_0.project:DeleteProject
project_list = openstackclient.identity.v2_0.project:ListProject
project_set = openstackclient.identity.v2_0.project:SetProject
project_show = openstackclient.identity.v2_0.project:ShowProject
project_unset = openstackclient.identity.v2_0.project:UnsetProject
role_add = openstackclient.identity.v2_0.role:AddRole
role_create = openstackclient.identity.v2_0.role:CreateRole
role_delete = openstackclient.identity.v2_0.role:DeleteRole
role_list = openstackclient.identity.v2_0.role:ListRole
role_remove = openstackclient.identity.v2_0.role:RemoveRole
role_show = openstackclient.identity.v2_0.role:ShowRole
service_create = openstackclient.identity.v2_0.service:CreateService
service_delete = openstackclient.identity.v2_0.service:DeleteService
service_list = openstackclient.identity.v2_0.service:ListService
service_show = openstackclient.identity.v2_0.service:ShowService
token_issue = openstackclient.identity.v2_0.token:IssueToken
token_revoke = openstackclient.identity.v2_0.token:RevokeToken
user_create = openstackclient.identity.v2_0.user:CreateUser
user_delete = openstackclient.identity.v2_0.user:DeleteUser
user_list = openstackclient.identity.v2_0.user:ListUser
user_set = openstackclient.identity.v2_0.user:SetUser
user_show = openstackclient.identity.v2_0.user:ShowUser
user_role_list = openstackclient.identity.v2_0.role:ListUserRole
openstack.identity.v3 =
access_token_create = openstackclient.identity.v3.token:CreateAccessToken
catalog_list = openstackclient.identity.v3.catalog:ListCatalog
catalog_show = openstackclient.identity.v3.catalog:ShowCatalog
consumer_create = openstackclient.identity.v3.consumer:CreateConsumer
consumer_delete = openstackclient.identity.v3.consumer:DeleteConsumer
consumer_list = openstackclient.identity.v3.consumer:ListConsumer
consumer_set = openstackclient.identity.v3.consumer:SetConsumer
consumer_show = openstackclient.identity.v3.consumer:ShowConsumer
credential_create = openstackclient.identity.v3.credential:CreateCredential
credential_delete = openstackclient.identity.v3.credential:DeleteCredential
credential_list = openstackclient.identity.v3.credential:ListCredential
credential_set = openstackclient.identity.v3.credential:SetCredential
credential_show = openstackclient.identity.v3.credential:ShowCredential
domain_create = openstackclient.identity.v3.domain:CreateDomain
domain_delete = openstackclient.identity.v3.domain:DeleteDomain
domain_list = openstackclient.identity.v3.domain:ListDomain
domain_set = openstackclient.identity.v3.domain:SetDomain
domain_show = openstackclient.identity.v3.domain:ShowDomain
ec2_credentials_create = openstackclient.identity.v3.ec2creds:CreateEC2Creds
ec2_credentials_delete = openstackclient.identity.v3.ec2creds:DeleteEC2Creds
ec2_credentials_list = openstackclient.identity.v3.ec2creds:ListEC2Creds
ec2_credentials_show = openstackclient.identity.v3.ec2creds:ShowEC2Creds
endpoint_create = openstackclient.identity.v3.endpoint:CreateEndpoint
endpoint_delete = openstackclient.identity.v3.endpoint:DeleteEndpoint
endpoint_set = openstackclient.identity.v3.endpoint:SetEndpoint
endpoint_show = openstackclient.identity.v3.endpoint:ShowEndpoint
endpoint_list = openstackclient.identity.v3.endpoint:ListEndpoint
group_add_user = openstackclient.identity.v3.group:AddUserToGroup
group_contains_user = openstackclient.identity.v3.group:CheckUserInGroup
group_create = openstackclient.identity.v3.group:CreateGroup
group_delete = openstackclient.identity.v3.group:DeleteGroup
group_list = openstackclient.identity.v3.group:ListGroup
group_remove_user = openstackclient.identity.v3.group:RemoveUserFromGroup
group_set = openstackclient.identity.v3.group:SetGroup
group_show = openstackclient.identity.v3.group:ShowGroup
identity_provider_create = openstackclient.identity.v3.identity_provider:CreateIdentityProvider
identity_provider_delete = openstackclient.identity.v3.identity_provider:DeleteIdentityProvider
identity_provider_list = openstackclient.identity.v3.identity_provider:ListIdentityProvider
identity_provider_set = openstackclient.identity.v3.identity_provider:SetIdentityProvider
identity_provider_show = openstackclient.identity.v3.identity_provider:ShowIdentityProvider
mapping_create = openstackclient.identity.v3.mapping:CreateMapping
mapping_delete = openstackclient.identity.v3.mapping:DeleteMapping
mapping_list = openstackclient.identity.v3.mapping:ListMapping
mapping_set = openstackclient.identity.v3.mapping:SetMapping
mapping_show = openstackclient.identity.v3.mapping:ShowMapping
policy_create = openstackclient.identity.v3.policy:CreatePolicy
policy_delete = openstackclient.identity.v3.policy:DeletePolicy
policy_list = openstackclient.identity.v3.policy:ListPolicy
policy_set = openstackclient.identity.v3.policy:SetPolicy
policy_show = openstackclient.identity.v3.policy:ShowPolicy
project_create = openstackclient.identity.v3.project:CreateProject
project_delete = openstackclient.identity.v3.project:DeleteProject
project_list = openstackclient.identity.v3.project:ListProject
project_set = openstackclient.identity.v3.project:SetProject
project_show = openstackclient.identity.v3.project:ShowProject
federation_protocol_create = openstackclient.identity.v3.federation_protocol:CreateProtocol
federation_protocol_delete = openstackclient.identity.v3.federation_protocol:DeleteProtocol
federation_protocol_list = openstackclient.identity.v3.federation_protocol:ListProtocols
federation_protocol_set = openstackclient.identity.v3.federation_protocol:SetProtocol
federation_protocol_show = openstackclient.identity.v3.federation_protocol:ShowProtocol
federation_domain_list = openstackclient.identity.v3.unscoped_saml:ListAccessibleDomains
federation_project_list = openstackclient.identity.v3.unscoped_saml:ListAccessibleProjects
region_create = openstackclient.identity.v3.region:CreateRegion
region_delete = openstackclient.identity.v3.region:DeleteRegion
region_list = openstackclient.identity.v3.region:ListRegion
region_set = openstackclient.identity.v3.region:SetRegion
region_show = openstackclient.identity.v3.region:ShowRegion
request_token_authorize = openstackclient.identity.v3.token:AuthorizeRequestToken
request_token_create = openstackclient.identity.v3.token:CreateRequestToken
role_add = openstackclient.identity.v3.role:AddRole
role_create = openstackclient.identity.v3.role:CreateRole
role_delete = openstackclient.identity.v3.role:DeleteRole
role_list = openstackclient.identity.v3.role:ListRole
role_remove = openstackclient.identity.v3.role:RemoveRole
role_show = openstackclient.identity.v3.role:ShowRole
role_set = openstackclient.identity.v3.role:SetRole
role_assignment_list = openstackclient.identity.v3.role_assignment:ListRoleAssignment
service_create = openstackclient.identity.v3.service:CreateService
service_delete = openstackclient.identity.v3.service:DeleteService
service_list = openstackclient.identity.v3.service:ListService
service_show = openstackclient.identity.v3.service:ShowService
service_set = openstackclient.identity.v3.service:SetService
service_provider_create = openstackclient.identity.v3.service_provider:CreateServiceProvider
service_provider_delete = openstackclient.identity.v3.service_provider:DeleteServiceProvider
service_provider_list = openstackclient.identity.v3.service_provider:ListServiceProvider
service_provider_set = openstackclient.identity.v3.service_provider:SetServiceProvider
service_provider_show = openstackclient.identity.v3.service_provider:ShowServiceProvider
token_issue = openstackclient.identity.v3.token:IssueToken
token_revoke = openstackclient.identity.v3.token:RevokeToken
trust_create = openstackclient.identity.v3.trust:CreateTrust
trust_delete = openstackclient.identity.v3.trust:DeleteTrust
trust_list = openstackclient.identity.v3.trust:ListTrust
trust_show = openstackclient.identity.v3.trust:ShowTrust
user_create = openstackclient.identity.v3.user:CreateUser
user_delete = openstackclient.identity.v3.user:DeleteUser
user_list = openstackclient.identity.v3.user:ListUser
user_set = openstackclient.identity.v3.user:SetUser
user_password_set = openstackclient.identity.v3.user:SetPasswordUser
user_show = openstackclient.identity.v3.user:ShowUser
openstack.image.v1 =
image_create = openstackclient.image.v1.image:CreateImage
image_delete = openstackclient.image.v1.image:DeleteImage
image_list = openstackclient.image.v1.image:ListImage
image_save = openstackclient.image.v1.image:SaveImage
image_set = openstackclient.image.v1.image:SetImage
image_show = openstackclient.image.v1.image:ShowImage
openstack.image.v2 =
image_add_project = openstackclient.image.v2.image:AddProjectToImage
image_create = openstackclient.image.v2.image:CreateImage
image_delete = openstackclient.image.v2.image:DeleteImage
image_list = openstackclient.image.v2.image:ListImage
image_remove_project = openstackclient.image.v2.image:RemoveProjectImage
image_save = openstackclient.image.v2.image:SaveImage
image_show = openstackclient.image.v2.image:ShowImage
image_set = openstackclient.image.v2.image:SetImage
openstack.network.v2 =
address_scope_create = openstackclient.network.v2.address_scope:CreateAddressScope
address_scope_delete = openstackclient.network.v2.address_scope:DeleteAddressScope
address_scope_list = openstackclient.network.v2.address_scope:ListAddressScope
address_scope_set = openstackclient.network.v2.address_scope:SetAddressScope
address_scope_show = openstackclient.network.v2.address_scope:ShowAddressScope
ip_floating_create = openstackclient.network.v2.floating_ip:CreateFloatingIP
ip_floating_delete = openstackclient.network.v2.floating_ip:DeleteFloatingIP
ip_floating_list = openstackclient.network.v2.floating_ip:ListFloatingIP
ip_floating_show = openstackclient.network.v2.floating_ip:ShowFloatingIP
network_create = openstackclient.network.v2.network:CreateNetwork
network_delete = openstackclient.network.v2.network:DeleteNetwork
network_list = openstackclient.network.v2.network:ListNetwork
network_set = openstackclient.network.v2.network:SetNetwork
network_show = openstackclient.network.v2.network:ShowNetwork
port_create = openstackclient.network.v2.port:CreatePort
port_delete = openstackclient.network.v2.port:DeletePort
port_list = openstackclient.network.v2.port:ListPort
port_set = openstackclient.network.v2.port:SetPort
port_show = openstackclient.network.v2.port:ShowPort
router_add_port = openstackclient.network.v2.router:AddPortToRouter
router_add_subnet = openstackclient.network.v2.router:AddSubnetToRouter
router_create = openstackclient.network.v2.router:CreateRouter
router_delete = openstackclient.network.v2.router:DeleteRouter
router_list = openstackclient.network.v2.router:ListRouter
router_remove_port = openstackclient.network.v2.router:RemovePortFromRouter
router_remove_subnet = openstackclient.network.v2.router:RemoveSubnetFromRouter
router_set = openstackclient.network.v2.router:SetRouter
router_show = openstackclient.network.v2.router:ShowRouter
security_group_create = openstackclient.network.v2.security_group:CreateSecurityGroup
security_group_delete = openstackclient.network.v2.security_group:DeleteSecurityGroup
security_group_list = openstackclient.network.v2.security_group:ListSecurityGroup
security_group_set = openstackclient.network.v2.security_group:SetSecurityGroup
security_group_show = openstackclient.network.v2.security_group:ShowSecurityGroup
security_group_rule_create = openstackclient.network.v2.security_group_rule:CreateSecurityGroupRule
security_group_rule_delete = openstackclient.network.v2.security_group_rule:DeleteSecurityGroupRule
security_group_rule_list = openstackclient.network.v2.security_group_rule:ListSecurityGroupRule
security_group_rule_show = openstackclient.network.v2.security_group_rule:ShowSecurityGroupRule
subnet_create = openstackclient.network.v2.subnet:CreateSubnet
subnet_delete = openstackclient.network.v2.subnet:DeleteSubnet
subnet_list = openstackclient.network.v2.subnet:ListSubnet
subnet_set = openstackclient.network.v2.subnet:SetSubnet
subnet_show = openstackclient.network.v2.subnet:ShowSubnet
subnet_pool_create = openstackclient.network.v2.subnet_pool:CreateSubnetPool
subnet_pool_delete = openstackclient.network.v2.subnet_pool:DeleteSubnetPool
subnet_pool_list = openstackclient.network.v2.subnet_pool:ListSubnetPool
subnet_pool_set = openstackclient.network.v2.subnet_pool:SetSubnetPool
subnet_pool_show = openstackclient.network.v2.subnet_pool:ShowSubnetPool
openstack.object_store.v1 =
object_store_account_set = openstackclient.object.v1.account:SetAccount
object_store_account_show = openstackclient.object.v1.account:ShowAccount
object_store_account_unset = openstackclient.object.v1.account:UnsetAccount
container_create = openstackclient.object.v1.container:CreateContainer
container_delete = openstackclient.object.v1.container:DeleteContainer
container_list = openstackclient.object.v1.container:ListContainer
container_save = openstackclient.object.v1.container:SaveContainer
container_set = openstackclient.object.v1.container:SetContainer
container_show = openstackclient.object.v1.container:ShowContainer
container_unset = openstackclient.object.v1.container:UnsetContainer
object_create = openstackclient.object.v1.object:CreateObject
object_delete = openstackclient.object.v1.object:DeleteObject
object_list = openstackclient.object.v1.object:ListObject
object_save = openstackclient.object.v1.object:SaveObject
object_set = openstackclient.object.v1.object:SetObject
object_show = openstackclient.object.v1.object:ShowObject
object_unset = openstackclient.object.v1.object:UnsetObject
openstack.volume.v1 =
backup_create = openstackclient.volume.v1.backup:CreateBackup
backup_delete = openstackclient.volume.v1.backup:DeleteBackup
backup_list = openstackclient.volume.v1.backup:ListBackup
backup_restore = openstackclient.volume.v1.backup:RestoreBackup
backup_show = openstackclient.volume.v1.backup:ShowBackup
snapshot_create = openstackclient.volume.v1.snapshot:CreateSnapshot
snapshot_delete = openstackclient.volume.v1.snapshot:DeleteSnapshot
snapshot_list = openstackclient.volume.v1.snapshot:ListSnapshot
snapshot_set = openstackclient.volume.v1.snapshot:SetSnapshot
snapshot_show = openstackclient.volume.v1.snapshot:ShowSnapshot
snapshot_unset = openstackclient.volume.v1.snapshot:UnsetSnapshot
volume_create = openstackclient.volume.v1.volume:CreateVolume
volume_delete = openstackclient.volume.v1.volume:DeleteVolume
volume_list = openstackclient.volume.v1.volume:ListVolume
volume_set = openstackclient.volume.v1.volume:SetVolume
volume_show = openstackclient.volume.v1.volume:ShowVolume
volume_unset = openstackclient.volume.v1.volume:UnsetVolume
volume_type_create = openstackclient.volume.v1.volume_type:CreateVolumeType
volume_type_delete = openstackclient.volume.v1.volume_type:DeleteVolumeType
volume_type_list = openstackclient.volume.v1.volume_type:ListVolumeType
volume_type_set = openstackclient.volume.v1.volume_type:SetVolumeType
volume_type_show = openstackclient.volume.v1.volume_type:ShowVolumeType
volume_type_unset = openstackclient.volume.v1.volume_type:UnsetVolumeType
volume_qos_associate = openstackclient.volume.v1.qos_specs:AssociateQos
volume_qos_create = openstackclient.volume.v1.qos_specs:CreateQos
volume_qos_delete = openstackclient.volume.v1.qos_specs:DeleteQos
volume_qos_disassociate = openstackclient.volume.v1.qos_specs:DisassociateQos
volume_qos_list = openstackclient.volume.v1.qos_specs:ListQos
volume_qos_set = openstackclient.volume.v1.qos_specs:SetQos
volume_qos_show = openstackclient.volume.v1.qos_specs:ShowQos
volume_qos_unset = openstackclient.volume.v1.qos_specs:UnsetQos
volume_service_list = openstackclient.volume.v1.service:ListService
openstack.volume.v2 =
backup_create = openstackclient.volume.v2.backup:CreateBackup
backup_delete = openstackclient.volume.v2.backup:DeleteBackup
backup_list = openstackclient.volume.v2.backup:ListBackup
backup_restore = openstackclient.volume.v2.backup:RestoreBackup
backup_show = openstackclient.volume.v2.backup:ShowBackup
snapshot_create = openstackclient.volume.v2.snapshot:CreateSnapshot
snapshot_delete = openstackclient.volume.v2.snapshot:DeleteSnapshot
snapshot_list = openstackclient.volume.v2.snapshot:ListSnapshot
snapshot_set = openstackclient.volume.v2.snapshot:SetSnapshot
snapshot_show = openstackclient.volume.v2.snapshot:ShowSnapshot
snapshot_unset = openstackclient.volume.v2.snapshot:UnsetSnapshot
volume_create = openstackclient.volume.v2.volume:CreateVolume
volume_delete = openstackclient.volume.v2.volume:DeleteVolume
volume_list = openstackclient.volume.v2.volume:ListVolume
volume_set = openstackclient.volume.v2.volume:SetVolume
volume_show = openstackclient.volume.v2.volume:ShowVolume
volume_unset = openstackclient.volume.v2.volume:UnsetVolume
volume_type_create = openstackclient.volume.v2.volume_type:CreateVolumeType
volume_type_delete = openstackclient.volume.v2.volume_type:DeleteVolumeType
volume_type_list = openstackclient.volume.v2.volume_type:ListVolumeType
volume_type_set = openstackclient.volume.v2.volume_type:SetVolumeType
volume_type_show = openstackclient.volume.v2.volume_type:ShowVolumeType
volume_type_unset = openstackclient.volume.v2.volume_type:UnsetVolumeType
volume_qos_associate = openstackclient.volume.v2.qos_specs:AssociateQos
volume_qos_create = openstackclient.volume.v2.qos_specs:CreateQos
volume_qos_delete = openstackclient.volume.v2.qos_specs:DeleteQos
volume_qos_disassociate = openstackclient.volume.v2.qos_specs:DisassociateQos
volume_qos_list = openstackclient.volume.v2.qos_specs:ListQos
volume_qos_set = openstackclient.volume.v2.qos_specs:SetQos
volume_qos_show = openstackclient.volume.v2.qos_specs:ShowQos
volume_qos_unset = openstackclient.volume.v2.qos_specs:UnsetQos
volume_service_list = openstackclient.volume.v2.service:ListService
osc_lib
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
[upload_sphinx]
upload-dir = doc/build/html
[wheel]
universal = 1
[extract_messages]
keywords = _ gettext ngettext l_ lazy_gettext
mapping_file = babel.cfg
output_file = openstackclient/locale/openstackclient.pot
[update_catalog]
domain = openstackclient
output_dir = openstackclient/locale
input_file = openstackclient/locale/openstackclient.pot
[compile_catalog]
directory = openstackclient/locale
domain = openstackclient

37
tox.ini
View File

@ -12,40 +12,7 @@ commands = ostestr {posargs}
whitelist_externals = ostestr
[testenv:pep8]
commands =
flake8
bandit -r openstackclient -x tests -s B105,B106,B107,B401,B404,B603,B606,B607,B110,B605,B101
[testenv:bandit]
# This command runs the bandit security linter against the openstackclient
# codebase minus the tests directory. Some tests are being excluded to
# reduce the number of positives before a team inspection, and to ensure a
# passing gate job for initial addition. The excluded tests are:
# B105-B107: hardcoded password checks - likely to generate false positives
# in a gate environment
# B401: import subprocess - not necessarily a security issue; this plugin is
# mainly used for penetration testing workflow
# B603,B606: process without shell - not necessarily a security issue; this
# plugin is mainly used for penetration testing workflow
# B607: start process with a partial path - this should be a project level
# decision
# NOTE(elmiko): The following tests are being excluded specifically for
# python-openstackclient, they are being excluded to ensure that voting jobs
# in the project and in bandit integration tests continue to pass. These
# tests have generated issue within the project and should be investigated
# by the project.
# B110: try, except, pass detected - possible security issue; this should be
# investigated by the project for possible exploitation
# B605: process with a shell - possible security issue; this should be
# investigated by the project for possible exploitation
# B101: use of assert - this code will be removed when compiling to optimized
# byte code
commands =
bandit -r openstackclient -x tests -s B105,B106,B107,B401,B404,B603,B606,B607,B110,B605,B101
[testenv:functional]
setenv = OS_TEST_PATH=./functional/tests
passenv = OS_*
commands = flake8
[testenv:venv]
commands = {posargs}
@ -56,7 +23,7 @@ commands =
coverage report
[testenv:debug]
commands = oslo_debug_helper -t openstackclient/tests {posargs}
commands = oslo_debug_helper -t osc_lib/tests {posargs}
[testenv:docs]
commands = python setup.py build_sphinx