Bug 1664384 - Review Request: python-yaspin - library for terminal spinners
Summary: Review Request: python-yaspin - library for terminal spinners
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Miro Hrončok
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 1671790
TreeView+ depends on / blocked
 
Reported: 2019-01-08 15:57 UTC by Patrik Kopkan
Modified: 2019-03-05 14:58 UTC (History)
2 users (show)

Fixed In Version: python-yaspin-0.14.0-4.fc30
Clone Of:
Environment:
Last Closed: 2019-03-05 14:58:10 UTC
Type: ---
Embargoed:
mhroncok: fedora-review+


Attachments (Terms of Use)

Description Patrik Kopkan 2019-01-08 15:57:17 UTC
Spec URL: https://github.com/PatrikKopkan/rpm_yasmin/blob/master/python-yaspin.spec
SRPM URL: https://github.com/PatrikKopkan/rpm_yasmin/blob/master/python-yaspin-0.14.0-1.fc29.src.rpm
Description: Yet Another Terminal Spinner for Python.

Yaspin provides a full-featured terminal spinner to show the progress during long-hanging operations.
Fedora Account System Username: pkopkan

Comment 1 Miro Hrončok 2019-01-10 13:39:32 UTC
Patrik needs a sponsor. I'll work with him to get him sponsored.

First thing first: there are automated tools (fedora-review) that parse this bugzilla and search for SPEC and SRPM links. The links however doesn't link to the spec/SRPM but to a HTML page, this can confuse the tool. Use the gihub "raw" link like this:

Spec URL: https://github.com/PatrikKopkan/rpm_yasmin/raw/master/python-yaspin.spec
SRPM URL: https://github.com/PatrikKopkan/rpm_yasmin/raw/master/python-yaspin-0.14.0-1.fc29.src.rpm

Comment 2 Miro Hrončok 2019-01-10 14:00:40 UTC
Also a typo:

  $install
  %py3_install

And

  Requires:	python3

This is not required and actually counterproductive. RPM will create automatic requirement on the specific Python version that is needed. Explore the built RPM with `rpm -qp --requires`.

Comment 3 Patrik Kopkan 2019-01-10 16:24:41 UTC
Spec URL: https://github.com/PatrikKopkan/rpm_yasmin/raw/master/python-yaspin.spec
SRPM URL: https://github.com/PatrikKopkan/rpm_yasmin/raw/master/python-yaspin-0.14.0-3.fc29.src.rpm

Thank you for help. I hope now it will be allright.

Comment 4 Miro Hrončok 2019-01-10 16:53:43 UTC
Several style issues:

 1. While technically tabs are fine, I think (especially in Pythonh spec files), you should stick to spaces. Also, there is some trailing whitespace.
 2. "PyPi library" isn't quite right. (It is spell PyPI and I'd prefer "Python library").
 3. You can use %{summary} for the contents of the second summary to DRY.
 4. Your description lines must not exceed 80 characters. If a line is exceeding this number, cut it to fit in two lines. (Use the rpmlint tool on the source rpm or the built rpm to get this info.)
 5. The "many tests are skipped" doesn't sound very useful, but that's not a strong opinion.

Technical issue:

 1. The package uses setuptools at build. Better BuildRequire python3-setuptools explicitly.


Everything else looks quite good, will do some more testing and checks.

Comment 5 Miro Hrončok 2019-01-13 10:44:57 UTC
Package Review
==============

There's a typo:

    %[summary] -> %{summary}

Also, please upload new SRPM and provide new links if they have changed.

Everything else looks fine!


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


===== 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.
[x]: Macros in Summary, %description expandable at SRPM build time.
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[-]: 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.
[-]: 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]: 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]: 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).
[?]: Package functions as described.
[?]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[?]: 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:
[!]: Spec file according to URL is the same as in SRPM.
     Note: Spec file as given by url is not the same as in SRPM (see
     attached diff).
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).


Rpmlint
-------
Checking: python3-yaspin-0.14.0-3.fc30.noarch.rpm
          python-yaspin-0.14.0-3.fc30.src.rpm
python3-yaspin.noarch: E: description-line-too-long C Yaspin provides a full-featured terminal spinner to show the progress during long-hanging operations.
python-yaspin.src: E: description-line-too-long C Yaspin provides a full-featured terminal spinner to show the progress during long-hanging operations.
2 packages and 0 specfiles checked; 2 errors, 0 warnings.



Requires
--------
python3-yaspin (rpmlib, GLIBC filtered):
    python(abi)



Provides
--------
python3-yaspin:
    python3-yaspin
    python3.7dist(yaspin)
    python3dist(yaspin)



Source checksums
----------------
https://github.com/pavdmyt/yaspin/archive/v0.14.0.tar.gz :
  CHECKSUM(SHA256) this package     : a9749ff4b6762a0bd0dbff1467ee287fd38b4958b212b9baacbb700a84463418
  CHECKSUM(SHA256) upstream package : a9749ff4b6762a0bd0dbff1467ee287fd38b4958b212b9baacbb700a84463418

Comment 8 Miro Hrončok 2019-01-14 11:21:39 UTC
(hit Save Chanegs too early)

Good job. Package approved.

Let me know if you understand every complaint I had and if there is any part of the spec (or the process) that you feel like you don't understand.

As for your sponsorship: Please continue with more packages. Also, start looking for packages you can review, let me know if you'd like some reading materials about what shall you review and how.

Comment 9 Miro Hrončok 2019-02-12 13:11:37 UTC
Patrik is now sponsored.

Comment 10 Gwyn Ciesla 2019-02-12 15:31:24 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-yaspin

Comment 11 Miro Hrončok 2019-02-13 09:14:53 UTC
Patrik, if you don't mind, please add the python-sig group as a committer to the package. See https://fedoraproject.org/wiki/SIGs/Python#Python_SIG_FAS_group for details.


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