{"id":13798042,"url":"https://github.com/tianocore/edk2-pytool-library","last_synced_at":"2025-05-13T05:31:31.900Z","repository":{"id":34983864,"uuid":"189661442","full_name":"tianocore/edk2-pytool-library","owner":"tianocore","description":"Python library package that supports UEFI development","archived":false,"fork":false,"pushed_at":"2025-05-09T15:02:34.000Z","size":1439,"stargazers_count":58,"open_issues_count":11,"forks_count":49,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-09T16:22:40.983Z","etag":null,"topics":["edk2","python","pytools"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tianocore.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-05-31T21:38:03.000Z","updated_at":"2025-05-09T15:02:37.000Z","dependencies_parsed_at":"2023-12-18T17:45:54.501Z","dependency_job_id":"acbe9918-8b53-48e7-a162-326a36833906","html_url":"https://github.com/tianocore/edk2-pytool-library","commit_stats":{"total_commits":180,"total_committers":20,"mean_commits":9.0,"dds":0.7833333333333333,"last_synced_commit":"3d9f52ebde85a531a43e52d941a9cae503c40bf3"},"previous_names":[],"tags_count":78,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tianocore%2Fedk2-pytool-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tianocore%2Fedk2-pytool-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tianocore%2Fedk2-pytool-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tianocore%2Fedk2-pytool-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tianocore","download_url":"https://codeload.github.com/tianocore/edk2-pytool-library/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253883058,"owners_count":21978598,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["edk2","python","pytools"],"created_at":"2024-08-04T00:00:38.194Z","updated_at":"2025-05-13T05:31:31.894Z","avatar_url":"https://github.com/tianocore.png","language":"Python","funding_links":[],"categories":["Development :computer:"],"sub_categories":[],"readme":"# Tianocore Edk2 PyTool Library (edk2toollib)\n\n[![pypi]][_pypi]\n[![codecov]][_codecov]\n[![ci]][_ci]\n[![docs]][_docs]\n\nThis is a Tianocore maintained project consisting of a python library supporting\nUEFI firmware development.  This package's intent is to provide an easy way to\norganize and share python code to facilitate reuse across environments, tools,\nand scripts.  Inclusion of this package and dependency management is best\nmanaged using Pip/Pypi.\n\nThis is a supplemental package and is not required to be used for edk2 builds.\n\n## Current Status\n\n[![codecov]][_codecov]\n[![ci]][_ci]\n\nThe code coverage and CI badges represent unit test status and the code coverage\nof those unit tests. We require 100% unit test success (Hence the pass / fail)\nand that code coverage percentage does not lower.\n\nMaintained Versions\n\n|  Host Type         |  Toolchain    |  Status\n|  :---------------  |  :----------  |  :--------------------\n|  [Windows-Latest]  |  Python 3.11  |  [![ci]][_ci]\n|  [Windows-Latest]  |  Python 3.12  |  [![ci]][_ci]\n|  [Windows-Latest]  |  Python 3.13  |  [![ci]][_ci]\n|  [Ubuntu-Latest]   |  Python 3.11  |  [![ci]][_ci]\n|  [Ubuntu-Latest]   |  Python 3.12  |  [![ci]][_ci]\n|  [Ubuntu-Latest]   |  Python 3.13  |  [![ci]][_ci]\n|  [MacOS-Latest]    |  Python 3.11  |  [![coming_soon]][_ci]\n|  [MacOS-Latest]    |  Python 3.12  |  [![coming_soon]][_ci]\n|  [MacOS-Latest]    |  Python 3.13  |  [![coming_soon]][_ci]\n\nMinimum Supported Version\n\n|  Host Type         |  Toolchain    |  Status\n|  :---------------  |  :----------  |  :--------------------\n|  [Windows-Latest]  |  Python 3.10  |  [![ci]][_ci]\n|  [Ubuntu-Latest]   |  Python 3.10  |  [![ci]][_ci]\n|  [MacOS-Latest]    |  Python 3.10  |  [![coming_soon]][_ci]\n\n### Current Release\n\n[![pypi]][_pypi]\n\nAll release information is now tracked with Github\n [tags](https://github.com/tianocore/edk2-pytool-library/tags),\n [releases](https://github.com/tianocore/edk2-pytool-library/releases) and\n [milestones](https://github.com/tianocore/edk2-pytool-library/milestones).\n\n## Content\n\nThe package contains classes and modules that can be used as the building blocks\nof tools that are relevant to UEFI firmware developers.  These modules should\nattempt to provide generic support and avoid tightly coupling with specific use\ncases.  It is expected these modules do not provide direct interaction with the\nuser (through command line interfaces) but instead are intended to be wrapped in\nother scripts/tools which contains the specific usage and interface.\n\nExamples:\n\n* File parsers for edk2 specific file types.  These parse the file and provide\n  an object for interacting with the content.\n* UEFI specific services for encoding/decoding binary structures.\n* UEFI defined values and interfaces for usage in python\n* Python wrappers for other system cli tools ( signtool, catalog file\n  generation, inf file generation, etc)\n* Python utilities to provide consistent logging, command invocation, path\n  resolution, etc\n\n## License\n\nAll content in this repository is licensed under [BSD-2-Clause Plus Patent\nLicense](license.txt).\n\n[![PyPI -\nLicense](https://img.shields.io/pypi/l/edk2_pytool_library.svg)](https://pypi.org/project/edk2-pytool-library/)\n\n## Usage\n\nNOTE: It is strongly recommended that you use python virtual environments.\nVirtual environments avoid changing the global python workspace and causing\nconflicting dependencies.  Virtual environments are lightweight and easy to use.\n[Learn more](https://docs.python.org/3/library/venv.html)\n\n* To install run `pip install --upgrade edk2-pytool-library`\n* To use in your python code\n\n    ```python\n    from edk2toollib.\u003cmodule\u003e import \u003cclass\u003e\n    ```\n\n## History\n\nThis library and functionality was ported from Project Mu. For history and\ndocumentation prior to this see the original Project Mu project\n\u003chttps://github.com/microsoft/mu_pip_python_library\u003e\n\n## Contribution Process\n\nThis project welcomes all types of contributions. For issues, bugs, and\nquestions it is best to open a [github\nissue](https://github.com/tianocore/edk2-pytool-library/issues).\n\n### Code Contributions\n\nFor code contributions this project leverages github pull requests.  See github\ntutorials, help, and documentation for complete descriptions. For best success\nplease follow the below process.\n\n1. Contributor opens an issue describing problem or new desired functionality\n2. Contributor forks repository in github\n3. Contributor creates branch for work in their fork\n4. Contributor makes code changes, writes relevant unit tests, authors\n   documentation and release notes as necessary.\n5. Contributor runs tests locally\n6. Contributor submits PR to master branch of tianocore/edk2-pytool-library\n    1. PR reviewers will provide feedback on change.  If any modifications are\n       required, contributor will make changes and push updates.\n    2. PR automation will run and validate tests pass\n    3. If all comments resolved, maintainers approved, and tests pass the PR\n       will be squash merged and closed by the maintainers.\n\n## Maintainers\n\nSee the [github\nteam](https://github.com/orgs/tianocore/teams/edk-ii-tool-maintainers) for more\ndetails.\n\n## Documentation\n\n[![docs]][_docs]\n\n### Users and Consumers\n\nDocumentation for the most recent release of edk2-pytool-library is hosted on\n[tianocore.org/edk2-pytool-library](https://www.tianocore.org/edk2-pytool-library/).\nRaw documentation is located in the ```docs/``` folder and is split into two\nseparate categories. The first is located at ```docs/user/``` and is\ndocumentation and API references for those that are using this package in their\nown project. Users can generate a local copy of the documentation by executing the\nfollowing command from the root of the project:\n\n```cmd\npip install --upgrade -e .[docs]\nmkdocs serve\n```\n\n### Contributors\n\nContributor documentation is located at [docs/contributor/](https://github.com/tianocore/edk2-pytool-library/tree/master/docs/contributor)\n and contains instructions for:\n\n* Setting up a development and testing environment\n* How edk2pytools is versioned and published\n* How to publish a release\n* Contributing to the edk2-pytool-extensions repository\n\n[codecov]: https://codecov.io/gh/tianocore/edk2-pytool-library/branch/master/graph/badge.svg\n[_codecov]: https://codecov.io/gh/tianocore/edk2-pytool-extensions/\n[pypi]: https://img.shields.io/pypi/v/edk2_pytool_library.svg\n[_pypi]: https://pypi.org/project/edk2-pytool-library/\n[ci]: https://github.com/tianocore/edk2-pytool-library/actions/workflows/run-ci.yml/badge.svg?branch=master\n[_ci]: https://github.com/tianocore/edk2-pytool-library/actions/workflows/run-ci.yml\n[Windows-Latest]: https://github.com/actions/runner-images\n[Ubuntu-Latest]: https://github.com/actions/runner-images\n[MacOS-Latest]: https://github.com/actions/runner-images\n[docs]: https://img.shields.io/website?label=docs\u0026url=https%3A%2F%2Fwww.tianocore.org%2Fedk2-pytool-library%2F\n[_docs]: https://www.tianocore.org/edk2-pytool-library/\n[coming_soon]: https://img.shields.io/badge/CI-coming_soon-blue\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftianocore%2Fedk2-pytool-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftianocore%2Fedk2-pytool-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftianocore%2Fedk2-pytool-library/lists"}