Bug 2073947 - Review Request: python-adafruit-board-toolkit - CircuitPython board identification and information
Summary: Review Request: python-adafruit-board-toolkit - CircuitPython board identific...
Keywords:
Status: CLOSED RAWHIDE
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: 1922900
TreeView+ depends on / blocked
 
Reported: 2022-04-11 08:28 UTC by Lumír Balhar
Modified: 2022-04-13 17:27 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2022-04-13 16:11:06 UTC
Type: ---
Embargoed:
mhroncok: fedora-review+


Attachments (Terms of Use)

Description Lumír Balhar 2022-04-11 08:28:25 UTC
Spec URL: https://lbalhar.fedorapeople.org/adafruit-board-toolkit.spec
SRPM URL: https://lbalhar.fedorapeople.org/adafruit-board-toolkit-1.1.0-1.fc35.src.rpm
Description: CircuitPython board identification and information.
Fedora Account System Username: lbalhar

Needed for the latest version of mu, building them together in: https://copr.fedorainfracloud.org/coprs/lbalhar/mu/

Comment 1 Miro Hrončok 2022-04-12 13:56:24 UTC
According to the guidelines, this package should be called python(3)-adafruit-board-toolkit, as it is a Python library and not an application.

$ rpm -qlp adafruit-board-toolkit-1.1.0-1.fc37.noarch.rpm 
/usr/lib/python3.10/site-packages/adafruit_board_toolkit
/usr/lib/python3.10/site-packages/adafruit_board_toolkit-1.1.0.dist-info
/usr/lib/python3.10/site-packages/adafruit_board_toolkit-1.1.0.dist-info/INSTALLER
/usr/lib/python3.10/site-packages/adafruit_board_toolkit-1.1.0.dist-info/LICENSE
/usr/lib/python3.10/site-packages/adafruit_board_toolkit-1.1.0.dist-info/METADATA
/usr/lib/python3.10/site-packages/adafruit_board_toolkit-1.1.0.dist-info/WHEEL
/usr/lib/python3.10/site-packages/adafruit_board_toolkit-1.1.0.dist-info/top_level.txt
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/__init__.py
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/__pycache__
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/__pycache__/__init__.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/__pycache__/__init__.cpython-310.pyc
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/__pycache__/_list_ports_osx.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/__pycache__/_list_ports_osx.cpython-310.pyc
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/__pycache__/_list_ports_windows.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/__pycache__/_list_ports_windows.cpython-310.pyc
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/__pycache__/circuitpython_serial.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/__pycache__/circuitpython_serial.cpython-310.pyc
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/_list_ports_osx.py
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/_list_ports_windows.py
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/circuitpython_serial.py
/usr/share/doc/adafruit-board-toolkit
/usr/share/doc/adafruit-board-toolkit/README.rst

Comment 2 Lumír Balhar 2022-04-12 17:38:21 UTC
Spec URL: https://lbalhar.fedorapeople.org/python-adafruit-board-toolkit.spec
SRPM URL: https://lbalhar.fedorapeople.org/python-adafruit-board-toolkit-1.1.0-1.fc35.src.rpm
Description: CircuitPython board identification and information.
Fedora Account System Username: lbalhar

Comment 3 Miro Hrončok 2022-04-12 18:30:33 UTC
License:        MIT and BSD

How does this work? Multiple licenses need a comment that explains them. I see 4 different licenses in https://github.com/adafruit/Adafruit_Board_Toolkit/tree/main/LICENSES and https://github.com/adafruit/Adafruit_Board_Toolkit/blob/main/LICENSE looks like MIT. Looking at the files, it seems to be:

/usr/lib/python3.10/site-packages/adafruit_board_toolkit/_list_ports_osx.py  BSD
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/_list_ports_windows.py  BSD
/usr/lib/python3.10/site-packages/adafruit_board_toolkit/circuitpython_serial.py  MIT

It seems we can delete _list_ports_osx.py and _list_ports_windows.py, right? That would leave this as MIT only.


-----


Other than that, the spec looks clean and simple, sane.

Comment 4 Miro Hrončok 2022-04-12 18:33:28 UTC
Interestingly the actual code in this library is almost shorter than the specfile :)

Comment 5 Lumír Balhar 2022-04-13 07:08:07 UTC
(In reply to Miro Hrončok from comment #3)
> It seems we can delete _list_ports_osx.py and _list_ports_windows.py, right?
> That would leave this as MIT only.

Fixed.

Comment 6 Miro Hrončok 2022-04-13 08:22:03 UTC
Thanks. Running FedoraReview.

Comment 7 Miro Hrončok 2022-04-13 08:33:58 UTC
Package Review
==============

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

Package APPROVED.

Suggestions (optional):

1) add a comment near the license tag explaining that there are multiple licenses in the tarball, but we only ship MIT bits
2) replace Source0: with Source:, the number is redundant


===== 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: "*No copyright* The Unlicense", "*No copyright* Creative
     Commons Attribution 4.0", "MIT License", "*No copyright* MIT License",
     "Unknown or generated", "BSD 3-Clause License", "The Unlicense". 11
     files have unknown license. Detailed output of licensecheck later.
[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.
[-]: 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]: 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]: 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]: 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.
[?]: 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.
[?]: 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:
[x]: Rpmlint is run on all installed packages.
     Note: No rpmlint messages.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
 2 packages and 1 specfiles checked; 0 errors, 0 warnings, 0 badness; has taken 1.1 s


