PR#415: Fix dev docs - testcloud dependency - taskotron/libtaskotron

taskotron / libtaskotron

#415 Fix dev docs - testcloud dependency

Closed 5 years ago by jskladan. Opened 5 years ago by jskladan.

feature/fixdocs into develop

Fix dev docs - testcloud can not be installed from pip

Josef Skladanka • 5 years ago

6ccede6

docs/source/devguide.rst

file modified

+4 -6

		`@@ -59,7 +59,8 @@`
		`python2-virtualenv \`
		`python3-virtualenv \`
		`rpm-build \`
		`- rsync`
		`+ rsync \`
		`+ testcloud`

		`If you have not yet cloned the repository, do it now::`

		`@@ -138,11 +139,8 @@`

		`tox`

		`- Another way is to have the virtualenv active and run::`
		`-`
		`- py.test`
		`-`
		`- but this only runs the tests for the particular Python interpreter.`
		`+ The testsuite is seamlessly executed in both Python 2.7 and 3.6 environments,`
		+ as defined in ``tox.ini``.

		A nice HTML-based representation is available if you add ``--cov-report=html``
		`command line parameter.`

requirements.txt

file modified

-3

		`@@ -21,9 +21,6 @@`
		`python-fedora >= 0.8.0`
		`munch >= 2.0.2`

		`- # libtaskotron-disposable`
		`- testcloud >= 0.1.15`
		`-`
		`# Test suite requirements`
		`mock >= 2.0.0`
		`pytest >= 2.7.3`

jskladan commented 5 years ago

The current docs imply that testcloud can/should be installed from pip. This is currently not a viable option (and maybe never was an option in the first place).
Testcloud is added to the list of packages required to be installed in the system, and removed from requirements.txt

rebased onto 9e388c8

5 years ago

kparal commented on line 22 of docs/source/devguide.rst 5 years ago

I wanted to specifically avoid this statement. I think we've reached the point where having python3 packages installed is mandatory, so that people always run the test suite against python3 when creating patches. That's why I included all the packages in one big list.

Also, what exactly do you mean by libtaskotron not being Python3 compatible? It hasn't been thoroughly tested, no, so it's by no means an official support, but the library can be imported under py3 and the test suite runs fine.

kparal commented 5 years ago

Otherwise than my intention to keep all deps in one big list, py2+py3, because that's what we want to develop against at the moment, the patch is obviously fine. Thanks for figuring that out.

Edited 5 years ago by kparal

jskladan commented on line 22 of docs/source/devguide.rst 5 years ago

Including a mixed list of python2 and python3 packages does nothing to make people "lways run the test suite against python3 when creating patches", nor does the development guide say so. Last time I checked, libtaskotron failed terribly with Python 3, glad to hear this is not the case any more.

rebased onto cfbc159

5 years ago

rebased onto 6ccede6

5 years ago

jskladan commented 5 years ago

Changed the language about python3, to make the intent of "developing for both py2 and py3" more clear.

jskladan commented 5 years ago

merged via 5ade646

Pull-Request has been closed by jskladan

5 years ago