Metadata-Version: 2.1
Name: edk2-basetools
Version: 0.1.53
Summary: Python BaseTools supporting UEFI EDK2 firmware development
Author-email: TianoCore EDK2-BaseTools Team <devel@edk2.groups.io>
Maintainer-email: Liming Gao <gaoliming@byosoft.com.cn>, Rebecca Cran <rebecca@bsdio.com>
License: Copyright (c) 2019, TianoCore and contributors.  All rights reserved.
        Copyright (c) Microsoft All rights reserved.
        
        SPDX-License-Identifier: BSD-2-Clause-Patent
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice,
           this list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        Subject to the terms and conditions of this license, each copyright holder
        and contributor hereby grants to those receiving rights under this license
        a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
        (except for failure to satisfy the conditions of this license) patent
        license to make, have made, use, offer to sell, sell, import, and otherwise
        transfer this software, where such license applies only to those patent
        claims, already acquired or hereafter acquired, licensable by such copyright
        holder or contributor that are necessarily infringed by:
        
        (a) their Contribution(s) (the licensed copyrights of copyright holders and
            non-copyrightable additions of contributors, in source or binary form)
            alone; or
        
        (b) combination of their Contribution(s) with the work of authorship to
            which such Contribution(s) was added by such copyright holder or
            contributor, if, at the time the Contribution is added, such addition
            causes such combination to be necessarily infringed. The patent license
            shall not apply to any other combinations which include the
            Contribution.
        
        Except as expressly stated above, no rights or licenses from any copyright
        holder or contributor is granted under this license, whether expressly, by
        implication, estoppel or otherwise.
        
        DISCLAIMER
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
        ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
        LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
        CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
        ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
        POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: homepage, https://github.com/tianocore/edk2-basetools
Project-URL: issues, https://github.com/tianocore/edk2-basetools/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: edk2-pytool-library >=0.20.0
Requires-Dist: antlr4-python3-runtime >=4.7.1
Provides-Extra: publish
Requires-Dist: setuptools ; extra == 'publish'
Requires-Dist: build ; extra == 'publish'

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

## Current Release

[![PyPI](https://img.shields.io/pypi/v/edk2_basetools.svg)](https://pypi.org/project/edk2-basetools/)

A minor release occurs for each merged Pull Request, which can be tracked via [commits](https://github.com/tianocore/edk2-basetools/commits/master) or [closed pull requests](https://github.com/tianocore/edk2-basetools/pulls?q=is%3Apr+is%3Aclosed).

## Content

The package contains all python source files necessary to build an EDK2 project. This is a fundamental package and is required for edk2 builds. These tools are typically called by the build system, however each is independently callable.

Examples:

* Build.py
* Split.py
* Trim.py
* AmlToC.py

## License

All content in this repository is licensed under [BSD-2-Clause Plus Patent License](license.txt).

[![PyPI - License](https://img.shields.io/pypi/l/edk2_basetools.svg)](https://pypi.org/project/edk2-basetools/)

## 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](https://docs.python.org/3/library/venv.html)

* To install run `pip install --upgrade edk2-basetools`
* To use in your python code

### Building with edk2-pytool-extensions

To perform a build using [edk2-pytool-extensions](https://pypi.org/project/edk2-pytool-extensions/) invocables, add the *pipbuild-win* or *pipbuild-unix* scope to the platform build file.

### Building with edk2

Follow the normal build process; it will automatically detect and use edk2-basetools pip module if available.

### Custom

BaseTools/Bin**Pip**Wrappers/WindowsLike or BaseTools/Bin**Pip**Wrappers/PosixLike path must be set instead of BaseTools/BinWrappers/WindowsLike or BaseTools/BinWrappers/UnixLike

## Contribution Process

This project welcomes all types of contributions.
For issues, bugs, and questions it is best to open a [github issue](https://github.com/tianocore/edk2-basetools/issues).

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

[Liming Gao <gaoliming@byosoft.com.cn>](mailto:gaoliming@byosoft.com.cn)
[Rebecca Cran <rebecca@bsdio.com>](mailto:rebecca@bsdio.com)

### Developers/Reviewers

See the [github team](https://github.com/orgs/tianocore/teams/edk-ii-tool-maintainers) for more details.

## Documentation

See the github repo **docs** folder
