Skip to main content

Python BaseTools supporting UEFI EDK2 firmware development

Project description

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

PyPI

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.

PyPI - 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.

  1. Contributor opens an issue describing problem or new desired functionality
  2. Contributor forks repository in github
  3. Contributor creates branch for work in their fork
  4. Contributor makes code changes, writes relevant unit tests, authors documentation and release notes as necessary.
  5. Contributor runs tests locally
  6. Contributor submits PR to master branch of tianocore/edk2-basetools
    1. PR reviewers will provide feedback on change. If any modifications are required, contributor will make changes and push updates.
    2. PR automation will run and validate tests pass
    3. 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

edk2_basetools-0.1.53.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

edk2_basetools-0.1.53-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file edk2_basetools-0.1.53.tar.gz.

File metadata

  • Download URL: edk2_basetools-0.1.53.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.11

File hashes

Hashes for edk2_basetools-0.1.53.tar.gz
Algorithm Hash digest
SHA256 ec1847657a2b0fa689f8616cfffba9125ff3b6154404c2931a16bca007ec486d
MD5 5d02b31c3c1fad7a24009220bdf248ed
BLAKE2b-256 5c1328aa652544985b468bf341de42c1b40ba16ecdcc024fb4c882b0714b67d3

See more details on using hashes here.

File details

Details for the file edk2_basetools-0.1.53-py3-none-any.whl.

File metadata

File hashes

Hashes for edk2_basetools-0.1.53-py3-none-any.whl
Algorithm Hash digest
SHA256 a3215349e4f059e2c2df848d2a16e95d86af6d15137030123fcacb4b9cbe2419
MD5 78f4a16504544fecd18fdca8fa3200cf
BLAKE2b-256 ab713d0e9d47822eb9121773fb6447f15ca0f128bb256816cad39d6611aaae45

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page