Bug 1974114 - Review Request: python-environs - Python library for parsing environment variables
Summary: Review Request: python-environs - Python library for parsing environment vari...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Ben Beasley
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-06-20 17:34 UTC by Antonio T. sagitter
Modified: 2021-07-03 01:24 UTC (History)
3 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2021-07-03 01:24:59 UTC
Type: ---
Embargoed:
code: fedora-review+


Attachments (Terms of Use)
Example of using pyproject-rpm-macros (1.38 KB, text/plain)
2021-06-22 18:44 UTC, Ben Beasley
no flags Details

Description Antonio T. sagitter 2021-06-20 17:34:43 UTC
Spec URL: https://download.copr.fedorainfracloud.org/results/sagitter/ForTesting/fedora-rawhide-x86_64/02265920-python-environs/python-environs.spec

SRPM URL: https://download.copr.fedorainfracloud.org/results/sagitter/ForTesting/fedora-rawhide-x86_64/02265920-python-environs/python-environs-9.3.2-1.fc35.src.rpm

Description:
Environs is Python library for parsing environment variables.
It allows you to store configuration separate from your code.

Fedora Account System Username: sagitter

Comment 2 Ben Beasley 2021-06-22 18:32:49 UTC
Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated


===== Issues =====

- The Source0 URL seems to be broken. Try:

    Source0:    %{url}/archive/%{version}/%{srcname}-%{version}.tar.gz

- The %python_provide macro is obsolete. It has been replaced by %py_provides;
  but even that is not required here for Fedora (after 32, which is now
  end-of-life) since the subpackage is conventionally-named. See
  https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_the_py_provides_macro.

  (I know %py_provides is also available on EPEL8; I haven’t checked if it is
  needed for conventionally-named packages. I don’t think you’re targeting
  EPEL8 here, since you have two missing dependencies there.)

  Please remove:

    %{?python_provide:%python_provide python3-%{srcname}}

- Python dependencies that are specified in the package metadata (e.g., in
  install_requires in setup.py) are automatically generated on all Fedora
  releases and EPEL8. This can be turned off, but there is no reason to.
  Therefore, these are redundant and should be removed:

    Requires:  %{py3_dist dj-database-url}
    Requires:  %{py3_dist dj-email-url}
    Requires:  %{py3_dist django-cache-url}
    Requires:  %{py3_dist python-dotenv}
    Requires:  %{py3_dist flask}

  (They are not really consistent with setup.py anyway; for example,
  marshmallow is in install_requires but missing from the manual Requires, and
  dj-database-url/dj-email-url/django-cache-url really belong to the “django”
  extra; see below.)

