From 49e89a47cbebbb134ff8c8d71e75d841716a61da Mon Sep 17 00:00:00 2001 From: CoprDistGit Date: Tue, 11 Apr 2023 09:43:14 +0000 Subject: automatic import of python-edk2-pytool-library --- .gitignore | 1 + python-edk2-pytool-library.spec | 546 ++++++++++++++++++++++++++++++++++++++++ sources | 1 + 3 files changed, 548 insertions(+) create mode 100644 python-edk2-pytool-library.spec create mode 100644 sources diff --git a/.gitignore b/.gitignore index e69de29..d082fe9 100644 --- a/.gitignore +++ b/.gitignore @@ -0,0 +1 @@ +/edk2-pytool-library-0.14.1.tar.gz diff --git a/python-edk2-pytool-library.spec b/python-edk2-pytool-library.spec new file mode 100644 index 0000000..f48baee --- /dev/null +++ b/python-edk2-pytool-library.spec @@ -0,0 +1,546 @@ +%global _empty_manifest_terminate_build 0 +Name: python-edk2-pytool-library +Version: 0.14.1 +Release: 1 +Summary: Python library supporting UEFI EDK2 firmware development +License: BSD-2-Clause-Patent +URL: https://github.com/tianocore/edk2-pytool-library +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/46/2b/1a040c0dccbce018a506db07c87459cd3c7f9c3785e1fd92cd11440b35b5/edk2-pytool-library-0.14.1.tar.gz +BuildArch: noarch + + +%description +# Tianocore Edk2 PyTool Library (edk2toollib) + +[![pypi]][_pypi] +[![codecov]][_codecov] +[![ci]][_ci] +[![docs]][_docs] + +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 Status + +[![codecov]][_codecov] +[![ci]][_ci] + +The 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 Versions + +| Host Type | Toolchain | Status +| :--------------- | :---------- | :-------------------- | +| [Windows-Latest] | Python 3.9 | [![ci]][_ci] | +| [Windows-Latest] | Python 3.10 | [![ci]][_ci] | +| [Windows-Latest] | Python 3.11 | [![ci]][_ci] | +| [Ubuntu-Latest] | Python 3.9 | [![ci]][_ci] | +| [Ubuntu-Latest] | Python 3.10 | [![ci]][_ci] | +| [Ubuntu-Latest] | Python 3.11 | [![ci]][_ci] | +| [MacOS-Latest] | Python 3.9 | [![coming_soon]][_ci] | +| [MacOS-Latest] | Python 3.10 | [![coming_soon]][_ci] | +| [MacOS-Latest] | Python 3.11 | [![coming_soon]][_ci] | + +### Current Release + +[![pypi]][_pypi] + +All release information is now tracked with Github + [tags](https://github.com/tianocore/edk2-pytool-library/tags), + [releases](https://github.com/tianocore/edk2-pytool-library/releases) and + [milestones](https://github.com/tianocore/edk2-pytool-library/milestones). + +## 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](license.txt). + +[![PyPI - +License](https://img.shields.io/pypi/l/edk2_pytool_library.svg)](https://pypi.org/project/edk2-pytool-library/) + +## 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-pytool-library` +* To use in your python code + + ```python + from edk2toollib. import + ``` + +## History + +This library and functionality was ported from Project Mu. For history and +documentation prior to this see the original Project Mu project + + +## 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-pytool-library/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-pytool-library + 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](https://github.com/orgs/tianocore/teams/edk-ii-tool-maintainers) for more +details. + +## Documentation + +[![docs]][_docs] + +Documentation for the most recent release of edk2-pytool-library is hosted on +[tianocore.org/edk2-pytool-library](https://www.tianocore.org/edk2-pytool-library/)]). +Raw documentation is located in the ```docs/``` folder and is split into two +separate categories. The first is located at ```docs/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: + +```cmd +pip install --upgrade -r .\docs\user\requirements.txt +mkdocs serve +``` + +The second is located at ```docs/contributor/``` and is documentation for +contributing to the edk2-pytool-extensions repository. + +[codecov]: https://codecov.io/gh/tianocore/edk2-pytool-library/branch/master/graph/badge.svg +[_codecov]: https://codecov.io/gh/tianocore/edk2-pytool-extensions/ +[pypi]: https://img.shields.io/pypi/v/edk2_pytool_library.svg +[_pypi]: https://pypi.org/project/edk2-pytool-library/ +[ci]: https://github.com/tianocore/edk2-pytool-library/actions/workflows/run-ci.yml/badge.svg?branch=master +[_ci]: https://github.com/tianocore/edk2-pytool-library/actions/workflows/run-ci.yml +[Windows-Latest]: https://github.com/actions/runner-images +[Ubuntu-Latest]: https://github.com/actions/runner-images +[MacOS-Latest]: https://github.com/actions/runner-images +[docs]: https://img.shields.io/website?label=docs&url=https%3A%2F%2Fwww.tianocore.org%2Fedk2-pytool-library%2F +[_docs]: https://www.tianocore.org/edk2-pytool-library/ +[coming_soon]: https://img.shields.io/badge/CI-coming_soon-blue + + +%package -n python3-edk2-pytool-library +Summary: Python library supporting UEFI EDK2 firmware development +Provides: python-edk2-pytool-library +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-edk2-pytool-library +# Tianocore Edk2 PyTool Library (edk2toollib) + +[![pypi]][_pypi] +[![codecov]][_codecov] +[![ci]][_ci] +[![docs]][_docs] + +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 Status + +[![codecov]][_codecov] +[![ci]][_ci] + +The 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 Versions + +| Host Type | Toolchain | Status +| :--------------- | :---------- | :-------------------- | +| [Windows-Latest] | Python 3.9 | [![ci]][_ci] | +| [Windows-Latest] | Python 3.10 | [![ci]][_ci] | +| [Windows-Latest] | Python 3.11 | [![ci]][_ci] | +| [Ubuntu-Latest] | Python 3.9 | [![ci]][_ci] | +| [Ubuntu-Latest] | Python 3.10 | [![ci]][_ci] | +| [Ubuntu-Latest] | Python 3.11 | [![ci]][_ci] | +| [MacOS-Latest] | Python 3.9 | [![coming_soon]][_ci] | +| [MacOS-Latest] | Python 3.10 | [![coming_soon]][_ci] | +| [MacOS-Latest] | Python 3.11 | [![coming_soon]][_ci] | + +### Current Release + +[![pypi]][_pypi] + +All release information is now tracked with Github + [tags](https://github.com/tianocore/edk2-pytool-library/tags), + [releases](https://github.com/tianocore/edk2-pytool-library/releases) and + [milestones](https://github.com/tianocore/edk2-pytool-library/milestones). + +## 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](license.txt). + +[![PyPI - +License](https://img.shields.io/pypi/l/edk2_pytool_library.svg)](https://pypi.org/project/edk2-pytool-library/) + +## 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-pytool-library` +* To use in your python code + + ```python + from edk2toollib. import + ``` + +## History + +This library and functionality was ported from Project Mu. For history and +documentation prior to this see the original Project Mu project + + +## 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-pytool-library/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-pytool-library + 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](https://github.com/orgs/tianocore/teams/edk-ii-tool-maintainers) for more +details. + +## Documentation + +[![docs]][_docs] + +Documentation for the most recent release of edk2-pytool-library is hosted on +[tianocore.org/edk2-pytool-library](https://www.tianocore.org/edk2-pytool-library/)]). +Raw documentation is located in the ```docs/``` folder and is split into two +separate categories. The first is located at ```docs/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: + +```cmd +pip install --upgrade -r .\docs\user\requirements.txt +mkdocs serve +``` + +The second is located at ```docs/contributor/``` and is documentation for +contributing to the edk2-pytool-extensions repository. + +[codecov]: https://codecov.io/gh/tianocore/edk2-pytool-library/branch/master/graph/badge.svg +[_codecov]: https://codecov.io/gh/tianocore/edk2-pytool-extensions/ +[pypi]: https://img.shields.io/pypi/v/edk2_pytool_library.svg +[_pypi]: https://pypi.org/project/edk2-pytool-library/ +[ci]: https://github.com/tianocore/edk2-pytool-library/actions/workflows/run-ci.yml/badge.svg?branch=master +[_ci]: https://github.com/tianocore/edk2-pytool-library/actions/workflows/run-ci.yml +[Windows-Latest]: https://github.com/actions/runner-images +[Ubuntu-Latest]: https://github.com/actions/runner-images +[MacOS-Latest]: https://github.com/actions/runner-images +[docs]: https://img.shields.io/website?label=docs&url=https%3A%2F%2Fwww.tianocore.org%2Fedk2-pytool-library%2F +[_docs]: https://www.tianocore.org/edk2-pytool-library/ +[coming_soon]: https://img.shields.io/badge/CI-coming_soon-blue + + +%package help +Summary: Development documents and examples for edk2-pytool-library +Provides: python3-edk2-pytool-library-doc +%description help +# Tianocore Edk2 PyTool Library (edk2toollib) + +[![pypi]][_pypi] +[![codecov]][_codecov] +[![ci]][_ci] +[![docs]][_docs] + +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 Status + +[![codecov]][_codecov] +[![ci]][_ci] + +The 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 Versions + +| Host Type | Toolchain | Status +| :--------------- | :---------- | :-------------------- | +| [Windows-Latest] | Python 3.9 | [![ci]][_ci] | +| [Windows-Latest] | Python 3.10 | [![ci]][_ci] | +| [Windows-Latest] | Python 3.11 | [![ci]][_ci] | +| [Ubuntu-Latest] | Python 3.9 | [![ci]][_ci] | +| [Ubuntu-Latest] | Python 3.10 | [![ci]][_ci] | +| [Ubuntu-Latest] | Python 3.11 | [![ci]][_ci] | +| [MacOS-Latest] | Python 3.9 | [![coming_soon]][_ci] | +| [MacOS-Latest] | Python 3.10 | [![coming_soon]][_ci] | +| [MacOS-Latest] | Python 3.11 | [![coming_soon]][_ci] | + +### Current Release + +[![pypi]][_pypi] + +All release information is now tracked with Github + [tags](https://github.com/tianocore/edk2-pytool-library/tags), + [releases](https://github.com/tianocore/edk2-pytool-library/releases) and + [milestones](https://github.com/tianocore/edk2-pytool-library/milestones). + +## 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](license.txt). + +[![PyPI - +License](https://img.shields.io/pypi/l/edk2_pytool_library.svg)](https://pypi.org/project/edk2-pytool-library/) + +## 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-pytool-library` +* To use in your python code + + ```python + from edk2toollib. import + ``` + +## History + +This library and functionality was ported from Project Mu. For history and +documentation prior to this see the original Project Mu project + + +## 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-pytool-library/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-pytool-library + 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](https://github.com/orgs/tianocore/teams/edk-ii-tool-maintainers) for more +details. + +## Documentation + +[![docs]][_docs] + +Documentation for the most recent release of edk2-pytool-library is hosted on +[tianocore.org/edk2-pytool-library](https://www.tianocore.org/edk2-pytool-library/)]). +Raw documentation is located in the ```docs/``` folder and is split into two +separate categories. The first is located at ```docs/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: + +```cmd +pip install --upgrade -r .\docs\user\requirements.txt +mkdocs serve +``` + +The second is located at ```docs/contributor/``` and is documentation for +contributing to the edk2-pytool-extensions repository. + +[codecov]: https://codecov.io/gh/tianocore/edk2-pytool-library/branch/master/graph/badge.svg +[_codecov]: https://codecov.io/gh/tianocore/edk2-pytool-extensions/ +[pypi]: https://img.shields.io/pypi/v/edk2_pytool_library.svg +[_pypi]: https://pypi.org/project/edk2-pytool-library/ +[ci]: https://github.com/tianocore/edk2-pytool-library/actions/workflows/run-ci.yml/badge.svg?branch=master +[_ci]: https://github.com/tianocore/edk2-pytool-library/actions/workflows/run-ci.yml +[Windows-Latest]: https://github.com/actions/runner-images +[Ubuntu-Latest]: https://github.com/actions/runner-images +[MacOS-Latest]: https://github.com/actions/runner-images +[docs]: https://img.shields.io/website?label=docs&url=https%3A%2F%2Fwww.tianocore.org%2Fedk2-pytool-library%2F +[_docs]: https://www.tianocore.org/edk2-pytool-library/ +[coming_soon]: https://img.shields.io/badge/CI-coming_soon-blue + + +%prep +%autosetup -n edk2-pytool-library-0.14.1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-edk2-pytool-library -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot - 0.14.1-1 +- Package Spec generated diff --git a/sources b/sources new file mode 100644 index 0000000..5b25e90 --- /dev/null +++ b/sources @@ -0,0 +1 @@ +f2e0f3c15a6a0e93e3e19e7aa7a74cb8 edk2-pytool-library-0.14.1.tar.gz -- cgit v1.2.3