plone.api/read_only: code conventions and import fixes

Repository: plone.api
Branch: refs/heads/read_only
Date: 2017-07-20T02:16:45+02:00
Author: Alexander Loechel (loechel) <[email protected]>
Commit: https://github.com/plone/plone.api/commit/87d62553f7ed342954ea14c85e8709fef5c61bd1

code conventions and import fixes

Files changed:
A tox.ini
M .gitignore
M setup.cfg
M setup.py
M src/plone/api/portal.py
M src/plone/api/tests/test_user.py

diff --git a/.gitignore b/.gitignore
index aee378d..7cd320c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -22,3 +22,6 @@
 /src/plone.api.egg-info/
 /var/
 pip-selfcheck.json
+/.tox/
+/_build/
+/reports/
diff --git a/setup.cfg b/setup.cfg
index 634dee1..9a377df 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -9,3 +9,14 @@ force_single_line=True
 lines_after_imports=2
 line_length=200
 not_skip=__init__.py
+
+[coverage:run]
+branch = True
+source = src
+omit =
+
+[coverage:report]
+precision = 2
+
+[coverage:html]
+directory = reports/coverage
diff --git a/setup.py b/setup.py
index 65958a6..4dc60a5 100644
--- a/setup.py
+++ b/setup.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 from setuptools import find_packages
 from setuptools import setup
 
@@ -8,6 +9,7 @@
 def read(*rnames):
     return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
 
+
 long_description = \
     read('README.rst') + '\n\n' + \
     read('CHANGES.rst') + '\n\n' + \
diff --git a/src/plone/api/portal.py b/src/plone/api/portal.py
index dec94a8..dd70632 100644
--- a/src/plone/api/portal.py
+++ b/src/plone/api/portal.py
@@ -255,7 +255,7 @@ def show_message(message=None, request=None, type='info'):
     :param message: [required] Message to show.
     :type message: string
     :param request: [required] Request.
-    :type request: TODO: hm?
+    :type request: TODO: hm?  # NOQA: T000
     :param type: Message type. Possible values: 'info', 'warn', 'error'
     :type type: string
     :raises:
diff --git a/src/plone/api/tests/test_user.py b/src/plone/api/tests/test_user.py
index 712cabe..9b22efa 100644
--- a/src/plone/api/tests/test_user.py
+++ b/src/plone/api/tests/test_user.py
@@ -323,7 +323,7 @@ def test_get_roles_no_parameters(self):
 
     def test_get_permissions_no_parameters(self):
         """Test get_permissions passing no parameters."""
-        self.assertEqual(  # TODO: maybe assertItemsEqual?
+        self.assertEqual(  # TODO: maybe assertItemsEqual?  # NOQA: T000
             set(p[0] for p in getPermissions()),
             set(api.user.get_permissions().keys())
         )
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..ef559bb
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,123 @@
+[tox]
+envlist =
+    py27-Plone-{4.3,5.0,5.1},
+    isort,
+    flake8,
+    docs,
+    coverage-report,
+
+skip_missing_interpreters = false
+
+[testenv]
+skip_install = True
+
+basepython:
+    py27: python2.7
+
+extras =
+    test
+
+Plone-4.3:
+    commands =
+        mkdir -p {toxinidir}/reports/coverage
+        {envbindir}/buildout -c {toxinidir}/plone-4.3.x.cfg buildout:directory={envdir} buildout:develop={toxinidir} bootstrap
+        {envbindir}/buildout -c {toxinidir}/plone-4.3.x.cfg buildout:directory={envdir} buildout:develop={toxinidir}
+        coverage run {envbindir}/test -v1 --auto-color {posargs}
+Plone-5.0:
+    commands =
+        mkdir -p {toxinidir}/reports/coverage
+        {envbindir}/buildout -c {toxinidir}/plone-5.0.x.cfg buildout:directory={envdir} buildout:develop={toxinidir} bootstrap
+        {envbindir}/buildout -c {toxinidir}/plone-5.0.x.cfg buildout:directory={envdir} buildout:develop={toxinidir}
+        coverage run {envbindir}/test -v1 --auto-color {posargs}
+Plone-5.1:
+    commands =
+        mkdir -p {toxinidir}/reports/coverage
+        {envbindir}/buildout -c {toxinidir}/plone-5.1.x.cfg buildout:directory={envdir} buildout:develop={toxinidir} bootstrap
+        {envbindir}/buildout -c {toxinidir}/plone-5.1.x.cfg buildout:directory={envdir} buildout:develop={toxinidir}
+        coverage run {envbindir}/test -v1 --auto-color {posargs}
+
+setenv =
+    COVERAGE_FILE=.coverage.{envname}
+
+deps =
+    pdbpp
+    setuptools==33.1.1
+    zc.buildout==2.8.0
+    coverage
+
+whitelist_externals =
+    mkdir
+
+[testenv:coverage-report]
+basepython = python2.7
+deps = coverage
+
+setenv =
+    COVERAGE_FILE=.coverage
+
+skip_install = true
+
+commands =
+    coverage erase
+    coverage combine
+    coverage report
+    coverage html
+    coverage xml
+
+[testenv:flake8]
+basepython = python2.7
+skip_install = true
+
+deps =
+    flake8
+    flake8-html
+    flake8-coding
+    flake8-debugger
+    flake8-deprecated
+    flake8-isort
+    flake8-pep3101
+    flake8-plone-hasattr
+    flake8-polyfill
+    flake8-print
+    flake8-quotes
+    flake8-string-format
+    flake8-todo
+
+commands =
+    mkdir -p {toxinidir}/reports/flake8
+    - flake8 --format=html --htmldir={toxinidir}/reports/flake8 src setup.py
+    flake8 src setup.py
+
+whitelist_externals =
+    mkdir
+
+[testenv:isort]
+basepython = python2.7
+skip_install = true
+
+deps =
+    isort
+
+commands =
+    isort --check-only --recursive {toxinidir}/src
+
+[testenv:isort-apply]
+basepython = python2.7
+skip_install = true
+
+deps =
+    isort
+
+commands =
+    isort --apply --recursive {toxinidir}/src
+
+
+[testenv:docs]
+basepython = python2.7
+skip_install = false
+
+deps =
+    Sphinx
+
+commands =
+    sphinx-build -b html -d _build/docs/doctrees docs _build/docs/html



------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot