From: Sean Brogan <sean.brogan@microsoft.com>

https://bugzilla.tianocore.org/show_bug.cgi?id=2315

Add pip requirements file that is used to install the
python pip modules build from the edk2-pytool-library and
edk2-pytool-extensions repositories.

These python modules provide the extensions required to
perform EDK II Continuous Integration(CI) builds.

Cc: Andrew Fish <afish@apple.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Leif Lindholm <leif.lindholm@linaro.org>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
---
 requirements.txt | 2 ++
 1 file changed, 2 insertions(+)
 create mode 100644 requirements.txt

diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000000..d4610f81c5
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+edk2-pytool-library==0.10.*
+edk2-pytool-extensions==0.12.*
-- 
2.21.0.windows.1


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#49587): https://edk2.groups.io/g/devel/message/49587
Mute This Topic: https://groups.io/mt/39614157/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

On Tue, Oct 29, 2019 at 12:54:58PM -0700, Michael D Kinney wrote:
> From: Sean Brogan <sean.brogan@microsoft.com>
> 
> https://bugzilla.tianocore.org/show_bug.cgi?id=2315
> 
> Add pip requirements file that is used to install the
> python pip modules build from the edk2-pytool-library and
> edk2-pytool-extensions repositories.
> 
> These python modules provide the extensions required to
> perform EDK II Continuous Integration(CI) builds.
> 
> Cc: Andrew Fish <afish@apple.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Leif Lindholm <leif.lindholm@linaro.org>
> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
> ---
>  requirements.txt | 2 ++

This ia an extremely generic name for a file with very specific
content. Is this a magic name, or could we rename it (for example)
pip-requirements.txt?

/
    Leif

>  1 file changed, 2 insertions(+)
>  create mode 100644 requirements.txt
> 
> diff --git a/requirements.txt b/requirements.txt
> new file mode 100644
> index 0000000000..d4610f81c5
> --- /dev/null
> +++ b/requirements.txt
> @@ -0,0 +1,2 @@
> +edk2-pytool-library==0.10.*
> +edk2-pytool-extensions==0.12.*
> -- 
> 2.21.0.windows.1
> 

-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#49614): https://edk2.groups.io/g/devel/message/49614
Mute This Topic: https://groups.io/mt/39614157/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

On 10/30/19 03:27, Leif Lindholm wrote:
> On Tue, Oct 29, 2019 at 12:54:58PM -0700, Michael D Kinney wrote:
>> From: Sean Brogan <sean.brogan@microsoft.com>
>>
>> https://bugzilla.tianocore.org/show_bug.cgi?id=2315
>>
>> Add pip requirements file that is used to install the
>> python pip modules build from the edk2-pytool-library and
>> edk2-pytool-extensions repositories.
>>
>> These python modules provide the extensions required to
>> perform EDK II Continuous Integration(CI) builds.
>>
>> Cc: Andrew Fish <afish@apple.com>
>> Cc: Laszlo Ersek <lersek@redhat.com>
>> Cc: Leif Lindholm <leif.lindholm@linaro.org>
>> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
>> ---
>>  requirements.txt | 2 ++
> 
> This ia an extremely generic name for a file with very specific
> content. Is this a magic name, or could we rename it (for example)
> pip-requirements.txt?

+1, I find the name of the file, especially with the file placed in the
project root dir, very confusing.

Thanks
Laszlo

> 
> /
>     Leif
> 
>>  1 file changed, 2 insertions(+)
>>  create mode 100644 requirements.txt
>>
>> diff --git a/requirements.txt b/requirements.txt
>> new file mode 100644
>> index 0000000000..d4610f81c5
>> --- /dev/null
>> +++ b/requirements.txt
>> @@ -0,0 +1,2 @@
>> +edk2-pytool-library==0.10.*
>> +edk2-pytool-extensions==0.12.*
>> -- 
>> 2.21.0.windows.1
>>


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#49738): https://edk2.groups.io/g/devel/message/49738
Mute This Topic: https://groups.io/mt/39614157/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

It is a convention for projects using python.  It definitely isn't required but there are some features that come for free when using that filename.

https://github.blog/2018-07-12-security-vulnerability-alerts-for-python/
and
https://help.github.com/en/github/visualizing-repository-data-with-graphs/listing-the-packages-that-a-repository-depends-on

You can also get more insight from github into dependencies and dependents.
example: https://github.com/tianocore/edk2-pytool-extensions/network/dependencies

I did notice on the example from above that github picked up the requirements.publisher.txt so i don't know what their pattern matching does exactly.

-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#49620): https://edk2.groups.io/g/devel/message/49620
Mute This Topic: https://groups.io/mt/39614157/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

OK, if it makes a difference for tools (and security updates), let's
try to keep it. (*grumble*)

*But* given its too-generic name, can we add a big bold comment header
to the file explaining what it is?
Some quick searching suggests lines starting with # are ignored, so
hopefully this should be possible?

Best Regards,

Leif

