Modernize project setup #187
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
commented
Apr 11, 2024
| email = "info@zeek.org" | ||
|
|
||
| [project.scripts] | ||
| zkg = "zkg:main" |
There was a problem hiding this comment.
Turns out this breaks functionality of this script.
|
Superseded by #188. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This moves most project configuration into
pyproject.tomlto work better with more modern setups (I checked withryewhere an env managed withrye syncis automatically discovered for the editor integrations I am using).I added a couple commits in the end to include files previously excluded from pre-commit hooks in linting.