Tianocore Edk2 Python BaseTools (edk2basetools)
This is a Tianocore maintained project consisting of a the python source files that make up EDK2 basetools. This package's intent is to provide an easy way to organize and share python code to facilitate reuse across environments, tools, and scripts. Inclusion of this package and dependency management is best managed using Pip/Pypi.
Current Release
A minor release occurs for each merged Pull Request, which can be tracked via commits or closed pull requests.
Content
The package contains all python source files necessary to build an EDK2 project. This is a fundamental package and is required for edk2 builds. These tools are typically called by the build system, however each is independently callable.
Examples:
- Build.py
- Split.py
- Trim.py
- AmlToC.py
License
All content in this repository is licensed under BSD-2-Clause Plus Patent License.
Usage
NOTE: It is strongly recommended that you use python virtual environments. Virtual environments avoid changing the global python workspace and causing conflicting dependencies. Virtual environments are lightweight and easy to use. Learn more
- To install run
pip install --upgrade edk2-basetools - To use in your python code
Building with edk2-pytool-extensions
To perform a build using edk2-pytool-extensions invocables, add the pipbuild-win or pipbuild-unix scope to the platform build file.
Building with edk2
Follow the normal build process; it will automatically detect and use edk2-basetools pip module if available.
Custom
BaseTools/BinPipWrappers/WindowsLike or BaseTools/BinPipWrappers/PosixLike path must be set instead of BaseTools/BinWrappers/WindowsLike or BaseTools/BinWrappers/UnixLike
Contribution Process
This project welcomes all types of contributions. For issues, bugs, and questions it is best to open a github issue.
Code Contributions
For code contributions this project leverages github pull requests. See github tutorials, help, and documentation for complete descriptions. For best success please follow the below process.
- Contributor opens an issue describing problem or new desired functionality
- Contributor forks repository in github
- Contributor creates branch for work in their fork
- Contributor makes code changes, writes relevant unit tests, authors documentation and release notes as necessary.
- Contributor runs tests locally
- Contributor submits PR to master branch of tianocore/edk2-basetools
- PR reviewers will provide feedback on change. If any modifications are required, contributor will make changes and push updates.
- PR automation will run and validate tests pass
- If all comments resolved, maintainers approved, and tests pass the PR will be squash merged and closed by the maintainers.
Maintainers
Liming Gao gaoliming@byosoft.com.cn Rebecca Cran rebecca@bsdio.com
Developers/Reviewers
See the github team for more details.
Documentation
See the github repo docs folder
Release files for edk2-basetools 0.1.53
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| edk2_basetools-0.1.53.tar.gz | 1.2 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| edk2_basetools-0.1.53-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.5 MB
Release files / edk2_basetools-0.1.53.tar.gz
| Download URL | edk2_basetools-0.1.53.tar.gz |
|---|---|
| Size | 1.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ec1847657a2b0fa689f8616cfffba9125ff3b6154404c2931a16bca007ec486d
|
|
BLAKE2b-256 checksum How to use checksums |
5c1328aa652544985b468bf341de42c1b40ba16ecdcc024fb4c882b0714b67d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.11
|
Release files / edk2_basetools-0.1.53-py3-none-any.whl
| Download URL | edk2_basetools-0.1.53-py3-none-any.whl |
|---|---|
| Size | 1.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a3215349e4f059e2c2df848d2a16e95d86af6d15137030123fcacb4b9cbe2419
|
|
BLAKE2b-256 checksum How to use checksums |
ab713d0e9d47822eb9121773fb6447f15ca0f128bb256816cad39d6611aaae45
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.11
|
Security for edk2-basetools 0.1.53
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
