Bug 1695373 - Review Request: python-ics - Intrepidcs icsneo40 Python API/Wrapper
Summary: Review Request: python-ics - Intrepidcs icsneo40 Python API/Wrapper
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-04-03 00:05 UTC by Scott K Logan
Modified: 2019-04-09 00:25 UTC (History)
3 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2019-04-09 00:25:56 UTC
Type: ---
Embargoed:
eclipseo: fedora-review?


Attachments (Terms of Use)

Description Scott K Logan 2019-04-03 00:05:06 UTC
Spec URL: https://cottsay.fedorapeople.org/python-ics/python-ics.spec
SRPM URL: https://cottsay.fedorapeople.org/python-ics/python-ics-3.0-1.fc31.src.rpm

Description:
Python C Code module for interfacing to the icsneo40 dynamic library. Code tries
to respect PEP 8 (https://www.python.org/dev/peps/pep-0008/). Function naming
convention does not follow the tradition c style icsneo40 naming convention as
the python_ics module name acts as the namespace (icsneo portion of the
function) and function names are suppose to be lowercase with underscores
instead of mixedCase like icsneo API.

Fedora Account System Username: cottsay

Target branches: f28 f29 f30

Koji scratch build: https://koji.fedoraproject.org/koji/taskinfo?taskID=33899763

rpmlint output:
python-ics.src: W: spelling-error Summary(en_US) Intrepidcs -> Intrepid cs, Intrepid-cs, Intrepid
python-ics.src: W: spelling-error %description -l en_US icsneo -> iciness
python-ics.src: W: spelling-error %description -l en_US mixedCase -> mixed Case, mixed-Case, mixed-case
python-ics-doc.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/python-ics-doc/html/objects.inv
python-ics-doc.noarch: W: file-not-utf8 /usr/share/doc/python-ics-doc/html/objects.inv
python3-ics.x86_64: W: spelling-error %description -l en_US icsneo -> iciness
python3-ics.x86_64: W: spelling-error %description -l en_US mixedCase -> mixed Case, mixed-Case, mixed-case
5 packages and 1 specfiles checked; 0 errors, 7 warnings.

Notes:
- The full license text is included in the README.md (for whatever reason)
- The included tests require a device to be present, so are not helpful here

Comment 1 Dan Čermák 2019-04-04 10:43:38 UTC
A few comments:

- you can drop the %{python3_pkgversion} macro, as that evaluates to 3

- don't hardcode the manual page's file extension in %files: %{_mandir}/man1/%{srcname}.1.gz => %{_mandir}/man1/%{srcname}.1.*

- you can use the %py3_dist macro to pull in python packages like this: 
  BuildRequires:  %{py3_dist sphinx}

- consider defining the description text via a separate macro, so that you don't have to copy&paste it

- I'll check whether it's ok to include the README.md as %license, but consider reporting this as an issue upstream anyway

Comment 2 Dan Čermák 2019-04-04 21:57:40 UTC
(In reply to dan.cermak from comment #1)
> - I'll check whether it's ok to include the README.md as %license, but
> consider reporting this as an issue upstream anyway

I've checked the guidelines and packaging README.md as %license is not ok, please drop that line.

Comment 3 Robert-André Mauchin 🐧 2019-04-04 23:52:53 UTC
(In reply to dan.cermak from comment #1)
> A few comments:
> 
> - you can drop the %{python3_pkgversion} macro, as that evaluates to 3
> 

Not on EPEL.

 - Group is not used in Fedora

 - %license README.md 

No. Ask upstream for a proper license file. Or split it off the README:

sed -e '0,/^# License - MIT/d' README.md > LICENSE

 - Use install -p to keep timestamps

Comment 4 Scott K Logan 2019-04-08 23:42:13 UTC
Thank you both for your feedback, I have incorporated most of your suggestions.

The only exception is that I'd like to elect to continue using %{python3_pkgversion} and not using %{py3dist foo} to maintain EPEL compatibility and maintain a uniform pattern across the packages I maintain. Even though the dependencies aren't currently available, I may pursue adding EPEL support in the future if there is desire.

Spec URL: https://cottsay.fedorapeople.org/python-ics/python-ics.spec
SRPM URL: https://cottsay.fedorapeople.org/python-ics/python-ics-3.0-2.fc31.src.rpm

Koji scratch build: https://koji.fedoraproject.org/koji/taskinfo?taskID=34064077

Comment 5 Robert-André Mauchin 🐧 2019-04-09 00:01:00 UTC
 - Package is not installable:

DEBUG util.py:554:  BUILDSTDERR: Error: 
DEBUG util.py:554:  BUILDSTDERR:  Problem: conflicting requests
DEBUG util.py:554:  BUILDSTDERR:   - nothing provides icsneoapi needed by python3-ics-3.0-2.fc31.x86_64
DEBUG util.py:556:  (try to add '--skip-broken' to skip uninstallable packages or '--nobest' to use not only best candidate packages)
DEBUG util.py:698:  Child return code was: 1

 - Bump to version 3.1 released 3 days ago

 - Run tests:

%check
%{__python3} setup.py test

 - Use %global not %define:

%global _description \




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

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


Issues:
=======
- Package installs properly.
  Note: Installation errors (see attachment)
  See: https://docs.fedoraproject.org/en-US/packaging-guidelines/


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

C/C++:
[x]: Package does not contain kernel modules.
[x]: Package contains no static executables.
[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.
[x]: If your application is a C or C++ application you must list a
     BuildRequires against gcc, gcc-c++ or clang.
[x]: Header files in -devel subpackage, if present.
[x]: Package does not contain any libtool archives (.la)
[x]: Rpath absent or only used for internal libs.

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: "Expat License", "Unknown or generated", "BSD 2-clause
     "Simplified" License". 99 files have unknown license. Detailed output
     of licensecheck in /home/bob/packaging/review/python-ics/review-
     python-ics/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[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]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 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]: 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 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]: 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:
[-]: Avoid bundling fonts in non-fonts packages.
     Note: Package contains font files
[-]: 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-ics
[?]: Package functions as described.
[!]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: 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.
[!]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[!]: Spec use %global instead of %define unless justified.
     Note: %define requiring justification: %define _description Python C
     Code module for interfacing to the icsneo40 dynamic library. Code
     triesto respect PEP 8 (https://www.python.org/dev/peps/pep-0008/).
     Function namingconvention does not follow the tradition c style
     icsneo40 naming convention asthe python_ics module name acts as the
     namespace (icsneo portion of thefunction) and function names are
     suppose to be lowercase with underscoresinstead of mixedCase like
     icsneo API.
[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.

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

Generic:
[!]: Rpmlint is run on all installed packages.
     Note: Mock build failed
     See: https://docs.fedoraproject.org/en-US/packaging-
     guidelines/#_use_rpmlint
[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
-------
Checking: python-ics-doc-3.0-2.fc31.noarch.rpm
          python3-ics-3.0-2.fc31.x86_64.rpm
          python-ics-debugsource-3.0-2.fc31.x86_64.rpm
          python-ics-3.0-2.fc31.src.rpm
python-ics-doc.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/python-ics-doc/html/objects.inv
python-ics-doc.noarch: W: file-not-utf8 /usr/share/doc/python-ics-doc/html/objects.inv
python3-ics.x86_64: W: spelling-error %description -l en_US icsneo -> iciness
python3-ics.x86_64: W: spelling-error %description -l en_US mixedCase -> mixed Case, mixed-Case, mixed-case
python-ics.src: W: spelling-error Summary(en_US) Intrepidcs -> Intrepid cs, Intrepid-cs, Intrepid
python-ics.src: W: spelling-error %description -l en_US icsneo -> iciness
python-ics.src: W: spelling-error %description -l en_US mixedCase -> mixed Case, mixed-Case, mixed-case
4 packages and 0 specfiles checked; 0 errors, 7 warnings.

Comment 6 Scott K Logan 2019-04-09 00:25:56 UTC
Argh, there was a prerequisite package that I made and installed locally and then forgot about. My apologies.

The other package isn't versioned and has no SOVERSION, and I'm not sure I'm willing to deal with that right now. I'm going to close this for now - I'll revisit it if that package gets more distributable or if there is more interest in having this module packaged.

Thanks again - sorry about this...


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