Modernization proposal #1
Open
+73
−52
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
Introduction of src-layout Replaced `setup.py` with `pyproject.toml` (including all dynamic parts) Fix package `__init__.py` import to work properly in src-layout Fix test import to assume an installed local version of the module Add `build` dependency for local building Add package README.md to root README.md Breaking changes: Running tests requires installing the package locally. While this is an additional (potentially annoying) step, it ensures we're testing exactly the package as it will be delivered to users. Warning: Automatic dicovery of modules is a BETA-feature of `pyproject.toml`. https://setuptools.pypa.io/en/latest/userguide/package_discovery.html
|
PS: Thank you for doing these videos. Your content is great. |
NRCgg
reviewed
Mar 5, 2023
|
I just noticed, that I forgot to include instructions on how to test now. Here is handy one-liner to do the following:
Windows: python -m venv env; ./env/Scripts/activate; pip install .[dev]; python -m pytest tests/Linux: python -m venv env && source ./env/bin/activate && pip install .[dev] && python -m pytest tests/ |
|
Thanks for the suggestions! I'll won't merge this pull request so that the code still matches the video, but I'll take a look at these ideas for future code examples. In any case I'm going to move to a toml file for my future code examples as I'm now also integrating Poetry in my own workflow. |
|
My only suggestion is to change code snippet formatting from bold to code in all |
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.
Greetings,
this PR showcases a more strict following of a
srclayout and a modernization of the used tooling. This setup works for a flat-layout as well. While technically this is a PR, I'm aware and agree that too much is going on in here. But I felt creating a bunch of different PRs wouldn't serve the purpose of a bundled communication about the topic.Motivation
The usage of a
setup.pyfile is deprecated sincesetuptools>58.2.0andsetup.cfgwill be too. Therefore when setting up a new project it would be more future proof to use apyproject.tomlfile instead.Changes
setup.pywithpyproject.toml(including all dynamic parts)__init__.pyimport to work properly in src-layoutbuilddependency todevoptional dependencies for local building. E.g.python -m build .will build your wheel and tar.gz files. The usage ofbuildis encouraged[1][2].Breaking changes:
Running tests requires installing the package locally.
While this is an additional (potentially annoying) step,
it ensures we're testing exactly the package as it will be
delivered to users.
Warning:
Automatic discovery of modules is a BETA-feature of
pyproject.toml.https://setuptools.pypa.io/en/latest/userguide/package_discovery.html