René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Deprecated setuptools features are used","articleBody":"This project currently uses deprecated features of `setuptools`, some of which may be removed in the future.\r\n\r\n- **Installing by running `setup.py` directly**, as the instructions in `README.md` say to do and as is done in `test_installation`, is deprecated. Actual breakage due to this begins in Python 3.12, where although `setuptools` is still supported as a build backend and nontrivial logic can still be used in `setup.py`, global and virtual environments do not automatically have the `setuptools` package. (See the `ensurepip` item in the [list of removals in 3.12](https://docs.python.org/3.12/whatsnew/3.12.html#removed).) This is the cause of #1640. But the deprecation is not new as of Python 3.12. The following message appears during installation (with any Python version provided the installed `setuptools` version is not very old, but I used Python 3.11.5):\r\n\r\n  ```text\r\n  /home/ek/repos-wsl/GitPython/.venv/lib/python3.11/site-packages/setuptools/_distutils/cmd.py:66: SetuptoolsDeprecationWarning: setup.py install is deprecated.\r\n  !!\r\n  \r\n          ********************************************************************************\r\n          Please avoid running ``setup.py`` directly.\r\n          Instead, use pypa/build, pypa/installer or other\r\n          standards-based tools.\r\n  \r\n          See https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html for details.\r\n          ********************************************************************************\r\n  \r\n  !!\r\n  ```\r\n\r\n  This could be worked around without a fix by adding `setuptools` as a development dependency, but an actual fix is straightforward, and there are some further benefits to using `pip install .` to install locally, including that `-e` can easily be passed to make the installation editable.\r\n\r\n- **Building by running `setup.py` directly** is, if I understand correctly, also deprecated. This is a less serious problem, but a true fix for this is also straightforward: the `build` module can be added as a development dependency and used for building the sdist and wheel in `Makefile`. The `setuptools` documentation [recommends using `build`](https://setuptools.pypa.io/en/latest/userguide/quickstart.html).\r\n\r\n- **The `tests_require` keyword argument** is deprecated and intended for removal in a future version of `setuptools`, as noted in the [`setuptools.setup` keyword arguments documentation](https://setuptools.pypa.io/en/latest/references/keywords.html).\r\n\r\n  This is already not achieving what appears intended or least hoped for (see #1652), and one reasonable way to fix this is to remove that argument altogether. But both the reliance on a deprecated feature and the absence of an automated way to install test dependencies as a group (without `pip install -r` commands) could be remedied by using a `test` *extra* rather than `tests_require`.\r\n\r\nAlthough I worry a bit about broad scope, it seems to me that it is natural to fix #1640, #1651, #1652, and this issue (which itself overlaps with #1640 and #1652, though is not limited to them) in a single pull request. I say this because there is significant overlap in the changes, and because decisions made in review should probably take the considerations of all these issues into account. I've opened #1654 for this.\r\n\r\nNote that while it is today discouraged to implement nontrivial logic in `setup.py`, and recommended to use `pyproject.toml` and/or `setup.cfg` for what has traditionally been done in `setup.py`, *I do not believe it is deprecated to make nontrivial use of `setup.py` as this project does*. Although it would be beneficial to define build and installation rules declaratively, I think that would be a much bigger change than needed to fix this issue. I have not attempted to do anything like that at this time.","author":{"url":"https://github.com/EliahKagan","@type":"Person","name":"EliahKagan"},"datePublished":"2023-09-10T18:40:32.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/1653/GitPython/issues/1653"}