edk2-pytool-extensions

Tianocore Edk2 PyTool Extensions (edk2toolext)

Getting Started? Check out our documentation at https://www.tianocore.org/edk2-pytool-extensions!

This is a Tianocore maintained project consisting of command line and other python tools and extensions for building and maintaining an Edk2 based UEFI firmware code tree. Part of these tools include "invocables" that can be used to build EDK2 Platforms and these tools are known as "stuart". This package's intent is to provide tools, scripts, and a plugin based environment for use within the tools and scripts. This environment has command line interfaces to support building a product, building CI, running tests, and downloading dependencies. This environment also provides the building blocks for developers to write their own tools to launch in the environment and leverage the capabilities provided by the environment. The unique capabilities provided help support building products with multiple repositories and having each repository contribute/plugin to the build process in a scalable way. The environment will scan the files in the code tree (multiple repos) and discover plugins, dependencies, path adjustments, environment variable settings, etc. This provides easy methods for common repositories to share build tools/steps.

Inclusion of this package is best managed using Pip/Pypi. This package makes use of edk2-pytool-library.

This is a supplemental package and is not required to be used for edk2 builds.

Current Status

The code coverage and CI badges represent unit test status and the code coverage of those unit tests. We require 100% unit test success (Hence the pass / fail) and that code coverage percentage does not lower.

Host Type	Toolchain	Project	Integration Tests
Windows Server 2019	Python 3.11	Edk2
Windows Server 2019	Python 3.12	Edk2
Windows Server 2019	Python 3.13	Edk2
Linux Ubuntu 20.04	Python 3.11	Edk2
Linux Ubuntu 20.04	Python 3.12	Edk2
Linux Ubuntu 20.04	Python 3.13	Edk2
Windows Server 2022	Python 3.11	Project Mu
Windows Server 2022	Python 3.12	Project Mu
Windows Server 2022	Python 3.13	Project Mu
Linux Ubuntu 22.04	Python 3.11	Project Mu
Linux Ubuntu 22.04	Python 3.12	Project Mu
Linux Ubuntu 22.04	Python 3.13	Project Mu

Current Release

All release information is now tracked with Github tags, releases and milestones.

Content

The package contains cli tools and a basic common environment for running tools. This common environment supports extensions, sub-classing, and plugin to allow great flexibility for building and maintaining a code tree.

Examples:

• CI build support with plugin
• Binary dependency resolution (nuget, urls, git repos)
• Loggers (file, memory, and colored console)
• Plugins (pre/post build, function injection)
• Wrapper around edk2 build
• VarDict and ShellEnvrionment to manage key/value pairs consistently across entire process
• Nuget Publishing tool to push new packages
• Omnicache - Support a super cache of git repos to speed up creating and updating multiple work spaces and minimizing filesystem impact

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-pytool-extensions

• To use in your python code

  from edk2toolext.<module> import <class>
  

History

This project and functionality was ported from Project Mu. For history and documentation prior to this see the original Project Mu projects https://github.com/microsoft/mu_pip_environment and https://github.com/microsoft/mu_pip_build

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-pytool-extensions
   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

See the github team for more details.

Documentation for maintainers on how to publish a release can be found here

Documentation

Documentation for the most recent release of edk2-pytool-extensions is hosted on tianocore.org/edk2-pytool-extensions. Raw documentation is located in the docs/ folder and is split into two separate categories. The first is located at docs/user/ and is documentation and API references for those that are using this package in their own project. Users can generate a local copy of the documentation by executing the following command from the root of the project:

pip install --upgrade -e .[docs]
mkdocs serve

The second is located at docs/contributor/ and is documentation for contributing to the edk2-pytool-extensions repository.