Bug 2016661 - Review Request: python-geomdl - Object-oriented pure Python B-Spline and NURBS library
Summary: Review Request: python-geomdl - Object-oriented pure Python B-Spline and NURB...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Maxwell G
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-10-22 15:32 UTC by Ben Beasley
Modified: 2022-01-16 00:57 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2022-01-06 18:12:42 UTC
Type: ---
Embargoed:
maxwell: fedora-review+


Attachments (Terms of Use)

Description Ben Beasley 2021-10-22 15:32:35 UTC
Spec URL: https://music.fedorapeople.org/python-geomdl.spec
SRPM URL: https://music.fedorapeople.org/python-geomdl-5.3.1-1.fc34.src.rpm
Description:

NURBS-Python (geomdl) is a pure Python, self-contained, object-oriented
B-Spline and NURBS spline library for Python versions 2.7.x, 3.4.x and later.

NURBS-Python (geomdl) provides convenient data structures and highly
customizable API for rational and non-rational splines along with the efficient
and extensible implementations of the following algorithms:

  • Spline evaluation
  • Derivative evaluation
  • Knot insertion
  • Knot removal
  • Knot vector refinement
  • Degree elevation
  • Degree reduction
  • Curve and surface fitting via interpolation and least squares approximation

NURBS-Python (geomdl) also provides customizable visualization and animation
options via Matplotlib, Plotly and VTK libraries. Please refer to the
documentation (http://nurbs-python.readthedocs.io/) for more details.

Fedora Account System Username: music

Koji scratch builds:

F36: https://koji.fedoraproject.org/koji/taskinfo?taskID=77659743
F35: https://koji.fedoraproject.org/koji/taskinfo?taskID=77660005
F34: https://koji.fedoraproject.org/koji/taskinfo?taskID=77660029
F33: https://koji.fedoraproject.org/koji/taskinfo?taskID=77660039

Comment 1 Ben Beasley 2021-10-22 15:35:22 UTC
I just noticed the F33 scratch build failed. I’ll just ignore that release, which is nearly EOL anyway.

Comment 2 Ben Beasley 2021-10-22 15:36:45 UTC
This package is mostly straightforward, for a Cython extension package with Sphinx PDF documentation. (While the description advertises pure Python, the core algorithms are optionally Cythonized for performance.)

Comment 3 Maxwell G 2021-12-28 04:53:37 UTC
Your specfile looks great! Thank you for putting in the time to figure out the documentation. I just have a couple minor notes/questions.

Notes
=====

> %package        doc
> Summary:        Documentation for geomdl
> # From docs/citing.txt:
> #   * Source code is released under the terms of the MIT License
> #   * Examples are released under the terms of the MIT License
> #   * Documentation is released under the terms of CC BY 4.0
> License:        CC-BY

The MIT-licensed examples are not included in the docs package, correct? Also, docs/citing.txt should be docs/citing.rst.

I would add a weak dependency on the doc subpackage in the python3 subpackage so that it's more discoverable. That's really up to you.

It looks like you are including the license in both subpackages and not having the doc subpackage depend on the python3 subpackage to allow users to install one but not the other.

> BuildRequires:  %{py3_dist pytest} >= 3.6.0

Is there a reason you use the `%py3_dist` macro here and use py3dist() everywhere else? I know that `%py3_dist` expands to `py3dist(NAME)`, but you should probably remain conistent. Upstream provides a tox env that you can use if you prefer.



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

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


Issues:
=======
- Dist tag is present.
This spec uses rpmautospec.


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

C/C++:
[x]: Development (unversioned) .so files in -devel subpackage, if present.
     Note: Unversioned so-files in private %_libdir subdirectory (see
     attachment). Verify they are not in ld path.

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* MIT License", "MIT
     License", "*No copyright* MIT License Creative Commons Attribution
     4.0". 155 files have unknown license. Detailed output of licensecheck
     in /home/gotmax/Sync/git-
     repos/packaging/fedora_rpms/review.repos/2016661-python-
     geomdl/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
    Yes, they are. See my note above.

[x]: %build honors applicable compiler flags or justifies otherwise.
[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]: Useful -debuginfo package or justification otherwise.
[x]: Package is not known to require an ExcludeArch tag.
[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.
[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]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 0 bytes in 0 files.
[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).
[x]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python3-geomdl
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.
[-]: 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.
[?]: 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]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Cannot parse rpmlint output:


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


Unversioned so-files
--------------------
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/BSpline.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/CPGen.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/NURBS.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/_convert.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/_exchange.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/_linalg.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/_operations.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/_tessellate.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/_utilities.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/_voxelize.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/abstract.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/compatibility.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/construct.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/control_points.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/convert.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/elements.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/evaluators.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/exceptions.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/exchange.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/exchange_vtk.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/fitting.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/freeform.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/functools_lru_cache.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/helpers.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/knotvector.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/linalg.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/multi.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/operations.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/ray.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/shortcuts.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/sweeping.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/tessellate.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/trimming.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/utilities.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/vis.cpython-310-x86_64-linux-gnu.so
python3-geomdl: /usr/lib64/python3.10/site-packages/geomdl/core/voxelize.cpython-310-x86_64-linux-gnu.so

Source checksums
----------------
https://github.com/orbingol/NURBS-Python/archive/v5.3.1/NURBS-Python-5.3.1.tar.gz :
  CHECKSUM(SHA256) this package     : a9a7c5830294a90aa4d5249c9bb4741075816087ff2484b68ee08c93c80bda56
  CHECKSUM(SHA256) upstream package : a9a7c5830294a90aa4d5249c9bb4741075816087ff2484b68ee08c93c80bda56


Requires
--------
python3-geomdl (rpmlib, GLIBC filtered):
    libc.so.6()(64bit)
    python(abi)
    rtld(GNU_HASH)

python-geomdl-doc (rpmlib, GLIBC filtered):

python-geomdl-debugsource (rpmlib, GLIBC filtered):



Provides
--------
python3-geomdl:
    python-geomdl
    python3-geomdl
    python3-geomdl(x86-64)
    python3.10-geomdl
    python3.10dist(geomdl)
    python3dist(geomdl)

python-geomdl-doc:
    python-geomdl-doc

python-geomdl-debugsource:
    python-geomdl-debugsource
    python-geomdl-debugsource(x86-64)



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

Comment 4 Ben Beasley 2021-12-28 13:23:07 UTC
Thanks for the review!

(In reply to Maxwell G from comment #3)
> Your specfile looks great! Thank you for putting in the time to figure out
> the documentation. I just have a couple minor notes/questions.
> 
> Notes
> =====
> 
> > %package        doc
> > Summary:        Documentation for geomdl
> > # From docs/citing.txt:
> > #   * Source code is released under the terms of the MIT License
> > #   * Examples are released under the terms of the MIT License
> > #   * Documentation is released under the terms of CC BY 4.0
> > License:        CC-BY
> 
> The MIT-licensed examples are not included in the docs package, correct?

Correct, those are in a separate repository[1] that is not packaged. I’ll modify the comment to mention that fact.

[1] https://github.com/orbingol/geomdl-examples

> Also, docs/citing.txt should be docs/citing.rst.

Good catch. I will fix that.

> I would add a weak dependency on the doc subpackage in the python3
> subpackage so that it's more discoverable. That's really up to you.

I appreciate the suggestion. I’d prefer not to add a weak dependency (Recommends:) because if I do, the documentation will be pulled in whenever the python3-geomdl package is installed unless the user specifically asks not to (dnf --setopt=install_weak_deps=False). I think that defeats most of the purpose of separate documentation packages—noting that the documentation is (packed) twice the size of the library, and considering that this will happen even if the package is installed only as a dependency.

I’m happy to add a hint (Suggests:), although I’m not sure if any widely used package management tool actually uses those.

> It looks like you are including the license in both subpackages and not
> having the doc subpackage depend on the python3 subpackage to allow users to
> install one but not the other.

> 
> > BuildRequires:  %{py3_dist pytest} >= 3.6.0
> 
> Is there a reason you use the `%py3_dist` macro here and use py3dist()
> everywhere else? I know that `%py3_dist` expands to `py3dist(NAME)`, but you
> should probably remain conistent. Upstream provides a tox env that you can
> use if you prefer.

No, there’s no reason. I would rather use python3dist() everywhere.

I revisited this and observed that %tox does work quite well in this package—sometimes it’s a struggle to get it to do *only* what is needed for an RPM build, and direct pytest invocation is easier—so I’ll just switch to that, saving the explicit pytest BR.

Comment 5 Ben Beasley 2021-12-28 13:48:11 UTC
- Switched from %pytest to %tox; all manual BR’s now consistently use python3dist()
- Added a note that the examples are in a separate repository and not packaged here
- Changed “docs/citing.txt” to “docs/citing.rst”
- Added a hint (Suggests:) from python3-geomdl to python-geomdl-doc

New spec URL: https://music.fedorapeople.org/20211228/python-geomdl.spec
New SRPM URL: https://music.fedorapeople.org/20211228/python-geomdl-5.3.1-1.fc35.src.rpm

New scratch builds:

F36: https://koji.fedoraproject.org/koji/taskinfo?taskID=80566264
F35: https://koji.fedoraproject.org/koji/taskinfo?taskID=80566265
F34: https://koji.fedoraproject.org/koji/taskinfo?taskID=80566266

Comment 6 Maxwell G 2021-12-28 23:23:42 UTC
I approved your package! It would be great if you could look at either of my review requests[1,2], but no pressure :).

[1]: https://bugzilla.redhat.com/show_bug.cgi?id=2028702
[2]: https://bugzilla.redhat.com/show_bug.cgi?id=2035685

Comment 7 Ben Beasley 2021-12-29 11:50:19 UTC
Thanks for the review!

I’m happy to take a look at one or more of your review requests, although I will be away from a suitable computer for a few days.

Comment 8 Gwyn Ciesla 2022-01-06 15:36:27 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-geomdl

Comment 9 Fedora Update System 2022-01-06 18:11:42 UTC
FEDORA-2022-9e81206e05 has been submitted as an update to Fedora 36. https://bodhi.fedoraproject.org/updates/FEDORA-2022-9e81206e05

Comment 10 Fedora Update System 2022-01-06 18:12:42 UTC
FEDORA-2022-9e81206e05 has been pushed to the Fedora 36 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 11 Fedora Update System 2022-01-07 00:02:11 UTC
FEDORA-2022-5f443c0412 has been submitted as an update to Fedora 35. https://bodhi.fedoraproject.org/updates/FEDORA-2022-5f443c0412

Comment 12 Fedora Update System 2022-01-07 00:32:51 UTC
FEDORA-2022-7be4ddaf90 has been submitted as an update to Fedora 34. https://bodhi.fedoraproject.org/updates/FEDORA-2022-7be4ddaf90

Comment 13 Fedora Update System 2022-01-07 01:23:02 UTC
FEDORA-2022-5f443c0412 has been pushed to the Fedora 35 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2022-5f443c0412 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2022-5f443c0412

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

Comment 14 Fedora Update System 2022-01-08 01:09:08 UTC
FEDORA-2022-7be4ddaf90 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-2022-7be4ddaf90 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2022-7be4ddaf90

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

Comment 15 Fedora Update System 2022-01-15 01:21:00 UTC
FEDORA-2022-5f443c0412 has been pushed to the Fedora 35 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 16 Fedora Update System 2022-01-16 00:57:12 UTC
FEDORA-2022-7be4ddaf90 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.