Bug 2263654 - Review Request: python-hid - Python ctypes bindings for hidapi
Summary: Review Request: python-hid - Python ctypes bindings for hidapi
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Carl George 🤠
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 2263672
TreeView+ depends on / blocked
 
Reported: 2024-02-10 14:42 UTC by Davide Cavalca
Modified: 2024-05-10 02:59 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2024-05-01 22:48:08 UTC
Type: ---
Embargoed:
carl: fedora-review+


Attachments (Terms of Use)

Description Davide Cavalca 2024-02-10 14:42:50 UTC
Spec URL: https://dcavalca.fedorapeople.org/review/python-hid/python-hid.spec
SRPM URL: https://dcavalca.fedorapeople.org/review/python-hid/python-hid-1.0.5-1.fc40.src.rpm

Description:
This package provides Python bindings for hidapi using ctypes.

Fedora Account System Username: dcavalca

Comment 1 Davide Cavalca 2024-02-10 14:42:53 UTC
This package built on koji:  https://koji.fedoraproject.org/koji/taskinfo?taskID=113290205

Comment 2 Carl George 🤠 2024-04-06 20:22:15 UTC
Taking this review.

On an initial pass, I noticed that version 1.0.6 is tagged upstream and uploaded to PyPI, which includes several fixes relevant to this package.

- the LICENSE file is included
- the README.md file is no longer executable
- the README.md file no longer has the wrong end of line encoding

Updating to that version should allow you to drop several things from the spec file that are no longer necessary.

https://github.com/apmorton/pyhidapi/releases/tag/1.0.6

Calling %{pypi_source} without an argument is deprecated, so that should be changed to %{pypi_source %{srcname}}.

https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#pypi_source

The %license line can be dropped from the %files section, because the LICENSE file is including in the dist-info directory and is properly marked as a license.  You can future proof this by adding the -l flag to %pyproject_save_files.

https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#pyproject_save_files

Build requiring hidapi-devel seems incorrect.  This is a noarch package that doesn't link against the hidapi library.  In the source code this loops through a list of library file names to load with ctypes.cdll.  The first one on the list (libhidapi-hidraw.so) is indeed in hidapi-devel, but the second one on the list (libhidapi-hidraw.so.0) is in hidapi, so we can get away with just build requiring hidapi, not hidapi-devel.  Since our %check is just an import check, the build requirements shouldn't be any different from the runtime requirements (other than python3-devel of course).

https://github.com/apmorton/pyhidapi/blob/1.0.6/hid/__init__.py#L9-L31

Comment 3 Davide Cavalca 2024-04-09 21:35:28 UTC
Spec URL: https://dcavalca.fedorapeople.org/review/python-hid/python-hid.spec
SRPM URL: https://dcavalca.fedorapeople.org/review/python-hid/python-hid-1.0.6-1.fc41.src.rpm

Changelog:
- update to 1.0.6
- switch hidapi-devel BR to hidapi
- drop %license and pass -l to %pyproject_save_files
- fix %pypi_source call

Comment 4 Carl George 🤠 2024-05-01 21:27:33 UTC
This looks good to me now.  The only other change I would make is to drop the forgeurl macro definition, since it is no longer used anywhere in the spec file.  But that is non-blocking for the review and can easily be taken care of later at your leisure.

PACKAGE APPROVED.


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

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 requires other packages for directories it uses.
[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.
[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]: The License field must be a valid SPDX expression.
[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]: 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]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 2083 bytes in 1 files.
[x]: Packages must not store files under /srv, /opt or /usr/local

Python:
[x]: Binary eggs must be removed in %prep
[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

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

Comment 5 Fedora Admin user for bugzilla script actions 2024-05-01 21:51:40 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/python-hid

Comment 6 Fedora Update System 2024-05-01 21:59:43 UTC
FEDORA-2024-ab2424c40b (python-hid-1.0.6-1.fc41) has been submitted as an update to Fedora 41.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-ab2424c40b

Comment 7 Fedora Update System 2024-05-01 22:12:53 UTC
FEDORA-2024-232a8e3a77 (python-hid-1.0.6-1.fc40) has been submitted as an update to Fedora 40.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-232a8e3a77

Comment 8 Fedora Update System 2024-05-01 22:21:50 UTC
FEDORA-2024-c6d9754e85 (python-hid-1.0.6-1.fc39) has been submitted as an update to Fedora 39.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-c6d9754e85

Comment 9 Fedora Update System 2024-05-01 22:32:33 UTC
FEDORA-2024-48d854992a (python-hid-1.0.6-1.fc38) has been submitted as an update to Fedora 38.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-48d854992a

Comment 10 Fedora Update System 2024-05-01 22:48:08 UTC
FEDORA-2024-ab2424c40b (python-hid-1.0.6-1.fc41) has been pushed to the Fedora 41 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 11 Fedora Update System 2024-05-02 02:29:14 UTC
FEDORA-2024-c6d9754e85 has been pushed to the Fedora 39 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --refresh --advisory=FEDORA-2024-c6d9754e85 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2024-c6d9754e85

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

Comment 12 Fedora Update System 2024-05-02 02:34:56 UTC
FEDORA-2024-48d854992a has been pushed to the Fedora 38 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --refresh --advisory=FEDORA-2024-48d854992a \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2024-48d854992a

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

Comment 13 Fedora Update System 2024-05-02 03:46:25 UTC
FEDORA-2024-232a8e3a77 has been pushed to the Fedora 40 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --refresh --advisory=FEDORA-2024-232a8e3a77 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2024-232a8e3a77

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

Comment 14 Fedora Update System 2024-05-10 01:05:11 UTC
FEDORA-2024-c6d9754e85 (python-hid-1.0.6-1.fc39) has been pushed to the Fedora 39 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 15 Fedora Update System 2024-05-10 01:34:29 UTC
FEDORA-2024-48d854992a (python-hid-1.0.6-1.fc38) has been pushed to the Fedora 38 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 16 Fedora Update System 2024-05-10 02:59:10 UTC
FEDORA-2024-232a8e3a77 (python-hid-1.0.6-1.fc40) has been pushed to the Fedora 40 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.