Rpmlint (installed packages)
----------------------------
 1 packages and 0 specfiles checked; 0 errors, 0 warnings, 0 badness; has taken 0.0 s 



Source checksums
----------------
https://files.pythonhosted.org/packages/source/a/adafruit-board-toolkit/adafruit-board-toolkit-1.1.0.tar.gz :
  CHECKSUM(SHA256) this package     : 61e19c30854764230138f4c1d65bf3b5d6ef22866396b231df7123a5a2507f27
  CHECKSUM(SHA256) upstream package : 61e19c30854764230138f4c1d65bf3b5d6ef22866396b231df7123a5a2507f27


Requires
--------
python3-adafruit-board-toolkit (rpmlib, GLIBC filtered):
    python(abi)
    python3.10dist(pyserial)



Provides
--------
python3-adafruit-board-toolkit:
    python-adafruit-board-toolkit
    python3-adafruit-board-toolkit
    python3.10-adafruit-board-toolkit
    python3.10dist(adafruit-board-toolkit)
    python3dist(adafruit-board-toolkit)



Generated by fedora-review 0.7.0 (fed5495) last change: 2019-03-17
Command line :try-fedora-review -b 2073947 -m fedora-rawhide-x86_64
Buildroot used: fedora-rawhide-x86_64
Active plugins: Shell-api, Generic, Python
Disabled plugins: R, Ruby, C/C++, Haskell, PHP, Java, Perl, Ocaml, SugarActivity, fonts
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH




Licenses:


*No copyright* Creative Commons Attribution 4.0
-----------------------------------------------
NOT SHIPPED adafruit-board-toolkit-1.1.0/CODE_OF_CONDUCT.md
NOT SHIPPED adafruit-board-toolkit-1.1.0/LICENSES/CC-BY-4.0.txt
NOT SHIPPED adafruit-board-toolkit-1.1.0/docs/_static/favicon.ico.license

*No copyright* MIT License
--------------------------
NOT SHIPPED adafruit-board-toolkit-1.1.0/.github/workflows/build.yml
NOT SHIPPED adafruit-board-toolkit-1.1.0/.github/workflows/release.yml
NOT SHIPPED adafruit-board-toolkit-1.1.0/PKG-INFO
NOT SHIPPED adafruit-board-toolkit-1.1.0/adafruit_board_toolkit.egg-info/PKG-INFO
NOT SHIPPED adafruit-board-toolkit-1.1.0/docs/conf.py

*No copyright* The Unlicense
----------------------------
NOT SHIPPED adafruit-board-toolkit-1.1.0/.pre-commit-config.yaml
NOT SHIPPED adafruit-board-toolkit-1.1.0/.pylintrc
NOT SHIPPED adafruit-board-toolkit-1.1.0/.readthedocs.yml
NOT SHIPPED adafruit-board-toolkit-1.1.0/pyproject.toml

BSD 3-Clause License
--------------------
NOT SHIPPED adafruit-board-toolkit-1.1.0/LICENSES/BSD-3-Clause.txt

MIT License
-----------
adafruit-board-toolkit-1.1.0/LICENSE
adafruit-board-toolkit-1.1.0/README.rst.license
adafruit-board-toolkit-1.1.0/adafruit_board_toolkit/circuitpython_serial.py
NOT SHIPPED adafruit-board-toolkit-1.1.0/docs/api.rst.license
NOT SHIPPED adafruit-board-toolkit-1.1.0/docs/examples.rst.license
NOT SHIPPED adafruit-board-toolkit-1.1.0/docs/index.rst.license
NOT SHIPPED adafruit-board-toolkit-1.1.0/requirements.txt
NOT SHIPPED adafruit-board-toolkit-1.1.0/setup.py

The Unlicense
-------------
NOT SHIPPED adafruit-board-toolkit-1.1.0/LICENSES/Unlicense.txt
NOT SHIPPED adafruit-board-toolkit-1.1.0/examples/board_toolkit_simpletest.py

Unknown or generated
--------------------
MIT adafruit-board-toolkit-1.1.0/LICENSES/MIT.txt
MIT adafruit-board-toolkit-1.1.0/README.rst
GENERATED adafruit-board-toolkit-1.1.0/adafruit_board_toolkit.egg-info/SOURCES.txt
GENERATED adafruit-board-toolkit-1.1.0/adafruit_board_toolkit.egg-info/dependency_links.txt
GENERATED adafruit-board-toolkit-1.1.0/adafruit_board_toolkit.egg-info/requires.txt
GENERATED adafruit-board-toolkit-1.1.0/adafruit_board_toolkit.egg-info/top_level.txt
NOT SHIPPED adafruit-board-toolkit-1.1.0/docs/_static/favicon.ico
NOT SHIPPED adafruit-board-toolkit-1.1.0/docs/api.rst
NOT SHIPPED adafruit-board-toolkit-1.1.0/docs/examples.rst
NOT SHIPPED adafruit-board-toolkit-1.1.0/docs/index.rst
NOT SHIPPED adafruit-board-toolkit-1.1.0/setup.cfg

Comment 8 Gwyn Ciesla 2022-04-13 13:35:51 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-adafruit-board-toolkit

Comment 10 Miro Hrončok 2022-04-13 17:27:02 UTC
Please add python-sig as a co-mainatiner.


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