Created on 2022-07-14 20:23 by rouilj, last changed 2022-07-14 20:23 by rouilj.
|msg7609||Author: [hidden] (rouilj)||Date: 2022-07-14 20:23|
A user installed roundup using: pip install roundup. Then following the request in the install doc to change to the source directory and run pytest, he went to the installation directory and ran pytest. This failed for a few reasons: 1) he was in the install directory and never had a source directory for comparison. 2) this confusion was enhanced by the presence of a test directory in the install directory to allow people to use pytest in an installed tracker. 3) the install directory has a file called token.py. By running pytest from the install directory token.py masked /usr/lib/python.../token.py causing pytest to crash massively. So a few things here: In the request to run pytest, better define a source directory. Also earlier in the document it says: assumes that you are using the source distribution this needs to be defined better both here and in the Problems? Testing your Python... section. Also adding a statement that the roundup source directory does not include the file token.py or some other way to prevent the confusion would be helpful for new users. I don't think renaming token.py is needed, nor to rename the test directory. Doing the first would have prevented pytest from crashing before it started a test. Doing the second (along with the first) would have resulted in pytest reporting there was no test directory. I think either one of these would have resulted in a confused user and an email as the primary failure was the misunderstanding about where the tests can be run.