Update tox.ini with more recent configuration

Author: alvarolopez

README.md

@@ -9,78 +9,72 @@ Python library and CLI for the INDIGO PaaS Orchestrator.
 
 ## Installation.
 
-You can install it directly from PyPI
+You can install it directly from PyPI:
 
-```
-pip install orpy
-```
+    pip install orpy
 
 ## Usage as CLI
 
 Before using the orchestrator with orpy you need to export your IAM access
 token. As long as the access token is valid orchent can tell the orchestrator
 what to do.
 
-```
-export ORCHESTRATOR_TOKEN=<your access token here>
-```
-
-```
-usage: orpy [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
-            [--url <orchestrator-url>]
-
-Command line client for the INDIGO PaaS Orchestrator.
-
-    Please, before using this command put your a valid OpenID Connnect access
-    token into the ORCHESTRATOR_TOKEN environment variable, so that we can use
-    this token for authentication.
-
-
-optional arguments:
-  --version             show program's version number and exit
-  -v, --verbose         Increase verbosity of output. Can be repeated.
-  -q, --quiet           Suppress output except warnings and errors.
-  --log-file LOG_FILE   Specify a file to log output. Disabled by default.
-  -h, --help            Show help message and exit.
-  --debug               Show tracebacks on errors.
-  --url <orchestrator-url>
-                        The base url of the orchestrator rest interface.
-                        Alternative the environment variable ORCHESTRATOR_URL
-                        can be used.
-
-Commands:
-  complete       print bash completion command (cliff)
-  dep create     Create a deployment.
-  dep delete     Show details about an existing deployment.
-  dep list       List existing deployments at orchestrator.
-  dep show       Show details about an existing deployment.
-  dep template   Get template used for a given deployment.
-  dep update     Update an existing deployment.
-  deployment create  Create a deployment.
-  deployment delete  Show details about an existing deployment.
-  deployment list  List existing deployments at orchestrator.
-  deployment show  Show details about an existing deployment.
-  deployment template  Get template used for a given deployment.
-  deployment update  Update an existing deployment.
-  help           print detailed help for another command (cliff)
-  resources list  List Resources for a given deployment.
-  resources show  Show details about a resource for a given deployment.
-  test           Test if the given URL is pointing to an orchestrator.
-```
+    export ORCHESTRATOR_TOKEN=<your access token here>
+
+Then, the usage is as follows:
+
+    usage: orpy [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
+               [--url <orchestrator-url>]
+
+    Command line client for the INDIGO PaaS Orchestrator.
+
+        Please, before using this command put your a valid OpenID Connnect access
+        token into the ORCHESTRATOR_TOKEN environment variable, so that we can use
+        this token for authentication.
+
+
+    optional arguments:
+      --version             show program's version number and exit
+      -v, --verbose         Increase verbosity of output. Can be repeated.
+      -q, --quiet           Suppress output except warnings and errors.
+      --log-file LOG_FILE   Specify a file to log output. Disabled by default.
+      -h, --help            Show help message and exit.
+      --debug               Show tracebacks on errors.
+      --url <orchestrator-url>
+                            The base url of the orchestrator rest interface.
+                            Alternative the environment variable ORCHESTRATOR_URL
+                            can be used.
+
+    Commands:
+      complete       print bash completion command (cliff)
+      dep create     Create a deployment.
+      dep delete     Show details about an existing deployment.
+      dep list       List existing deployments at orchestrator.
+      dep show       Show details about an existing deployment.
+      dep template   Get template used for a given deployment.
+      dep update     Update an existing deployment.
+      deployment create  Create a deployment.
+      deployment delete  Show details about an existing deployment.
+      deployment list  List existing deployments at orchestrator.
+      deployment show  Show details about an existing deployment.
+      deployment template  Get template used for a given deployment.
+      deployment update  Update an existing deployment.
+      help           print detailed help for another command (cliff)
+      resources list  List Resources for a given deployment.
+      resources show  Show details about a resource for a given deployment.
+      test           Test if the given URL is pointing to an orchestrator.
 
 ## Usage as API
 
 Besides being a CLI application, `orpy` can be used as a library:
 
-```
->>> from orpy.client import client
->>> orpy = client.OrpyClient(
-...     url=ORCHESTRATOR_URL,
-...     token=ORCHESTRATOR_TOKEN)
->>> deployments = orpy.deployments.list()
->>> deployments[0]
-<Deployment cloudProviderName=provider-BARI, createdBy={u'subject': u'de28e179-ec86-4915-a748-7a37f8d80311', u'issuer': u'https://iam.deep-hybrid-datacloud.eu/'}, creationTime=2019-05-27T11:31+0000, links=[{u'href': u'https://paas.cloud.cnaf.infn.it/orchestrator/deployments/11e98073-06f3-6797-9258-0242ac140005', u'rel': u'self'}, {u'href': u'https://paas.cloud.cnaf.infn.it/orchestrator/deployments/11e98073-06f3-6797-9258-0242ac140005/resources', u'rel': u'resources'}, {u'href': u'https://paas.cloud.cnaf.infn.it/orchestrator/deployments/11e98073-06f3-6797-9258-0242ac140005/template', u'rel': u'template'}], outputs={}, physicalId=11e98073-06f3-6797-9258-0242ac140005, status=CREATE_FAILED, statusReason=Error while checking the deployment status; nested exception is feign.RetryableException: mesos.ui.sav.sk executing GET https://mesos.ui.sav.sk/marathon/v2/groups/11e98073-06f3-6797-9258-0242ac140005, task=NONE, updateTime=2019-05-29T02:05+0000, uuid=11e98073-06f3-6797-9258-0242ac140005>
->>> deployments[0].status
-CREATE_FAILED
->>>
-```
+    >>> from orpy.client import client
+    >>> orpy = client.OrpyClient(
+    ...     url=ORCHESTRATOR_URL,
+    ...     token=ORCHESTRATOR_TOKEN)
+    >>> deployments = orpy.deployments.list()
+    >>> deployments[0]
+    <Deployment cloudProviderName=provider-BARI, createdBy={u'subject': u'de28e179-ec86-4915-a748-7a37f8d80311', u'issuer': u'https://iam.deep-hybrid-datacloud.eu/'}, creationTime=2019-05-27T11:31+0000, links=[{u'href': u'https://paas.cloud.cnaf.infn.it/orchestrator/deployments/11e98073-06f3-6797-9258-0242ac140005', u'rel': u'self'}, {u'href': u'https://paas.cloud.cnaf.infn.it/orchestrator/deployments/11e98073-06f3-6797-9258-0242ac140005/resources', u'rel': u'resources'}, {u'href': u'https://paas.cloud.cnaf.infn.it/orchestrator/deployments/11e98073-06f3-6797-9258-0242ac140005/template', u'rel': u'template'}], outputs={}, physicalId=11e98073-06f3-6797-9258-0242ac140005, status=CREATE_FAILED, statusReason=Error while checking the deployment status; nested exception is feign.RetryableException: mesos.ui.sav.sk executing GET https://mesos.ui.sav.sk/marathon/v2/groups/11e98073-06f3-6797-9258-0242ac140005, task=NONE, updateTime=2019-05-29T02:05+0000, uuid=11e98073-06f3-6797-9258-0242ac140005>
+    >>> deployments[0].status
+    CREATE_FAILED
+    >>>

setup.cfg

@@ -1,23 +1,26 @@
 [metadata]
 name = orpy
 summary = Python library and CLI for the INDIGO PaaS Orchestrator.
-description-file =
-    README.md
+description-file = README.md
 description-content-type = text/markdown; charset=UTF-8
 
 author = Alvaro Lopez Garcia
 author-email = [email protected]
 home-page = https://github.com/indigo-dc/orpy
 classifier =
+    Development Status :: 5 - Production/Stable
+    Environment :: Console
+    Environment :: Web Environment
+    Intended Audience :: Developers
     Intended Audience :: Information Technology
+    Intended Audience :: Science/Research
     Intended Audience :: System Administrators
     License :: OSI Approved :: Apache Software License
-    Operating System :: POSIX :: Linux
+    Operating System :: OS Independent
     Programming Language :: Python
     Programming Language :: Python :: 2
-    Programming Language :: Python :: 2.7
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.6
+    Topic :: Internet :: WWW/HTTP
 
 [files]
 packages =
@@ -52,17 +55,3 @@ all_files = 1
 
 [upload_sphinx]
 upload-dir = doc/build/html
-
-[compile_catalog]
-directory = orpy/locale
-domain = orpy
-
-[update_catalog]
-domain = orpy
-output_dir = orpy/locale
-input_file = orpy/locale/orpy.pot
-
-[extract_messages]
-keywords = _ gettext ngettext l_ lazy_gettext
-mapping_file = babel.cfg
-output_file = orpy/locale/orpy.pot

test-requirements.txt

@@ -13,3 +13,5 @@ testscenarios>=0.4 # Apache-2.0/BSD
 testtools>=2.2.0 # MIT
 bandit>=1.1.0 # Apache-2.0
 reno>=2.5.0 # Apache-2.0
+
+docutils>=0.15.2

tox.ini

@@ -1,6 +1,6 @@
 [tox]
-minversion = 1.6
-envlist = py36,py27,pep8,pip-missing-reqs
+minversion = 2.1
+envlist = py36,py27,pep8,pip-missing-reqs,pypi,bandit
 skipsdist = True
 
 [testenv]
@@ -14,53 +14,92 @@ setenv =
    VIRTUAL_ENV={envdir}
 deps = -r{toxinidir}/requirements.txt
        -r{toxinidir}/test-requirements.txt
-commands = python setup.py testr --slowest --testr-args='{posargs}'
+commands =
+    find . -type f -name "*.pyc" -delete
+
+[testenv:venv]
+commands = {posargs}
+
+[testenv:cover]
+# TODO(stephenfin): Remove the PYTHON hack below in favour of a [coverage]
+# section once we rely on coverage 4.3+
+#
+# https://bitbucket.org/ned/coveragepy/issues/519/
+envdir = {toxworkdir}/shared
+setenv =
+  {[testenv]setenv}
+  PYTHON=coverage run --source orpy --parallel-mode
+commands =
+  {[testenv]commands}
+  coverage erase
+  stestr run {posargs}
+  coverage combine
+  coverage html -d cover
+  coverage xml -o cover/coverage.xml
+  coverage report
+
+[testenv:py27]
+# TODO(efried): Remove this once https://github.com/tox-dev/tox/issues/425 is fixed.
+basepython = python2.7
+commands =
+  {[testenv]commands}
+  stestr run {posargs}
+
+[testenv:py35]
+# TODO(efried): Remove this once https://github.com/tox-dev/tox/issues/425 is fixed.
+basepython = python3.5
+commands =
+  {[testenv]commands}
+  stestr run {posargs}
+
+[testenv:py36]
+# TODO(efried): Remove this once https://github.com/tox-dev/tox/issues/425 is fixed.
+basepython = python3.6
+commands =
+  {[testenv:py35]commands}
 
 [testenv:pep8]
+envdir = {toxworkdir}/shared
 commands =
   flake8
-  # Run security linter
-  # B110: except: pass
-  # B410: importing etree
-  bandit -r orpy -x tests -s B110,B410
 
 [testenv:bandit]
-# NOTE(browne): This is required for the integration test job of the bandit
-# project. Please do not remove.
+envdir = {toxworkdir}/shared
 commands = bandit -r orpy -x tests -s B110,B410
 
-[testenv:venv]
-commands = {posargs}
+[testenv:pypi]
+envdir = {toxworkdir}/shared
+commands = python3 setup.py check -r -s -m
 
-[testenv:cover]
-commands = python setup.py testr --coverage --testr-args='{posargs}'
+[testenv:cobertura]
+commands = py.test --cov=orpy --cov-report=xml --cov-report=term-missing orpy/tests
 
-[testenv:coveralls]
-passenv = TRAVIS TRAVIS_JOB_ID TRAVIS_BRANCH
-commands = python setup.py testr --coverage --testr-args='{posargs}'
-           coveralls
-deps = coveralls
-       {[testenv]deps}
+[testenv:bandit-report]
+commands =
+    - mkdir /tmp/bandit
+    - bandit -r orpy -x tests -s B110,B410 -f html -o /tmp/bandit/index.html
 
 [testenv:docs]
-deps = -r{toxinidir}/doc/requirements.txt
+# TODO(melwitt): This can be removed when the docs target can be run
+# with python 3.x
+basepython = python2.7
 commands =
-    rm -rf doc/build 
+    rm -rf doc/build
     python setup.py build_sphinx
 
-[flake8]
-# H803 skipped on purpose per list discussion.
-# E123, E125 skipped as they are invalid PEP-8.
-
-show-source = True
-ignore = E123,E125,H803
-builtins = _
-exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build
-
 [testenv:pip-missing-reqs]
 # do not install test-requirements as that will pollute the virtualenv for
 # determining missing packages
 # this also means that pip-missing-reqs must be installed separately, outside
 # of the requirements.txt files
 deps = pip_check_reqs
 commands=pip-missing-reqs -d --ignore-file=orpy/tests/* orpy
+
+[flake8]
+# H803 skipped on purpose per list discussion.
+# E123, E125 skipped as they are invalid PEP-8.
+
+show-source = True
+ignore = E123,E125,H803,H405
+builtins = _
+exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build