Skip to content

Commit

Permalink
Merge branch 'hotfix/1.5.2'
Browse files Browse the repository at this point in the history
  • Loading branch information
glennmatthews committed Jun 17, 2016
2 parents 6c526e3 + ff4e050 commit f01b866
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 18 deletions.
17 changes: 17 additions & 0 deletions CHANGELOG.rst
Expand Up @@ -3,6 +3,17 @@ Change Log
All notable changes to the COT project will be documented in this file.
This project adheres to `Semantic Versioning`_.

`1.5.2`_ - 2016-06-17
---------------------

**Changed**

- Development requirement changes: The package `pep8`_ has been renamed to
`pycodestyle`_, and `pep257`_ has been renamed to `pydocstyle`_. Updated
configuration and documentation to reflect these changes. Also,
`flake8-pep257`_ does not presently handle these changes, so replaced it
as a dependency with the more up-to-date `flake8-docstrings`_ package.

`1.5.1`_ - 2016-06-07
---------------------

Expand Down Expand Up @@ -407,6 +418,7 @@ Initial public release.

.. _pyVmomi: https://pypi.python.org/pypi/pyvmomi/
.. _flake8: http://flake8.readthedocs.org/en/latest/
.. _pep8: https://pypi.python.org/pypi/pep8
.. _pep257: https://pypi.python.org/pypi/pep257
.. _requests: http://python-requests.org/
.. _tox: http://tox.readthedocs.org/en/latest/
Expand All @@ -417,8 +429,13 @@ Initial public release.
.. _versioneer: https://github.com/warner/python-versioneer
.. _pip: https://pip.pypa.io/en/stable/
.. _argcomplete: https://argcomplete.readthedocs.io/en/latest/
.. _`flake8-pep257`: https://pypi.python.org/pypi/flake8-pep257
.. _pycodestyle: https://pypi.python.org/pypi/pycodestyle
.. _pydocstyle: https://pypi.python.org/pypi/pydocstyle
.. _`flake8-docstrings`: https://pypi.python.org/pypi/flake8-docstrings

.. _Unreleased: https://github.com/glennmatthews/cot/compare/master...develop
.. _1.5.2: https://github.com/glennmatthews/cot/compare/v1.5.1...v1.5.2
.. _1.5.1: https://github.com/glennmatthews/cot/compare/v1.5.0...v1.5.1
.. _1.5.0: https://github.com/glennmatthews/cot/compare/v1.4.2...v1.5.0
.. _1.4.2: https://github.com/glennmatthews/cot/compare/v1.4.1...v1.4.2
Expand Down
13 changes: 7 additions & 6 deletions CONTRIBUTING.rst
Expand Up @@ -38,16 +38,17 @@ Coding style
''''''''''''

We try to keep COT's code base compliant with Python coding standards including
`PEP 8`_ and `PEP 257`_. We use the flake8_ and pep257_ tools to verify this
as part of our test automation. To run coding style analysis independently
of the other test automation, you can run ``tox -e flake8``, or you can
install these tools and run ``flake8`` directly:
`PEP 8`_ and `PEP 257`_. We use the flake8_ tool and its extension packages to
verify this as part of our test automation.
To run coding style analysis independently of the other test automation, you
can run ``tox -e flake8``, or you can install these tools and run ``flake8``
directly:

::

cot/$ sudo pip install --upgrade flake8
cot/$ sudo pip install --upgrade pep257
cot/$ sudo pip install --upgrade flake8-pep257
cot/$ sudo pip install --upgrade pydocstyle
cot/$ sudo pip install --upgrade flake8-docstrings
cot/$ flake8
./COT/tests/ovf.py:180:80: E501 line too long (80 > 79 characters)
./COT/tests/ovf.py:184:77: F841 local variable 'ovf' is assigned to but never used
Expand Down
3 changes: 0 additions & 3 deletions setup.cfg
Expand Up @@ -6,9 +6,6 @@ builder=man
build_dir=COT/docs
config_dir=docs

[pep257]
ignore = D203

[versioneer]
VCS=git
style=pep440
Expand Down
13 changes: 4 additions & 9 deletions tox.ini
Expand Up @@ -3,13 +3,8 @@
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.

[pep8]
exclude = ez_setup.py,.tox,build,docs,.eggs

[pep257]
inherit = false

[flake8]
ignore = E123,E133,E226,E241,E242,D203,D403
exclude = ez_setup.py,.tox,build,docs,.git,__pycache__

[tox]
Expand Down Expand Up @@ -41,9 +36,9 @@ commands =

[testenv:flake8]
deps =
flake8
flake8-pep257>=1.0.4
pep257>=0.7
flake8>=2.6.0
flake8-docstrings>=0.2.8
pydocstyle>=1.0.0
commands = flake8 --verbose

[testenv:docs]
Expand Down

0 comments on commit f01b866

Please sign in to comment.