René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Readme claims test dependencies are installed automatically","articleBody":"`README.md` says:\r\n\r\n\u003e The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`. The installer takes care of installing them for you.\r\n\r\nThat is not accurate, because while dependencies listed in `test-requirements.txt` are included in the list passed as `tests_require` in `setup.py`, this does not actually cause them to be installed. As `README.md` later notes, they currently have to be installed with a command like `pip install -r test-requirements.txt`. That makes the above text in the readme misleading, because this is *not* the case for `requirements.txt` dependencies, which do not have to be installed manually.\r\n\r\n(Two related things: The CI workflows currently must install from `requirements.txt` explicitly because they do not install the project itself. The `test_installation` unit test installs from `requirements.txt` before installing the project itself, which should probably not be done, because this makes it so that test would not fail if installing GitPython failed to entail installation of its dependencies, which could arise as a regression in a change to `setup.py`.)\r\n\r\nThere are at least three distinct ways this documentation bug could be fixed:\r\n\r\n- Remove the claim that the installer takes care of this, while making no other changes.\r\n- Remove the claim that the installer takes care of this, and remove the `test_require` keyword argument from the `setup` call in `setup.py`.\r\n- Use an extra instead of `tests_require` so that there really is a way to install the package such that not only are the test dependencies downloaded but they are also installed automatically in the environment in which GitPython and its regular dependencies are installed. This has the substantial disadvantage that it is somewhat unintuitive to have an extra providing dependencies for functionality that is not itself part of the package people download from PyPI. But it would have the the advantage that it would fully achieve what appears to be intended or at least aspired to and that, depending on what other changes are being made, it might make the dependency installation procedure faster and simpler.\r\n\r\nI've opened #1654, which fixes this as well as some other issues. I took the approach of making a `test` extra, but as noted in the PR description, that can be changed, including to either of the other two approaches I've suggested here.","author":{"url":"https://github.com/EliahKagan","@type":"Person","name":"EliahKagan"},"datePublished":"2023-09-10T18:31:54.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/1652/GitPython/issues/1652"}