From 9c3bd770f24db23cee4fae93ec80f85c5b638a1f Mon Sep 17 00:00:00 2001 From: Luka Peschke Date: Tue, 17 Dec 2019 14:58:26 +0100 Subject: [PATCH] Fix tox environments Work items: * Removed the globale-requirements constraint. Since python-cloudkittyclient is now part of the global requirements, the upstream requirements file can't be used anymore. * Add cliff to docs requirements. * Change cloudkittyclient namespace names: Having a dot in a namespace name causes the "autoprogram-cliff" to use the "application mode". Change-Id: I8020d816b3397550fbcbd42cc14a9861bca7ae80 --- cloudkittyclient/shell.py | 2 +- doc/requirements.txt | 1 + doc/source/cli_reference.rst | 9 ++++----- doc/source/conf.py | 2 ++ setup.cfg | 4 ++-- tox.ini | 6 +++--- 6 files changed, 13 insertions(+), 11 deletions(-) diff --git a/cloudkittyclient/shell.py b/cloudkittyclient/shell.py index 8e3abbf..752774b 100644 --- a/cloudkittyclient/shell.py +++ b/cloudkittyclient/shell.py @@ -94,7 +94,7 @@ class CloudKittyShell(cliff.app.App): super(CloudKittyShell, self).__init__( description='CloudKitty CLI client', version=utils.get_version(), - command_manager=CommandManager('cloudkittyclient.v{}'.format( + command_manager=CommandManager('cloudkittyclient_v{}'.format( self._get_api_version(args[:]), )), deferred_help=True, diff --git a/doc/requirements.txt b/doc/requirements.txt index c4fbe83..535c7ed 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -7,3 +7,4 @@ sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD reno>=2.5.0 # Apache-2.0 +cliff>=2.11.0 # Apache-2.0 diff --git a/doc/source/cli_reference.rst b/doc/source/cli_reference.rst index bd81c64..154f273 100644 --- a/doc/source/cli_reference.rst +++ b/doc/source/cli_reference.rst @@ -5,18 +5,17 @@ CLI Reference V1 Client ========= -.. autoprogram-cliff:: cloudkittyclient.v1 +.. autoprogram-cliff:: cloudkittyclient_v1 :application: cloudkitty - V2 Client ========= -.. autoprogram-cliff:: cloudkittyclient.v2 +.. autoprogram-cliff:: cloudkittyclient_v2 :command: dataframes add -.. autoprogram-cliff:: cloudkittyclient.v2 +.. autoprogram-cliff:: cloudkittyclient_v2 :command: scope state get -.. autoprogram-cliff:: cloudkittyclient.v2 +.. autoprogram-cliff:: cloudkittyclient_v2 :command: summary get diff --git a/doc/source/conf.py b/doc/source/conf.py index ba3b5c1..fa13515 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -26,6 +26,8 @@ extensions = [ 'sphinxcontrib.rsvgconverter', ] +autoprogram_cliff_application = 'cloudkitty' + autoprogram_cliff_ignored = [ "--format", "--column", "--max-width", "--fit-width", "--print-empty", "--format-config-file", "--noindent", "--quote", "--sort-column", diff --git a/setup.cfg b/setup.cfg index 44a7ec2..eaf878f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -145,7 +145,7 @@ openstack.rating.v2 = rating_pyscript_update = cloudkittyclient.v1.rating.pyscripts_cli:CliUpdateScript rating_pyscript_delete = cloudkittyclient.v1.rating.pyscripts_cli:CliDeleteScript -cloudkittyclient.v1 = +cloudkittyclient_v1 = total_get = cloudkittyclient.v1.report_cli:CliTotalGet summary_get = cloudkittyclient.v1.report_cli:CliSummaryGet report_tenant_list = cloudkittyclient.v1.report_cli:CliTenantList @@ -201,7 +201,7 @@ cloudkittyclient.v1 = pyscript_update = cloudkittyclient.v1.rating.pyscripts_cli:CliUpdateScript pyscript_delete = cloudkittyclient.v1.rating.pyscripts_cli:CliDeleteScript -cloudkittyclient.v2 = +cloudkittyclient_v2 = dataframes_add = cloudkittyclient.v2.dataframes_cli:CliDataframesAdd scope_state_get = cloudkittyclient.v2.scope_cli:CliScopeStateGet diff --git a/tox.ini b/tox.ini index 66c1f04..a665605 100644 --- a/tox.ini +++ b/tox.ini @@ -5,7 +5,7 @@ skipsdist = True [testenv] usedevelop = True -install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} -U {opts} {packages} +install_command = pip install -U {opts} {packages} setenv = VIRTUAL_ENV={envdir} deps = -r{toxinidir}/requirements.txt @@ -49,7 +49,7 @@ commands = {posargs} [testenv:docs] basepython = python3 deps = -r{toxinidir}/doc/requirements.txt -commands = sphinx-build -W --keep-going -b html doc/source doc/build/html +commands = sphinx-build --keep-going -b html doc/source doc/build/html [testenv:pdf-docs] basepython = python3 @@ -58,7 +58,7 @@ deps = {[testenv:docs]deps} whitelist_externals = make commands = - sphinx-build -W --keep-going -b latex doc/source doc/build/pdf + sphinx-build --keep-going -b latex doc/source doc/build/pdf make -C doc/build/pdf [flake8]