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.

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

CI Build Status

Host Type & Toolchain	Build Status
Windows_VS2019_
Ubuntu_GCC5_
OvmfPkg_Win_VS2019_
OvmfPkg_Ubuntu_GCC5_

How to use it

As it stands right now, this isn't hosted on PyPi, so it needs to be installed locally.

Clone the repo locally
Run pip install -e . (you might need do this from an admin prompt in windows)
Run edk2_build to make sure it works
Switch to an EDK2 basetools that has the necessary hooks

Right now the only EDK2 that supports this package is https://github.com/matthewfcarlson/edk2/tree/feature/pip-basetools This commit: https://github.com/matthewfcarlson/edk2/commit/40bb4778f5edb380c38233399507d00dd47df80d gives you a good idea of how to enable it for your repo if need to enable it.

Content

The 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 python
Python wrappers for other system cli tools ( signtool, catalog file generation, inf file generation, etc)
Python utilities to provide consistent logging, command invocation, path resolution, etc

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-base

To use in your python code

from edk2basetools.<module> import <class>

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

See the github repo docs folder

License

BobCF/edk2-basetools

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages