<a name="_MailOriginal"></a>RFC Edk2-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. To start this is a supplemental package and is not required to be used for edk2 builds. Examples of content here <ol style="margin-top: 0in;" start="1" type="1"> <li class="MsoListParagraphCxSpFirst" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l0 level1 lfo1;">Edk2 file type parsing</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l0 level1 lfo1;">UEFI structure encode/decode in python</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l0 level1 lfo1;">Packaging tools (Capsules generation, signing, INF gen, Cat gen)</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l0 level1 lfo1;">TPM support code</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l0 level1 lfo1;">Potentially move content from basetools/source/python/common/* </li> <li class="MsoListParagraphCxSpLast" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l0 level1 lfo1;">No command line tools/interface</li> </ol> Maintainers <ol style="margin-top: 0in;" start="1" type="1"> <li class="MsoListParagraphCxSpFirst" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l7 level1 lfo2;">Sean Brogan</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l7 level1 lfo2;">Bret Barkelew</li> <li class="MsoListParagraphCxSpLast" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l7 level1 lfo2;">Placeholder for existing maintainer from the basetools</li> </ol> License <ol style="margin-top: 0in;" start="1" type="1"> <li class="MsoListParagraph" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l4 level1 lfo3;">BSD + Patent (edk2 aligned)</li> </ol> Contribution process and issue tracking <ol style="margin-top: 0in;" start="1" type="1"> <li class="MsoListParagraphCxSpFirst" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l3 level1 lfo4;">Follow Github PR process for contributions and issue tracking</li> <ol style="margin-top: 0in;" start="1" type="a"> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l3 level2 lfo4;">Contributor forks repo in github</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l3 level2 lfo4;">Contributor creates branch for work</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l3 level2 lfo4;">Contributor updates release notes to indicate change (if necessary) </li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l3 level2 lfo4;">Contributor submits PR to master branch of tianocore/Edk2-Library repo</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l3 level2 lfo4;">Review feedback is given in PR</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l3 level2 lfo4;">Python Tests are run on the repo (new contributions need unit tests)</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l3 level2 lfo4;">Python Style (flake8) must pass</li> <li class="MsoListParagraphCxSpLast" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l3 level2 lfo4;">All review feedback must be completed, maintainers approved, and tests run successfully before PR is squash merged into master</li> </ol> </ol> Documentation <ol style="margin-top: 0in;" start="1" type="1"> <li class="MsoListParagraphCxSpFirst" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l5 level1 lfo5;">Use Github IO documentation/wiki hosting</li> <ol style="margin-top: 0in;" start="1" type="a"> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l5 level2 lfo5;">Example content</li> </ol> </ol>  i.  <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fmicrosoft.github.io%2Fmu%2Fdyn%2Fmu_pip_python_library%2Fdeveloping%2F&data=01%7C01%7Csean.brogan%40microsoft.com%7C47c4ca03e19b4fffc8ad08d6d314774a%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fKIb1Pfj4AqoGVOWudcyFMxMypJk%2FHTts9aMxZ8HukI%3D&reserved=0">https://microsoft.github.io/mu/dyn/mu_pip_python_library/developing/</a>  ii. <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fmicrosoft.github.io%2Fmu%2Fdyn%2Fmu_pip_python_library%2Fpublishing%2F&data=01%7C01%7Csean.brogan%40microsoft.com%7C47c4ca03e19b4fffc8ad08d6d314774a%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=QJMUMB1hIusaRVJhgsi9kF9KIbgdhS0WRnIXVkGeBCM%3D&reserved=0">https://microsoft.github.io/mu/dyn/mu_pip_python_library/publishing/</a> <ol style="margin-top: 0in;" start="2" type="1"> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l5 level1 lfo5;">Readme at root of repo</li> <ol style="margin-top: 0in;" start="1" type="a"> <li class="MsoListParagraphCxSpLast" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l5 level2 lfo5;">Example: <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FMicrosoft%2Fmu_pip_python_library&data=01%7C01%7Csean.brogan%40microsoft.com%7C47c4ca03e19b4fffc8ad08d6d314774a%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=DiuPnNMagvYYf0XXxDycSVHqijBBcDT0fXHzVY9U6%2Fw%3D&reserved=0">https://github.com/Microsoft/mu_pip_python_library</a></li> </ol> </ol> CI Builds <ol style="margin-top: 0in;" start="1" type="1"> <li class="MsoListParagraphCxSpFirst" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l8 level1 lfo6;">CI build process using dev ops</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l8 level1 lfo6;">Validation is done thru build process</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l8 level1 lfo6;">Release publication done thru manual CI Build</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l8 level1 lfo6;">Examples from Mu-Python-Library</li> <ol style="margin-top: 0in;" start="1" type="a"> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l8 level2 lfo6;">Windows CI - <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdev.azure.com%2Fprojectmu%2Fmu%2520pip%2F_build%3FdefinitionId%3D13&data=01%7C01%7Csean.brogan%40microsoft.com%7C47c4ca03e19b4fffc8ad08d6d314774a%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=jQCCZo2u8JVisCchOoMLSgKJbG3YEk%2FG1JP9fI4g2JY%3D&reserved=0">https://dev.azure.com/projectmu/mu%20pip/_build?definitionId=13</a></li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l8 level2 lfo6;">Linux CI - <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdev.azure.com%2Fprojectmu%2Fmu%2520pip%2F_build%3FdefinitionId%3D12&data=01%7C01%7Csean.brogan%40microsoft.com%7C47c4ca03e19b4fffc8ad08d6d314774a%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=CILlTdeEGpsi%2BCQNiZdIqd2Vt2RQV6L3qjz2rWEARYE%3D&reserved=0">https://dev.azure.com/projectmu/mu%20pip/_build?definitionId=12</a></li> <li class="MsoListParagraphCxSpLast" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l8 level2 lfo6;">Publishing - <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdev.azure.com%2Fprojectmu%2Fmu%2520pip%2F_build%3FdefinitionId%3D16&data=01%7C01%7Csean.brogan%40microsoft.com%7C47c4ca03e19b4fffc8ad08d6d314774a%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=hkpzn9P6RBjduYBWjN56Y2qRBWyOG32mFkP%2BwtY7KBQ%3D&reserved=0">https://dev.azure.com/projectmu/mu%20pip/_build?definitionId=16</a></li> </ol> </ol> Release <ol style="margin-top: 0in;" start="1" type="1"> <li class="MsoListParagraphCxSpFirst" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l1 level1 lfo7;">Release to Pypi as Edk2-Library for easy usage in product environment</li> <ol style="margin-top: 0in;" start="1" type="a"> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l1 level2 lfo7;">Versioned follows: Aa.bb.cc.dd</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l1 level2 lfo7;">AA == Major version. Changes don’t need to be backward compatible</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l1 level2 lfo7;">BB == Minor version. Significant new features. Backward compatibility maintained </li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l1 level2 lfo7;">CC == Bug fix/patch/small optional feature</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l1 level2 lfo7;">DD == build/Release version. </li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l1 level2 lfo7;">Package on Pypi will be owned by Tianocore group</li> </ol> <li class="MsoListParagraphCxSpLast" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l1 level1 lfo7;">Example for mu-python-library: <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpypi.org%2Fproject%2Fmu-python-library%2F&data=01%7C01%7Csean.brogan%40microsoft.com%7C47c4ca03e19b4fffc8ad08d6d314774a%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=5nTb93dDnAo%2FsWyfv1zYEIkJF8L58YY5P3BkzKi4Ivc%3D&reserved=0">https://pypi.org/project/mu-python-library/</a> </li> </ol> Other Notes <ol style="margin-top: 0in;" start="1" type="1"> <li class="MsoListParagraphCxSpFirst" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l6 level1 lfo8;">Only support Python 3 (prefer 3.7+)</li> <li class="MsoListParagraphCxSpMiddle" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l6 level1 lfo8;"><span style="mso-ascii-font-family: Calibri; mso-ascii-theme-font: minor-latin; mso-hansi-font-family: Calibri; mso-hansi-theme-font: minor-latin; mso-bidi-font-family: 'Times New Roman'; mso-bidi-theme-font: minor-bidi;">This was discussed on the edk2 design meetings (4/18) <a href="https://edk2.groups.io/g/devel/files/Designs/2019/0418">https://edk2.groups.io/g/devel/files/Designs/2019/0418</a><span style="mso-ascii-font-family: Calibri; mso-ascii-theme-font: minor-latin; mso-hansi-font-family: Calibri; mso-hansi-theme-font: minor-latin; mso-bidi-font-family: 'Times New Roman'; mso-bidi-theme-font: minor-bidi;"></li> <li class="MsoListParagraphCxSpLast" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l6 level1 lfo8;"><span style="mso-ascii-font-family: Calibri; mso-ascii-theme-font: minor-latin; mso-hansi-font-family: Calibri; mso-hansi-theme-font: minor-latin; mso-bidi-font-family: 'Times New Roman'; mso-bidi-theme-font: minor-bidi;">There will be one more RFC for another python package/repo for Build environment. </li> </ol> <span style="mso-ascii-font-family: Calibri; mso-ascii-theme-font: minor-latin; mso-hansi-font-family: Calibri; mso-hansi-theme-font: minor-latin; mso-bidi-font-family: 'Times New Roman'; mso-bidi-theme-font: minor-bidi;"> Timeline <ol style="margin-top: 0in;" start="1" type="1"> <li class="MsoListParagraph" style="margin-bottom: 8.0pt; margin-left: 0in; mso-add-space: auto; line-height: 105%; mso-list: l2 level1 lfo9;">RFC open for comment thru 5/21/2019</li> </ol> <div width="1" style="color:white;clear:both">_._,_._,_</div> <hr> Groups.io Links: You receive all messages sent to this group. <a target="_blank" href="https://edk2.groups.io/g/devel/message/40143">View/Reply Online (#40143)</a> | | <a target="_blank" href="https://groups.io/mt/31536886/1813853">Mute This Topic</a> | <a href="https://edk2.groups.io/g/devel/post">New Topic</a> <a href="https://edk2.groups.io/g/devel/editsub/1813853">Your Subscription</a> | <a href="mailto:devel+owner@edk2.groups.io">Contact Group Owner</a> | <a href="https://edk2.groups.io/g/devel/unsub">Unsubscribe</a> [edk2-devel-archive@redhat.com] <div width="1" style="color:white;clear:both">_._,_._,_</div>