RFC  edk2-tools-library creation

Create a new tianocore owned repository to host a python library package in support of UEFI development.  This package will allow easy sharing of python library code to facilitate reuse.  Inclusion of this package and dependency management should be managed using Pip/Pypi.   This is a supplemental package and is not required to be used for edk2 builds.  To avoid conflicting dependencies on your host platform it is strongly suggested to leverage python virtual environments. 

 

Examples of content here

  1. Edk2 file type parsing
  2. UEFI structure encode/decode in python
  3. Packaging tools (Capsules generation, signing, INF gen, Cat gen)
  4. TPM support code
  5. No command line tools/interface

Maintainers

  1. Sean Brogan
  2. Bret Barkelew
  3. Placeholder for existing maintainer from the basetools

License

  1. BSD + Patent (edk2 aligned)

Contribution process and issue tracking

  1. Follow Github PR process for contributions and issue tracking
    1. Contributor forks repo in github
    2. Contributor creates branch for work
    3. Contributor updates release notes to indicate change (if necessary)
    4. Contributor submits PR to master branch of tianocore/edk2-tools-library repo
    5. Review feedback is given in PR
    6. Python Tests are run on the repo (new contributions need unit tests)
    7. Python Style (flake8) must pass
    8. All review feedback must be completed, maintainers approved, and tests run successfully before PR is squash merged into master. Since squash merge is used there is no support for patchsets.  The PR should be sized appropriately.

Documentation

  1. Use Github IO documentation/wiki hosting
    1. Example content
      1. https://microsoft.github.io/mu/dyn/mu_pip_python_library/developing/
      2. https://microsoft.github.io/mu/dyn/mu_pip_python_library/publishing/
  2. Readme at root of repo
    1. Example: https://github.com/Microsoft/mu_pip_python_library
  3. API documentation
    1. Figure out autogenerated pydocs

 

CI Builds

  1. CI build process using dev ops (new TianoCore organization created in Azure devops)
  2. Validation is done thru build process
  3. Release publication done thru manual CI Build
  4. Examples from Mu-Python-Library
    1. Windows CI - https://dev.azure.com/projectmu/mu%20pip/_build?definitionId=13
    2. Linux CI - https://dev.azure.com/projectmu/mu%20pip/_build?definitionId=12
    3. Publishing - https://dev.azure.com/projectmu/mu%20pip/_build?definitionId=16

Release

  1. Release to Pypi as edk2-tools-library for easy usage in product environment
    1. Versioned follows: Aa.bb.cc and is based on tags in git
    2. AA == Major version.  Changes don’t need to be backward compatible
    3. BB == Minor version.  Significant new features.  Backward compatibility maintained
    4. CC == Bug fix/patch/small optional feature
    5. Package on Pypi will be owned by Tianocore group
  1. Example for mu-python-library: https://pypi.org/project/mu-python-library/

Other Notes

  1. Only support Python 3 (prefer 3.7+)
  2. This was discussed on the edk2 design meetings (4/18) https://edk2.groups.io/g/devel/files/Designs/2019/0418
  3. There will be one more RFC for another python package/repo for edk2-tools-extensions
  4. Will start version 00.09.00 while getting the repository setup and functioning with 1.0.0 being the first real release