Bug 2023009 - Review Request: python-shtab - Automagic shell tab completion for Python CLI applications
Summary: Review Request: python-shtab - Automagic shell tab completion for Python CLI ...
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Mohamed El Morabity
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 2024089
TreeView+ depends on / blocked
 
Reported: 2021-11-13 22:37 UTC by Mikel Olasagasti Uranga
Modified: 2021-11-18 21:26 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-11-18 21:26:21 UTC
Type: ---
Embargoed:
pikachu.2014: fedora-review+


Attachments (Terms of Use)

Description Mikel Olasagasti Uranga 2021-11-13 22:37:42 UTC
Spec URL: https://mikel.olasagasti.info/tmp/fedora/python-shtab.spec
SRPM URL: https://mikel.olasagasti.info/tmp/fedora/python-shtab-1.4.2-1.fc35.src.rpm
Description: Automagic shell tab completion for Python CLI applications
Fedora Account System Username: mikelo2

Comment 1 Mohamed El Morabity 2021-11-18 14:39:22 UTC
The SPEC file looks quite good and follows the latest Python packaging guidelines.

Just one suggestion (nothing mandatory for this review): you should use the %py3_dist macro for explicit Python dependencies, for example %{py3_dist pytest} instead of python3-pytest. This makes dependency tracking easier, based on PyPi names. This may be useful also in case of naming convention changes for Python packages.

Notice also that a newer version 1.5.0 is available for two days.


Here is the review.


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

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


===== 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.
[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 20480 bytes in 1 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]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package must not depend on deprecated() packages.
[-]: 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]: 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

===== 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).
[x]: Package functions as described.
     Note: tested with streamlink to build completion files.
[!]: Latest version is packaged.
     Note: version 1.5.0 was released on 16 November.
[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.
[?]: 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
-------
python3-shtab.noarch: W: no-manual-page-for-binary shtab
python-shtab.spec:51: W: macro-in-%changelog %autochangelog

Note: no action required.


Source checksums
----------------
https://files.pythonhosted.org/packages/source/s/shtab/shtab-1.4.2.tar.gz :
  CHECKSUM(SHA256) this package     : a11f296bf149df2c1cc781941e485191298ad1b745dc11d01cb226c555aff7cb
  CHECKSUM(SHA256) upstream package : a11f296bf149df2c1cc781941e485191298ad1b745dc11d01cb226c555aff7cb


Requires
--------
python3-shtab (rpmlib, GLIBC filtered):
    /usr/bin/python3
    python(abi)



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



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

This package is APPROVED.

Comment 2 Mikel Olasagasti Uranga 2021-11-18 14:56:08 UTC
Thanks for the review Mohamed!

I'll switch python3-pytest to python3dist(pytest) and update to 1.5.0 when the repo is created. 

As you added a blocker for another package, do you need shtab for F35 and F34?

Comment 3 Mohamed El Morabity 2021-11-18 15:08:38 UTC
(In reply to Mikel Olasagasti Uranga from comment #2)
> As you added a blocker for another package, do you need shtab for F35 and
> F34?

Yes, I'll need shtab to update python-streamlink, for F34 and F35. Thanks in advance :)

Comment 4 Gwyn Ciesla 2021-11-18 16:50:50 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-shtab


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