On Tue, Oct 29, 2019 at 07:52:48PM -0700, Sean via Groups.Io wrote:
> It is a convention for projects using python.  It definitely isn't required but there are some features that come for free when using that filename.
> 
> https://github.blog/2018-07-12-security-vulnerability-alerts-for-python/
> and
> https://help.github.com/en/github/visualizing-repository-data-with-graphs/listing-the-packages-that-a-repository-depends-on
> 
> You can also get more insight from github into dependencies and dependents.
> example: https://github.com/tianocore/edk2-pytool-extensions/network/dependencies
> 
> I did notice on the example from above that github picked up the requirements.publisher.txt so i don't know what their pattern matching does exactly.
> 
> 
> 

-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#49622): https://edk2.groups.io/g/devel/message/49622
Mute This Topic: https://groups.io/mt/39614157/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Hi Leif,

I will see if we can add a proper file header with a description.

I may break this out into its own patch since it is useful to
install these pip modules to run CI tests and builds locally.
The pip modules are not only use in a CI agent.

Mike

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On
> Behalf Of Leif Lindholm
> Sent: Tuesday, October 29, 2019 8:03 PM
> To: devel@edk2.groups.io; sean.brogan@microsoft.com
> Subject: Re: [edk2-devel] [Patch v3 03/22]
> requirements.txt: Add python pip requirements file
> 
> OK, if it makes a difference for tools (and security
> updates), let's try to keep it. (*grumble*)
> 
> *But* given its too-generic name, can we add a big bold
> comment header to the file explaining what it is?
> Some quick searching suggests lines starting with # are
> ignored, so hopefully this should be possible?
> 
> Best Regards,
> 
> Leif
> 
> On Tue, Oct 29, 2019 at 07:52:48PM -0700, Sean via
> Groups.Io wrote:
> > It is a convention for projects using python.  It
> definitely isn't required but there are some features
> that come for free when using that filename.
> >
> > https://github.blog/2018-07-12-security-vulnerability-
> alerts-for-pytho
> > n/
> > and
> > https://help.github.com/en/github/visualizing-
> repository-data-with-gra
> > phs/listing-the-packages-that-a-repository-depends-on
> >
> > You can also get more insight from github into
> dependencies and dependents.
> > example:
> > https://github.com/tianocore/edk2-pytool-
> extensions/network/dependenci
> > es
> >
> > I did notice on the example from above that github
> picked up the requirements.publisher.txt so i don't know
> what their pattern matching does exactly.
> >
> >
> >
> 
> 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#49710): https://edk2.groups.io/g/devel/message/49710
Mute This Topic: https://groups.io/mt/39614157/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Agreed.

On Thu, 31 Oct 2019, 12:39 Kinney, Michael D, <michael.d.kinney@intel.com>
wrote:

> Hi Leif,
>
> I will see if we can add a proper file header with a description.
>
> I may break this out into its own patch since it is useful to
> install these pip modules to run CI tests and builds locally.
> The pip modules are not only use in a CI agent.
>
> Mike
>
> > -----Original Message-----
> > From: devel@edk2.groups.io <devel@edk2.groups.io> On
> > Behalf Of Leif Lindholm
> > Sent: Tuesday, October 29, 2019 8:03 PM
> > To: devel@edk2.groups.io; sean.brogan@microsoft.com
> > Subject: Re: [edk2-devel] [Patch v3 03/22]
> > requirements.txt: Add python pip requirements file
> >
> > OK, if it makes a difference for tools (and security
> > updates), let's try to keep it. (*grumble*)
> >
> > *But* given its too-generic name, can we add a big bold
> > comment header to the file explaining what it is?
> > Some quick searching suggests lines starting with # are
> > ignored, so hopefully this should be possible?
> >
> > Best Regards,
> >
> > Leif
> >
> > On Tue, Oct 29, 2019 at 07:52:48PM -0700, Sean via
> > Groups.Io wrote:
> > > It is a convention for projects using python.  It
> > definitely isn't required but there are some features
> > that come for free when using that filename.
> > >
> > > https://github.blog/2018-07-12-security-vulnerability-
> > alerts-for-pytho
> > > n/
> > > and
> > > https://help.github.com/en/github/visualizing-
> > repository-data-with-gra
> > > phs/listing-the-packages-that-a-repository-depends-on
> > >
> > > You can also get more insight from github into
> > dependencies and dependents.
> > > example:
> > > https://github.com/tianocore/edk2-pytool-
> > extensions/network/dependenci
> > > es
> > >
> > > I did notice on the example from above that github
> > picked up the requirements.publisher.txt so i don't know
> > what their pattern matching does exactly.
> > >
> > >
> > >
> >
> > 
>
>

-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#49713): https://edk2.groups.io/g/devel/message/49713
Mute This Topic: https://groups.io/mt/39614157/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

I tested using "#" character to indicate the line was a comment.  I did this for a copyright, license identifier, and some text.  On Windows pip -r had no issues installing, upgrading, or uninstalling and didn't show any output related to those lines.

-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#49734): https://edk2.groups.io/g/devel/message/49734
Mute This Topic: https://groups.io/mt/39614157/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-