Bug 1902081 - Review Request: python-nbclient - A client library for executing notebooks
Summary: Review Request: python-nbclient - A client library for executing notebooks
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Andy Mender
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On: 1902078
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-11-26 19:36 UTC by Mukundan Ragavan
Modified: 2020-12-01 23:14 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-12-01 23:14:31 UTC
Type: ---
Embargoed:
andymenderunix: fedora-review+


Attachments (Terms of Use)

Description Mukundan Ragavan 2020-11-26 19:36:31 UTC
Spec URL: https://nonamedotc.fedorapeople.org/pkgreview/python-packages/python-nbclient/python-nbclient.spec
SRPM URL: https://nonamedotc.fedorapeople.org/pkgreview/python-packages/python-nbclient/python-nbclient-0.5.1-1.fc33.src.rpm

Description:
NBClient, a client library for programmatic notebook execution, is a tool for 
running Jupyter Notebooks in different execution contexts. NBClient was spun 
out of nbconvert (formerly ExecutePreprocessor). NBClient lets you execute notebooks.

Fedora Account System Username: nonamedotc

Comment 1 Andy Mender 2020-11-28 13:07:26 UTC
> %package -n     python3-%{pypi_name}
> Summary:        %{summary}
> %{?python_provide:%python_provide python3-%{pypi_name}}

The %py_provides macro should be used here.

> %check
> PYTHONPATH=%{buildroot}%{python3_sitelib} pytest-3 -v -k 'not test_many_parallel_notebooks'

I'm not familiar with this invocation, but could you try using the %pytest macro instead?

Some of the description lines are a little too long. Make sure they don't exceed 80 characters:
Rpmlint
-------
Checking: python3-nbclient-0.5.1-1.fc34.noarch.rpm
          python-nbclient-0.5.1-1.fc34.src.rpm
python3-nbclient.noarch: W: spelling-error %description -l en_US nbconvert -> converter, convert, controvert
python3-nbclient.noarch: E: description-line-too-long C out of nbconvert (formerly ExecutePreprocessor). NBClient lets you execute notebooks.
python-nbclient.src: W: spelling-error %description -l en_US nbconvert -> converter, convert, controvert
python-nbclient.src: E: description-line-too-long C out of nbconvert (formerly ExecutePreprocessor). NBClient lets you execute notebooks.
2 packages and 0 specfiles checked; 2 errors, 2 warnings.

Looks good otherwise. Package approved.

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

Generic:
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
     Note: Using prebuilt packages
[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", "BSD 3-clause "New" or "Revised"
     License". 61 files have unknown license. Detailed output of
     licensecheck in /data/rpmbuild/SPECS/python-nbclient/python-
     nbclient/licensecheck.txt
[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]: 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:
[x]: Reviewer should test that the package builds in mock.
[-]: 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.
[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]: 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:
[!]: Rpmlint is run on all installed packages.
     Note: Mock build failed
     See: https://docs.fedoraproject.org/en-US/packaging-
     guidelines/#_use_rpmlint


Installation errors
-------------------
INFO: mock.py version 2.6 starting (python version = 3.8.6)...
Start: init plugins
INFO: selinux enabled
Finish: init plugins
INFO: Signal handler active
Start: run
Start: chroot init
INFO: calling preinit hooks
INFO: enabled root cache
INFO: enabled package manager cache
Start: cleaning package manager metadata
Finish: cleaning package manager metadata
INFO: enabled HW Info plugin
Mock Version: 2.6
INFO: Mock Version: 2.6
Finish: chroot init
INFO: installing package(s): /data/rpmbuild/SPECS/python-nbclient/python3-nbclient-0.5.1-1.fc34.noarch.rpm
ERROR: Command failed: 
 # /usr/bin/dnf --installroot /var/lib/mock/fedora-rawhide-x86_64/root/ --releasever 34 --setopt=deltarpm=False --allowerasing --disableplugin=local --disableplugin=spacewalk install /data/rpmbuild/SPECS/python-nbclient/python3-nbclient-0.5.1-1.fc34.noarch.rpm --setopt=tsflags=nocontexts



Rpmlint
-------
Checking: python3-nbclient-0.5.1-1.fc34.noarch.rpm
          python-nbclient-0.5.1-1.fc34.src.rpm
python3-nbclient.noarch: W: spelling-error %description -l en_US nbconvert -> converter, convert, controvert
python3-nbclient.noarch: E: description-line-too-long C out of nbconvert (formerly ExecutePreprocessor). NBClient lets you execute notebooks.
python-nbclient.src: W: spelling-error %description -l en_US nbconvert -> converter, convert, controvert
python-nbclient.src: E: description-line-too-long C out of nbconvert (formerly ExecutePreprocessor). NBClient lets you execute notebooks.
2 packages and 0 specfiles checked; 2 errors, 2 warnings.




Source checksums
----------------
https://files.pythonhosted.org/packages/source/n/nbclient/nbclient-0.5.1.tar.gz :
  CHECKSUM(SHA256) this package     : 01e2d726d16eaf2cde6db74a87e2451453547e8832d142f73f72fddcd4fe0250
  CHECKSUM(SHA256) upstream package : 01e2d726d16eaf2cde6db74a87e2451453547e8832d142f73f72fddcd4fe0250


Requires
--------
python3-nbclient (rpmlib, GLIBC filtered):
    python(abi)
    python3.9dist(async-generator)
    python3.9dist(jupyter-client)
    python3.9dist(nbformat)
    python3.9dist(nest-asyncio)
    python3.9dist(traitlets)
    python3dist(async-generator)
    python3dist(jupyter-client)
    python3dist(nbformat)
    python3dist(traitlets)



Provides
--------
python3-nbclient:
    python-nbclient
    python3-nbclient
    python3.9-nbclient
    python3.9dist(nbclient)
    python3dist(nbclient)

Comment 2 Mukundan Ragavan 2020-11-28 14:15:43 UTC
Thanks for the review.

(In reply to Andy Mender from comment #1)
> > %package -n     python3-%{pypi_name}
> > Summary:        %{summary}
> > %{?python_provide:%python_provide python3-%{pypi_name}}
> 
> The %py_provides macro should be used here.
> 

Done in the updated spec file.

> > %check
> > PYTHONPATH=%{buildroot}%{python3_sitelib} pytest-3 -v -k 'not test_many_parallel_notebooks'
> 
> I'm not familiar with this invocation, but could you try using the %pytest
> macro instead?
> 

I had some problems with other packages in the past and someone in the python-sig came up with this solution.

But, in this case, %pytest macro works fine (as expected; I guess since it contains pythonpath already). 

> Some of the description lines are a little too long. Make sure they don't
> exceed 80 characters:

Will fix during import.

Comment 3 Gwyn Ciesla 2020-11-30 14:36:03 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-nbclient


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