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

["Laszlo Ersek" <lersek@redhat.com>]

On 11/07/19 02:13, Michael D Kinney wrote:
> From: Sean Brogan <sean.brogan@microsoft.com>
> 
> 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 | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
>  create mode 100644 requirements.txt
> 
> diff --git a/requirements.txt b/requirements.txt
> new file mode 100644
> index 0000000000..4ad72cfc98
> --- /dev/null
> +++ b/requirements.txt
> @@ -0,0 +1,17 @@
> +## @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.


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.)

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.

Thanks!
Laszlo