Package: edk2-pytool-library
Tianocore Edk2 PyTool Library (edk2toollib)This is a Tianocore maintained project consisting of a python library supporting
UEFI firmware development.  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.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.Supported VersionsHost TypeToolchainStatusWindows-LatestPython 3.10Windows-LatestPython 3.11Windows-LatestPython 3.12Ubuntu-LatestPython 3.10Ubuntu-LatestPython 3.11Ubuntu-LatestPython 3.12MacOS-LatestPython 3.10MacOS-LatestPython 3.11MacOS-LatestPython 3.12Current ReleaseAll release information is now tracked with Githubtags,releasesandmilestones.ContentThe package contains classes and modules that can be used as the building blocks
of tools that are relevant to UEFI firmware developers.  These modules should
attempt to provide generic support and avoid tightly coupling with specific use
cases.  It is expected these modules do not provide direct interaction with the
user (through command line interfaces) but instead are intended to be wrapped in
other scripts/tools which contains the specific usage and interface.Examples:File parsers for edk2 specific file types.  These parse the file and provide
an object for interacting with the content.UEFI specific services for encoding/decoding binary structures.UEFI defined values and interfaces for usage in pythonPython wrappers for other system cli tools ( signtool, catalog file
generation, inf file generation, etc)Python utilities to provide consistent logging, command invocation, path
resolution, etcLicenseAll 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-libraryTo use in your python codefromedk2toollib.<module>import<class>HistoryThis library and functionality was ported from Project Mu. For history and
documentation prior to this see the original Project Mu projecthttps://github.com/microsoft/mu_pip_python_libraryContribution 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-libraryPR 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.DocumentationUsers and ConsumersDocumentation for the most recent release of edk2-pytool-library is hosted ontianocore.org/edk2-pytool-library.
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 serveContributorsContributor documentation is located atdocs/contributor/and contains instructions for:Setting up a development and testing environmentHow edk2pytools is versioned and publishedContributing to the edk2-pytool-extensions repository