Re: [Patch v4 03/22] requirements.txt: Add python pip requirements file

["Leif Lindholm" <leif.lindholm@linaro.org>]

On Thu, Nov 07, 2019 at 11:39:37AM +0100, Laszlo Ersek wrote:
> > +## @file
> > +# EDK II Python PIP requirements file
> > +#
> > +# This file provides the list of python components to install using PIP.
> > +#
> > +# Copyright (c) Microsoft Corporation. All rights reserved.<BR>
> > +#
> > +# SPDX-License-Identifier: BSD-2-Clause-Patent
> > +#
> > +# https://pypi.org/project/pip/
> > +# https://pip.pypa.io/en/stable/user_guide/#requirements-files
> > +# https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format
> > +#
> > +##
> > +
> > +edk2-pytool-library==0.10.*
> > +edk2-pytool-extensions==0.12.*
> > 
> 
> This is better, but I still find the plain "requirements.txt" filename
> in the root directory of the project very confusing. What component
> *exactly* insists on this file path and file name?
> 
> I've checked
> 
>   https://pip.pypa.io/en/stable/user_guide/#requirements-files
> 
> and it seems like "pip" can take any pathname as an argument to option "-r".
> 
> There must be a component in the CI environment that invokes "pip". Can
> we file a feature request for that component, that it try
> "pip-requirements.txt" first?
> 
> Hmmm... I just googled "github pip requirements.txt", assuming that
> "github" was the component calling "pip". In the result list, I've found:
> 
> https://github.com/ClearingHouse/clearinghoused/blob/master/pip-requirements.txt
> 
> Is it possible that github already knows to look for
> "pip-requirements.txt"? (Honestly I only suggested
> "pip-requirements.txt" above because it seemed sensible.) If that's the
> case, we should use it.

I agree it would be sensible to investigate this approach first.

> Furthermore, my understanding is that "the list of python components to
> install using PIP" is only there for CI purposes. Can we please state
> that explicitly in the comment block? (The commit message already does
> that, and that's great.)

Good point.

> Basically when someone clones edk2 and runs "ls -l" for the first time,
> there's a good chance "requirements.txt" will be among the few files
> they open right after.

Yeah. For a specific project to use that as a default config filename
is ... pretty arrogant.

/
    Leif