Note: This is a public test instance of Red Hat Bugzilla. The data contained within is a snapshot of the live data so any changes you make will not be reflected in the production Bugzilla. Email is disabled so feel free to test any aspect of the site that you want. File any problems you find or give feedback at bugzilla.redhat.com.
Bug 2008153 - Review Request: pyplane - Python package for Phase plane analysis of nonlinear systems
Summary: Review Request: pyplane - Python package for Phase plane analysis of nonlinea...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Ankur Sinha (FranciscoD)
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
: 2047254 (view as bug list)
Depends On:
Blocks: fedora-neuro, NeuroFedora
TreeView+ depends on / blocked
 
Reported: 2021-09-27 12:49 UTC by Shane Allcroft
Modified: 2022-04-11 13:29 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-04-11 13:29:47 UTC
Type: Bug
Embargoed:
sanjay.ankur: fedora-review+


Attachments (Terms of Use)

Description Shane Allcroft 2021-09-27 12:49:18 UTC
Spec URL: https://shaneallcroft.fedorapeople.org/pyplane.spec
SRPM URL: https://shaneallcroft.fedorapeople.org/pyplane-2.0.0-1.fc33.src.rpm
.desktop URL (WIP): https://shaneallcroft.fedorapeople.org/pyplane.desktop


Description: 

PyPlane is a free software for phase plane analysis of second order dynamical
systems written in PYTHON and PyQT5. Comparable to MATLAB's pplane.


Fedora Account System Username: shaneallcroft

Comment 2 Ankur Sinha (FranciscoD) 2021-09-27 17:37:14 UTC
Looks very good. A few fixes needed before we can approve it. Please make the fixes, and then upload the updated spec/srpm and provide there links and then we'll do another round of review:

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

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


Issues:
=======
- Dist tag is present.
^
Your release should either be %autorelease, or 1%{?dist}.
The dist tag is mandatory:
https://docs.fedoraproject.org/en-US/packaging-guidelines/DistTag/


- Hrm, licensecheck reports that two files are GPLv3, not GPLv3+, so I guess we
  should go back to GPLv3 here.

- Upstream does not ship a desktop file, so we should add one and send it upstream

- (optional, but good to have) Upstream does not include a appstream metainfo file, so we should add one and send it upstream too.
https://docs.fedoraproject.org/en-US/packaging-guidelines/AppData/

- some rpmlint warnings need to be fixed (see below)

===== 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.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "*No copyright* GNU General Public
     License, Version 3", "GNU General Public License v3.0 or later", "GNU
     General Public License, Version 3", "*No copyright* [generated file]".
     48 files have unknown license. Detailed output of licensecheck in
     /home/asinha/dump/fedora-reviews/2008153-pyplane/licensecheck.txt

^
Two files are GPLv3, not GPLv3+, so we should go back to GPLv3 (which you'd
initially used).

