Package: edk2-pytool-extensions
Tianocore Edk2 PyTool Extensions (edk2toolext)Getting Started? Check out our documentation athttps://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 StatusThe 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 TypeToolchainProjectIntegration TestsWindows Server 2019Python 3.10Edk2Windows Server 2019Python 3.11Edk2Windows Server 2019Python 3.12Edk2Linux Ubuntu 20.04Python 3.10Edk2Linux Ubuntu 20.04Python 3.11Edk2Linux Ubuntu 20.04Python 3.12Edk2Windows Server 2022Python 3.10Project MuWindows Server 2022Python 3.11Project MuWindows Server 2022Python 3.12Project MuLinux Ubuntu 22.04Python 3.10Project MuLinux Ubuntu 22.04Python 3.11Project MuLinux Ubuntu 22.04Python 3.12Project MuCurrent ReleaseAll release information is now tracked with Githubtags,releasesandmilestones.ContentThe 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 pluginBinary dependency resolution (nuget, urls, git repos)Loggers (file, memory, and colored console)Plugins (pre/post build, function injection)Wrapper around edk2 buildVarDict and ShellEnvrionment to manage key/value pairs consistently across
entire processNuget Publishing tool to push new packagesOmnicache - Support a super cache of git repos to speed up creating and
updating multiple work spaces and minimizing filesystem impactLicenseAll content in this repository is licensed underBSD-2-Clause Plus Patent
License.UsageNOTE: 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 moreTo install runpip install --upgrade edk2-pytool-extensionsTo use in your python codefromedk2toolext.<module>import<class>HistoryThis project and functionality was ported from Project Mu. For history and
documentation prior to this see the original Project Mu projectshttps://github.com/microsoft/mu_pip_environmentandhttps://github.com/microsoft/mu_pip_buildContribution ProcessThis project welcomes all types of contributions. For issues, bugs, and
questions it is best to open agithub
issue.Code ContributionsFor 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 functionalityContributor forks repository in githubContributor creates branch for work in their forkContributor makes code changes, writes relevant unit tests, authors
documentation and release notes as necessary.Contributor runs tests locallyContributor submits PR to master branch of tianocore/edk2-pytool-extensionsPR 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 passIf all comments resolved, maintainers approved, and tests pass the PR
will be squash merged and closed by the maintainers.MaintainersSee thegithub
teamfor more
details.DocumentationDocumentation for the most recent release of edk2-pytool-extensions is hosted ontianocore.org/edk2-pytool-extensions.
Raw documentation is located in thedocs/folder and is split into two
separate categories. The first is located atdocs/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 serveThe second is located atdocs/contributor/and is documentation for
contributing to the edk2-pytool-extensions repository.