From 8d1bb24e24bea1da91aa8e1509c0396ced3e20bc Mon Sep 17 00:00:00 2001 From: SampoPaukkonen Date: Thu, 5 Sep 2019 13:32:19 +0300 Subject: [PATCH] [#6] Add links to contributing README Added links to contributing README, added CONTRIBUTING.rst file, pinned dependencies for python 2 --- CHANGES.rst | 9 +++++++++ CONTRIBUTING.rst | 7 +++++++ README.rst | 21 ++++++++++++++++++-- src/crl/examplelib/_version.py | 2 +- tox.ini | 35 +++++++++++++++++++++++++++------- 5 files changed, 64 insertions(+), 10 deletions(-) create mode 100644 CONTRIBUTING.rst diff --git a/CHANGES.rst b/CHANGES.rst index c87026d..e7223ef 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -3,6 +3,15 @@ CHANGES ======= +1.1.4 +----- + +- Added links to contributing in README + +- Added CONTRIBUTING.rst file + +- Pinned dependencies for python 2 + 1.1.3 ----- diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..fc5f62a --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,7 @@ +Contributing +------------ + +The development and the testing follows the Common Robot Libraries development +practices defined in crl-devutils_. + +.. _crl-devutils: http://crl-devutils.readthedocs.io/ diff --git a/README.rst b/README.rst index 5e562a0..db7e125 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,9 @@ .. image:: https://travis-ci.org/nokia/crl-examplelib.svg?branch=master :target: https://travis-ci.org/nokia/crl-examplelib +README +====== + Example for Common Robot Library -------------------------------- @@ -16,9 +19,9 @@ demonstrating acceptance test capability. Documentation ------------- -Documentation for crl.examplelib can be found from `Read The Docs`_ +Documentation for crl.examplelib can be found from `Read the Docs`_ -.. _Read The Docs: http://crlexamplelib.readthedocs.io/ +.. _Read the Docs: http://crlexamplelib.readthedocs.io/ Development practices @@ -26,3 +29,17 @@ Development practices The development and the testing follows the Common Robot Libraries development practices defined in https://github.com/nokia/crl-devutils. + +Contributing +------------ + +Please see contributing_ for development and contribution practises. + +The code_ and the issues_ are hosted on GitHub. + +The project is licensed under BSD-3-Clause_. + +.. _contributing: https://github.com/nokia/crl-examplelib/blob/master/CONTRIBUTING.rst +.. _code: https://github.com/nokia/crl-examplelib +.. _issues: https://github.com/nokia/crl-examplelib/issues +.. _BSD-3-Clause: https://github.com/nokia/crl-examplelib/blob/master/LICENSE diff --git a/src/crl/examplelib/_version.py b/src/crl/examplelib/_version.py index c318d0d..6337c98 100644 --- a/src/crl/examplelib/_version.py +++ b/src/crl/examplelib/_version.py @@ -1,5 +1,5 @@ __copyright__ = 'Copyright (C) 2019, Nokia' -VERSION = '1.1.3' +VERSION = '1.1.4' GITHASH = '' diff --git a/tox.ini b/tox.ini index 579842d..160c371 100644 --- a/tox.ini +++ b/tox.ini @@ -3,6 +3,23 @@ [tox] envlist = py27, py36, pylint +[base] +deps = + mock + pytest-cov + pytest-flake8 + +[base2] +deps = + {[base]deps} + pytest < 4.6 + more-itertools <= 5.0.0 + +[base3] +deps = + {[base]deps} + pytest + [testenv] setenv = COVERAGE_FILE = .coverage{envname} @@ -13,27 +30,31 @@ commands = {posargs:py.test \ --cov-config {toxinidir}/.coveragerc \ --cov={envsitepackagesdir}/crl/examplelib \ {envsitepackagesdir}/crl/examplelib {toxinidir}/tests} + deps = - mock - pytest - pytest-cov - pytest-flakes - pytest-pep8 + py27: {[base2]deps} + py36: {[base3]deps} [pytest] -addopts = --pep8 --flakes --cov-report xml +addopts = --flake8 --cov-report xml flakes-ignore = test_*.py UnusedImport test_*.py RedefinedWhileUnused norecursedirs = bin lib include [testenv:pylint] +basepython = python2.7 deps = pylint < 2.0 - {[testenv]deps} commands = pylint {posargs: --rcfile={toxinidir}/.pylintrc \ {toxinidir}/src/crl {toxinidir}/tests } +[testenv:pylint3] +basepython = python3.7 +deps = + pylint +commands = {[testenv:pylint]commands} + [testenv:docs] changedir = {toxinidir} deps=