dist/tools/bmp: in-line dependencies using PEP 723 #21131
+18
−3
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
github-actions
bot
added
Area: doc
|
While I like the idea of getting rid of separate |
|
I think we can just drop the |
|
Yes, the As a Python developer, I would be fine with it. |
|
OK, if t here is an actual benefit of keeping the |
maribu
approved these changes
Feb 2, 2025
PEP 723 is an accepted proposal to in-line script metadata. One such
use cases is to put script dependencies inside the script, which makes
the requirements.txt redundant [1].
With the correct shebang, it becomes even possible to run the script
directly, without creating a virtual environment and installing
dependencies in advance.
Combining both makes the execution of single-file scripts within RIOT
much easier and friendlier.
PEP 723 metadata can be used by `pipx` [2] and can be easily
installed when `pip` is available.
[1] `pip install` still requires a requirements.txt, which is
generally accepted during development. An open issue exists to
add support for reading dependencies from PEP 723 as well. See
pypa/pip#12891
[2] https://github.com/pypa/pipx
|
@mguetschow I have added a comment to the |
maribu
added
the
CI: ready for build
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.
Contribution description
PEP 723 is an accepted proposal to in-line script metadata. One such use cases is to list script dependencies inside the script, which makes the
requirements.txtredundant.With the correct shebang, it becomes even possible to run the script directly, without creating a virtual environment and installing dependencies in advance. Combining both makes the execution of single-file scripts within RIOT much easier and friendlier.
PEP 723 metadata can be used by
pipxand can be easily installed whenpipis available. It is maintained by the PyPA, just likepip.I chose this file to start with, but there are at least five more scripts with
requirements.txtthat could benefit from the same change. Becausepip installstill requires arequirements.txtfile, which is generally accepted during development, I kept both for now. Aan open issue exists to add support for reading dependencies from PEP 723, which might make it superfluous in the future.Testing procedure
Ensure that
pipxis installed.Alternatively, execute it from the
dist/tools/bmpfolder.This script is part of the Black Magic Debugger. Execute it from the
dist/tools/bmpfolder, or compile any application and usePROGRAMMER=bmpto execute it from the build process.Issues/PRs references
None