- You should properly package the metapackage for the “django” extra
  (https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_python_extras):

    %{?python_extras_subpkg:%python_extras_subpkg -n python3-requests -i %{python3_sitelib}/*.egg-info django}

- This:

    export PYTHONPATH=%{buildroot}%{python3_sitelib}
    pytest-%{python3_version} -v

  would be better written as:

    %pytest

- Consider changing

    %global _description %{expand: \
    Environs is Python library for parsing environment variables.
    It allows you to store configuration separate from your code, as per
    [The Twelve-Factor App](https://12factor.net/config) methodology.}

  to

    %global _description %{expand: \
    Environs is a Python library for parsing environment variables.
    It allows you to store configuration separate from your code, as per
    The Twelve-Factor App (https://12factor.net/config) methodology.}

  since Markdown links will not render in package descriptions, and the square
  brackets don’t improve readability in plain text. (The above also adds a
  missing article “a”.)

- This package would really benefit from porting to the pyproject-rpm-macros
  (https://src.fedoraproject.org/rpms/pyproject-rpm-macros). It would let you
  use generated BuildRequires so you don’t have to keep them updated by hand,
  and it would slightly simplify handling of the “django” extras metapackage
  and the files list.

  I’ll upload an example spec file for this pacakge so you can take a look and
  decide if you’re interested in switching.

===== MUST items =====

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "Expat License", "*No copyright* Expat
     License". 22 files have unknown license. Detailed output of
     licensecheck in /home/reviewer/1974114-python-
     environs/licensecheck.txt
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[!]: Requires correct, justified where necessary.

     Manual requires are incomplete (missing marshmallow); unnecessary (would
     already be generated from metadata); and include dependencies that belong
     to the “django” extra.

[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 30720 bytes in 3 files.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[x]: Package does not own files or directories owned by other packages.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package must not depend on deprecated() packages.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Packages must not store files under /srv, /opt or /usr/local

Python:
[x]: Python eggs must not download any dependencies during the build
     process.
[x]: A package which is used by another package via an egg interface should
     provide egg info.
[x]: Package meets the Packaging Guidelines::Python

     (except as noted)

[x]: Package contains BR: python2-devel or python3-devel
[x]: Packages MUST NOT have dependencies (either build-time or runtime) on
     packages named with the unversioned python- prefix unless no properly
     versioned package exists. Dependencies on Python packages instead MUST
     use names beginning with python2- or python3- as appropriate.
[x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
[x]: Binary eggs must be removed in %prep

===== SHOULD items =====

Generic:
[!]: Sources can be downloaded from URI in Source: tag
     Note: Could not download Source0:
     https://github.com/sloria/environs/archive/refs/tags/archive/9.3.2/environs-9.3.2.tar.gz
     See: https://docs.fedoraproject.org/en-US/packaging-
     guidelines/SourceURL/
[-]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).

     (except that some should belong to a “django” extras metapackage)

[x]: Package functions as described.

     (based on tests passing)

[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: SourceX tarball generation or download is documented.
     Note: Package contains tarball without URL, check comments

     (broken URL)

[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-environs-9.3.2-1.fc35.noarch.rpm
          python-environs-9.3.2-1.fc35.src.rpm
python3-environs.noarch: W: spelling-error %description -l en_US https -> HTTP
python-environs.src: W: spelling-error %description -l en_US https -> HTTP
python-environs.src: W: invalid-url Source0: https://github.com/sloria/environs/archive/refs/tags/archive/9.3.2/environs-9.3.2.tar.gz HTTP Error 404: Not Found
2 packages and 0 specfiles checked; 0 errors, 3 warnings.




Rpmlint (installed packages)
----------------------------
Cannot parse rpmlint output:


Requires
--------
python3-environs (rpmlib, GLIBC filtered):
    python(abi)
    python3.10dist(marshmallow)
    python3.10dist(python-dotenv)
    python3dist(dj-database-url)
    python3dist(dj-email-url)
    python3dist(django-cache-url)
    python3dist(flask)
    python3dist(python-dotenv)



Provides
--------
python3-environs:
    python-environs
    python3-environs
    python3.10-environs
    python3.10dist(environs)
    python3dist(environs)



Generated by fedora-review 0.7.6 (b083f91) last change: 2020-11-10
Command line :/usr/bin/fedora-review -b 1974114
Buildroot used: fedora-rawhide-aarch64
Active plugins: Python, Shell-api, Generic
Disabled plugins: C/C++, Ocaml, fonts, Perl, Java, PHP, SugarActivity, Haskell, R
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 3 Ben Beasley 2021-06-22 18:44:43 UTC
Created attachment 1793190 [details]
Example of using pyproject-rpm-macros

If you want to switch to using pyproject-rpm-macros, feel free to use this spec file. I have not re-reviewed it, but I believe it corrects all findings from the original review.

Comment 5 Ben Beasley 2021-06-23 13:36:18 UTC
Package approved; please see the note under Issues, below.

Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated

===== Issues =====

- You should add “examples” to %doc. The number and size of files is still
  small enough that (subjectively) a -doc subpackage is not required,
  although you are welcome to make one if you like. (If you do add a -doc
  subpackage, make sure it includes a copy of the LICENSE file, since it
  does not need to depend on the python3-environ package.)

===== MUST items =====

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "Expat License", "*No copyright* Expat
     License". 22 files have unknown license. Detailed output of
     licensecheck in /home/reviewer/1974114-python-
     environs/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 30720 bytes in 3 files.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[x]: Package does not own files or directories owned by other packages.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package must not depend on deprecated() packages.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Packages must not store files under /srv, /opt or /usr/local

Python:
[x]: Python eggs must not download any dependencies during the build
     process.
[x]: A package which is used by another package via an egg interface should
     provide egg info.
[x]: Package meets the Packaging Guidelines::Python
[x]: Package contains BR: python2-devel or python3-devel
[x]: Packages MUST NOT have dependencies (either build-time or runtime) on
     packages named with the unversioned python- prefix unless no properly
     versioned package exists. Dependencies on Python packages instead MUST
     use names beginning with python2- or python3- as appropriate.
[x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
[x]: Binary eggs must be removed in %prep

===== SHOULD items =====

Generic:
[-]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[-]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python3-environs , python3-environs+django
[x]: Package functions as described.

     (based on tests passing)

[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-environs-9.3.2-2.fc35.noarch.rpm
          python3-environs+django-9.3.2-2.fc35.noarch.rpm
          python-environs-9.3.2-2.fc35.src.rpm
python3-environs+django.noarch: W: spelling-error Summary(en_US) Metapackage -> Meta package, Meta-package, Prepackage
python3-environs+django.noarch: W: spelling-error Summary(en_US) django -> fandango
python3-environs+django.noarch: W: spelling-error %description -l en_US metapackage -> meta package, meta-package, prepackage
python3-environs+django.noarch: W: spelling-error %description -l en_US django -> fandango
python3-environs+django.noarch: W: no-documentation
3 packages and 0 specfiles checked; 0 errors, 5 warnings.




Rpmlint (installed packages)
----------------------------
Cannot parse rpmlint output:


Source checksums
----------------
https://github.com/sloria/environs/archive/9.3.2/environs-9.3.2.tar.gz :
  CHECKSUM(SHA256) this package     : d42de600d83caea19b0f0cda1b2dec774481d934c7c7e264f8672b26d196b3f3
  CHECKSUM(SHA256) upstream package : d42de600d83caea19b0f0cda1b2dec774481d934c7c7e264f8672b26d196b3f3


Requires
--------
python3-environs (rpmlib, GLIBC filtered):
    python(abi)
    python3.10dist(marshmallow)
    python3.10dist(python-dotenv)

python3-environs+django (rpmlib, GLIBC filtered):
    python(abi)
    python3-environs
    python3.10dist(dj-database-url)
    python3.10dist(dj-email-url)
    python3.10dist(django-cache-url)



Provides
--------
python3-environs:
    python-environs
    python3-environs
    python3.10-environs
    python3.10dist(environs)
    python3dist(environs)

python3-environs+django:
    python-environs+django
    python3-environs+django
    python3.10-environs+django
    python3.10dist(environs[django])
    python3dist(environs[django])



Generated by fedora-review 0.7.6 (b083f91) last change: 2020-11-10
Command line :/usr/bin/fedora-review -b 1974114
Buildroot used: fedora-rawhide-x86_64
Active plugins: Shell-api, Python, Generic
Disabled plugins: Perl, PHP, SugarActivity, C/C++, Ruby, fonts, R, Haskell, Java, Ocaml
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 6 Gwyn Ciesla 2021-06-23 18:32:02 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-environs

Comment 7 Fedora Update System 2021-06-24 17:51:46 UTC
FEDORA-2021-c3669c1600 has been submitted as an update to Fedora 34. https://bodhi.fedoraproject.org/updates/FEDORA-2021-c3669c1600

Comment 8 Fedora Update System 2021-06-25 01:27:34 UTC
FEDORA-2021-c3669c1600 has been pushed to the Fedora 34 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2021-c3669c1600 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2021-c3669c1600

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 9 Fedora Update System 2021-07-03 01:24:59 UTC
FEDORA-2021-c3669c1600 has been pushed to the Fedora 34 stable repository.
If problem still persists, please make note of it in this bug report.


Note You need to log in before you can comment on or make changes to this bug.