[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.
^
I see upstream does not ship a desktop file.
We should write one and send it upstream:
https://docs.fedoraproject.org/en-US/packaging-guidelines/#_desktop_files

[-]: 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.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 bytes in 2 files.
[!]: Package complies to the Packaging Guidelines
^
Some notes

[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.
[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.
[-]: 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).
[?]: Package functions as described.
^
Not tested this yet.

[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
-------

rpmlint *rpm ../srpm-unpacked/*
checks: 31, packages: 4

pyplane.spec:37: W: unversioned-explicit-provides python3-pyplane
pyplane.spec:37: W: unversioned-explicit-provides python3-pyplane
pyplane.noarch: W: no-manual-page-for-binary pyplane
pyplane.spec:68: W: mixed-use-of-spaces-and-tabs (spaces: line 9, tab: line 68)
pyplane.spec:68: W: mixed-use-of-spaces-and-tabs (spaces: line 9, tab: line 68)
^
tab at the end of the changelog line

pyplane.noarch: W: incoherent-version-in-changelog 2.0.0-1       ['2.0.0-1', '2.0.0-1']
^
I think the changelog issue is because of the missing dist-tag

Source checksums
----------------
https://github.com/TUD-RST/pyplane/archive/PyPlane_v2.0.0/pyplane-PyPlane_v2.0.0.tar.gz :
  CHECKSUM(SHA256) this package     : e860febb008f69bb82dff9c29610d9967335f812f485eaec57923d282cfd1f93
  CHECKSUM(SHA256) upstream package : e860febb008f69bb82dff9c29610d9967335f812f485eaec57923d282cfd1f93


Requires
--------
pyplane (rpmlib, GLIBC filtered):
    /usr/bin/python3
    python(abi)
    python3.10dist(matplotlib)
    python3.10dist(numpy)
    python3.10dist(pyqt5)
    python3.10dist(scipy)
    python3.10dist(sympy)



Provides
--------
pyplane:
    pyplane
    python3-pyplane
    python3.10dist(pyplane)
    python3dist(pyplane)



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

Comment 3 Shane Allcroft 2021-10-07 15:39:55 UTC
vvvvv Updated links vvvvv
Spec URL      : https://shaneallcroft.fedorapeople.org/pyplane.spec
SRPM URL      : https://shaneallcroft.fedorapeople.org/pyplane-2.0.0-1.fc33.src.rpm
.desktop URL  : https://shaneallcroft.fedorapeople.org/pyplane.desktop
.metainfo URL : https://shaneallcroft.fedorapeople.org/pyplane.metainfo.xml


Okay .metainfo created, here's some updated links, will also push relevant files to the pyplane pagure.io repo. Running a mock build now

Comment 4 Shane Allcroft 2022-01-12 17:19:39 UTC
vvvvv Updated links vvvvv

Spec URL          : https://shaneallcroft.fedorapeople.org/pyplane.spec
SRPM URL          : https://shaneallcroft.fedorapeople.org/pyplane-2.0.1-1.20220112gitrelease.fc33.src.rpm

(.desktop and .metainfo are part of the repo now so there's no need for them to have links :) )

Comment 5 Ankur Sinha (FranciscoD) 2022-01-14 11:37:27 UTC
Thanks, on my list. Removing needinfo flag.

Comment 6 Ankur Sinha (FranciscoD) 2022-01-16 15:49:53 UTC
Hrm, your spec and srpm don't match. Can you please remove the text after the %changelog and regenerate the srpm?

Comment 7 Shane Allcroft 2022-01-18 07:45:14 UTC
Oh whoops, I sent that message in the irc I think, not sure how it found it's way into my .spec, a spurious middle-mouse click I suspsect. Anyway it should be good now! Thank you

Comment 8 Ankur Sinha (FranciscoD) 2022-01-18 09:12:43 UTC
Looks very good. A few minor tweaks that can be made before the import are noted below. Please request SCM, and then ping me when you're ready to import. There's a bit of hackery needed to import packages correctly when using autorelease etc.

XXX APPROVED XXX


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

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


Issues:
=======
- Dist tag is present.

- desktop-file-utils are always required, irrespective of whether tests are enabled or not, so its BR should be out of the conditioanl block

- we can now remove the Source2/3 declarations from the spec.

- we need to version the Provides (see rpmlint section below)


===== 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", "*No copyright* GNU General Public
     License, Version 3", "GNU General Public License v3.0 or later", "GNU
     General Public License, Version 3", "*No copyright* [generated file]".
     50 files have unknown license. Detailed output of licensecheck in
     /home/asinha/dump/fedora-reviews/2008153-pyplane/licensecheck.txt
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: 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.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 bytes in 2 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 contains desktop file if it is a GUI application.
[x]: Package installs a %{name}.desktop using desktop-file-install or
     desktop-file-validate if there is such a file.
[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.
[-]: 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).
[?]: Package functions as described.
^
Not tested

[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
-------

rpmlint *.rpm

- pyplane.spec:42: W: unversioned-explicit-provides python3-pyplane
^
we should fix this, by making the provides versioned like this:

Provides:       python3-pyplane = %{version}-%{release}

- pyplane.noarch: W: no-manual-page-for-binary pyplane
^
this is fine.


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


Source checksums
----------------
https://github.com/TUD-RST/pyplane/archive/PyPlane_v2.0.1/pyplane-PyPlane_v2.0.1.tar.gz :
  CHECKSUM(SHA256) this package     : a5250694c6e4227f1209f00c6a3e6e425793d7e179b7b5218452f5ea7753cbdf
  CHECKSUM(SHA256) upstream package : a5250694c6e4227f1209f00c6a3e6e425793d7e179b7b5218452f5ea7753cbdf


Requires
--------
pyplane (rpmlib, GLIBC filtered):
    /usr/bin/python3
    python(abi)
    python3.10dist(appdirs)
    python3.10dist(matplotlib)
    python3.10dist(numpy)
    python3.10dist(pyqt5)
    python3.10dist(scipy)
    python3.10dist(sympy)



Provides
--------
pyplane:
    application()
    application(pyplane.desktop)
    pyplane
    python3-pyplane
    python3.10dist(pyplane)
    python3dist(pyplane)



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

Comment 9 Ankur Sinha (FranciscoD) 2022-01-27 09:16:20 UTC
Shane, please use these instructions to import the package (and please ping me if they don't apply somewhere):

https://pagure.io/fedora-docs/package-maintainer-docs/issue/56

Comment 10 Shane Allcroft 2022-01-27 13:23:25 UTC
*** Bug 2047254 has been marked as a duplicate of this bug. ***

Comment 11 Gwyn Ciesla 2022-01-27 14:32:24 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/pyplane


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