Modernize project #188
Modernize project #188
Conversation
bbannier
force-pushed
the
topic/bbannier/modernize
branch
from
2f9be6a to
66dfbf3
Compare
We previously used a mix of `setup.py` and `setup.cfg` which are not well supported by more modern Python developer tools which instead prefer `pyproject.toml`. This meant that developing this project required manually setting up and managing virtualenvs. With this patch we now move most of our configuration over into `pyproject.toml` so especially dev environments can be managed with tools like Hatch[^1] or Rye[^2]. Dev envs managed by these tools are automaticallt discovered by many editors so there is potentially less need to even think about virtualenvs. Now `setup.py` contains the absolute minimum required settings. We still need to keep dynamically generating the package version from the Zeek-style `VERSION` file, and also need to add a tweak to make sure it is distributed in wheels so the installation code reading it has access to it. Since settings in `setup.cfg` can conflict with `pyproject.toml` we delete the file after either moving all setttings to `pyproject.toml` or to tool specific files (flake8 still does not support `pyproject.toml`). For now we keep `requirements.txt` (which updated versions) so we can install dev dependencies, e.g., for RTD. Unfortunately dev dependencies in `pyproject.toml` are still not standardized[^3]. [^1]: hatch.pypa.io [^2]: https://rye-up.com/ [^3]: https://discuss.python.org/t/development-dependencies-in-pyproject-toml/26149
bbannier
force-pushed
the
topic/bbannier/modernize
branch
from
66dfbf3 to
c95a823
Compare
|
|
||
| [project.optional-dependencies] | ||
| dev = [ | ||
| "btest>=1.1", |
There was a problem hiding this comment.
The change to move btest from the default dependencies into a dev dependency should be the only potentially controversial change here. This should not be an issue for users who get their zkg via Zeek since it also ships btest; users who install zkg via e.g., pipx will not get btest since when installing zkg pipx would only create a link for zkg, not for scripts from dependencies. This leaves users who install directly (e.g., via pip) as the only ones potentially affected (but I would argue they by using such a low-level approach they already decided that they'd want maximum control).
I discussed this out-of-band with @timwoj and he agreed that dropping btest as a dep didn't seem unreasonable to him. The only potential issue could be that we currently do not publish release notes for zkg so it is unclear where to call this out (if at all).
This PR contains a number of cleanups of the project.
setup.pytopyproject.toml: with this one can use modern tools like e.g., rye or hatch to manage dev setups for this projectruff/ruff-format: we have already done this for a number of other projectsruffcould also fix most of them automatically). This list could be expanded, but I stopped here.