Bug 1435920 - Review Request: python-j1m.sphinxautointerface - Sphinx extension for documenting zope.interface interfaces
Summary: Review Request: python-j1m.sphinxautointerface - Sphinx extension for documen...
Keywords:
Status: CLOSED ERRATA
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: AwaitingSubmitter
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-03-25 22:35 UTC by Jerry James
Modified: 2017-12-12 11:18 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-12-12 11:18:26 UTC
Type: ---
Embargoed:
zebob.m: fedora-review+


Attachments (Terms of Use)

Description Jerry James 2017-03-25 22:35:50 UTC
Spec URL: https://jjames.fedorapeople.org/python-j1m.sphinxautointerface/python-j1m.sphinxautointerface.spec
SRPM URL: https://jjames.fedorapeople.org/python-j1m.sphinxautointerface/python-j1m.sphinxautointerface-0.3.0-1.fc27.src.rpm
Fedora Account System Username: jjames
Description: This sphinx extension provides an :rst:dir:autointerface directive for Zope interfaces.

Comment 1 Antonio T. (sagitter) 2017-03-26 10:36:11 UTC
Package Review
==============

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

- License file is not installed
- setup.py does not run any test
- Please, remove egg-info files from upstream
  http://fedoraproject.org/wiki/Packaging:Python_Eggs#Upstream_Egg_Packages

===== 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.
[-]: 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.
[ ]: License field in the package spec file matches the actual license.
     Note: Cannot run licensecheck: Command 'licensecheck -r /var/lib/mock
     /fedora-rawhide-x86_64/root/builddir/build/BUILD/python-
     j1m.sphinxautointerface-0.3.0' returned non-zero exit status 25
[!]: License file installed when any subpackage combination is installed.
[x]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/python3.6/site-
     packages, /usr/lib/python3.6
[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 20480 bytes in 2 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]: Package requires other packages for directories it uses.
[x]: Package does not own files or directories owned by other packages.
[x]: All build dependencies are listed in BuildRequires, except for any
     that are listed in the exceptions section of Packaging Guidelines.
[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 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.
[!]: Package meets the Packaging Guidelines::Python
[x]: Package contains BR: python2-devel or python3-devel
[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).
[-]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python2-j1m.sphinxautointerface , python3-j1m.sphinxautointerface
[x]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: 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.
[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.


Rpmlint
-------
Checking: python2-j1m.sphinxautointerface-0.3.0-1.fc27.noarch.rpm
          python3-j1m.sphinxautointerface-0.3.0-1.fc27.noarch.rpm
          python-j1m.sphinxautointerface-0.3.0-1.fc27.src.rpm
python2-j1m.sphinxautointerface.noarch: W: spelling-error Summary(en_US) zope -> ope, zone, nope
python2-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US rst -> est, rat, rs
python2-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US dir -> deer, rid, Dir
python2-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US autointerface -> auto interface, auto-interface, interface
python3-j1m.sphinxautointerface.noarch: W: spelling-error Summary(en_US) zope -> ope, zone, nope
python3-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US rst -> est, rat, rs
python3-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US dir -> deer, rid, Dir
python3-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US autointerface -> auto interface, auto-interface, interface
python-j1m.sphinxautointerface.src: W: spelling-error Summary(en_US) zope -> ope, zone, nope
python-j1m.sphinxautointerface.src: W: spelling-error %description -l en_US rst -> est, rat, rs
python-j1m.sphinxautointerface.src: W: spelling-error %description -l en_US dir -> deer, rid, Dir
python-j1m.sphinxautointerface.src: W: spelling-error %description -l en_US autointerface -> auto interface, auto-interface, interface
3 packages and 0 specfiles checked; 0 errors, 12 warnings.




Rpmlint (installed packages)
----------------------------
python2-j1m.sphinxautointerface.noarch: W: spelling-error Summary(en_US) zope -> ope, zone, nope
python2-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US rst -> est, rat, rs
python2-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US dir -> deer, rid, Dir
python2-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US autointerface -> auto interface, auto-interface, interface
python3-j1m.sphinxautointerface.noarch: W: spelling-error Summary(en_US) zope -> ope, zone, nope
python3-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US rst -> est, rat, rs
python3-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US dir -> deer, rid, Dir
python3-j1m.sphinxautointerface.noarch: W: spelling-error %description -l en_US autointerface -> auto interface, auto-interface, interface
2 packages and 0 specfiles checked; 0 errors, 8 warnings.



Requires
--------
python2-j1m.sphinxautointerface (rpmlib, GLIBC filtered):
    python(abi)
    python-zope-interface
    python2-sphinx

python3-j1m.sphinxautointerface (rpmlib, GLIBC filtered):
    python(abi)
    python3-sphinx
    python3-zope-interface



Provides
--------
python2-j1m.sphinxautointerface:
    python-j1m.sphinxautointerface
    python2-j1m.sphinxautointerface
    python2.7dist(j1m.sphinxautointerface)
    python2dist(j1m.sphinxautointerface)

python3-j1m.sphinxautointerface:
    python3-j1m.sphinxautointerface
    python3.6dist(j1m.sphinxautointerface)
    python3dist(j1m.sphinxautointerface)



Source checksums
----------------
https://files.pythonhosted.org/packages/source/j/j1m.sphinxautointerface/j1m.sphinxautointerface-0.3.0.tar.gz :
  CHECKSUM(SHA256) this package     : 633d9f3a3eea96b559e43fd138c1408ff64a82481ccbf859cb616c614ad4b9dc
  CHECKSUM(SHA256) upstream package : 633d9f3a3eea96b559e43fd138c1408ff64a82481ccbf859cb616c614ad4b9dc


Generated by fedora-review 0.6.1 (f03e4e7) last change: 2016-05-02
Command line :/usr/bin/fedora-review -m fedora-rawhide-x86_64 -b 1435920
Buildroot used: fedora-rawhide-x86_64
Active plugins: Python, Generic, Shell-api
Disabled plugins: Java, C/C++, fonts, SugarActivity, Ocaml, Perl, Haskell, R, PHP
Disabled flags: EXARCH, DISTTAG, EPEL5, BATCH, EPEL6

Comment 2 Jerry James 2017-03-27 04:20:49 UTC
Thanks for the review, Antonio.

(In reply to Antonio Trande from comment #1)
> - License file is not installed

There is no license file to install.  Upstream did not include one.  I will ask about that, but since upstream for this package considers itself a temporary fork of yet another upstream, I don't know if the developer will be willing to add one.

> - setup.py does not run any test

Hmm, you're right.  Should I just remove %check for now?

> - Please, remove egg-info files from upstream
>   http://fedoraproject.org/wiki/Packaging:Python_Eggs#Upstream_Egg_Packages

That rule applies to egg packages containing compiled bytecode and possibly compiled extensions.  The egg directory in this package contains only egg metadata, which does not have to be removed because it is regenerated during the build.  Also, see this thread:

https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/thread/FOG5APDRQVNXR5ZOZZSVDNZVN4WURKG4/#FOG5APDRQVNXR5ZOZZSVDNZVN4WURKG4

Comment 3 Antonio T. (sagitter) 2017-03-27 09:08:03 UTC
(In reply to Jerry James from comment #2)
> Thanks for the review, Antonio.
> 
> (In reply to Antonio Trande from comment #1)
> > - License file is not installed
> 
> There is no license file to install.  Upstream did not include one.  I will
> ask about that, but since upstream for this package considers itself a
> temporary fork of yet another upstream, I don't know if the developer will
> be willing to add one.

http://fedoraproject.org/wiki/Packaging:LicensingGuidelines#License_Text

> 
> > - setup.py does not run any test
> 
> Hmm, you're right.  Should I just remove %check for now?

Yes, if there is not another way for running them.
> 
> > - Please, remove egg-info files from upstream
> >   http://fedoraproject.org/wiki/Packaging:Python_Eggs#Upstream_Egg_Packages
> 
> That rule applies to egg packages containing compiled bytecode and possibly
> compiled extensions.  The egg directory in this package contains only egg
> metadata, which does not have to be removed because it is regenerated during
> the build.  Also, see this thread:
> 
> https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/
> thread/FOG5APDRQVNXR5ZOZZSVDNZVN4WURKG4/#FOG5APDRQVNXR5ZOZZSVDNZVN4WURKG4

Comment 4 Antonio T. (sagitter) 2017-07-20 10:36:28 UTC
?

Comment 5 Jerry James 2017-07-26 04:12:57 UTC
I'm terribly sorry.  $dayjob has been making Fedora work very difficult to get around to for the past few months.  I have commented out the %check script for now, and asked upstream to include the license text: https://bitbucket.org/j1m/sphinxautointerface/issues/1/license-text.

New URLs:
Spec URL: https://jjames.fedorapeople.org/python-j1m.sphinxautointerface/python-j1m.sphinxautointerface.spec
SRPM URL: https://jjames.fedorapeople.org/python-j1m.sphinxautointerface/python-j1m.sphinxautointerface-0.3.0-2.fc27.src.rpm

Comment 6 Antonio T. (sagitter) 2017-08-16 16:12:53 UTC
> I have commented out the %check script for now, and asked upstream to include 
> the license text: https://bitbucket.org/j1m/sphinxautointerface/issues
> /1/license-text.

Is it a fork?
What's the original source code?

Comment 7 Jerry James 2017-08-16 19:45:06 UTC
Yes, it is a fork of this repository: https://bitbucket.org/birkenfeld/sphinx-contrib.  The fork was made because of lack of movement on this pull request: https://bitbucket.org/birkenfeld/sphinx-contrib/pull-requests/126/fixes-based-on-using-the-extension-with/diff.  Since there has been some recent movement on that PR, we should maybe wait a bit and see if things get resolved.

Comment 8 Antonio T. (sagitter) 2017-08-19 08:16:35 UTC
(In reply to Jerry James from comment #7)
> Yes, it is a fork of this repository:
> https://bitbucket.org/birkenfeld/sphinx-contrib.  The fork was made because
> of lack of movement on this pull request:
> https://bitbucket.org/birkenfeld/sphinx-contrib/pull-requests/126/fixes-
> based-on-using-the-extension-with/diff.  Since there has been some recent
> movement on that PR, we should maybe wait a bit and see if things get
> resolved.

You could include LICENSE file from original source, leaving a comment about.

Comment 9 Jerry James 2017-11-26 04:04:01 UTC
There has been no further movement on that PR, so I guess we should go ahead with getting this package into Fedora.  I included the LICENSE file from the upstream repository as suggested.  Here are the new URLs:

Spec URL: https://jjames.fedorapeople.org/python-j1m.sphinxautointerface/python-j1m.sphinxautointerface.spec
SRPM URL: https://jjames.fedorapeople.org/python-j1m.sphinxautointerface/python-j1m.sphinxautointerface-0.3.0-3.fc28.src.rpm

Comment 10 Robert-André Mauchin 🐧 2017-11-26 13:28:59 UTC
The LICENCE file you included is not good, you saved the whole Bitbucket page intead of the RAW file, fix this with:

Source1:        https://bitbucket.org/birkenfeld/sphinx-contrib/raw/8e295053a27d5914127fbb01e2a8fb57421897a7/LICENSE

Package is fine otherwise so I accept it but please fix this before import.

Comment 11 Gwyn Ciesla 2017-11-27 15:11:45 UTC
(fedrepo-req-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-j1m.sphinxautointerface. You may commit to the branch "f27" in about 10 minutes.

Comment 12 Fedora Update System 2017-11-28 05:08:10 UTC
python-j1m.sphinxautointerface-0.3.0-3.fc27 has been submitted as an update to Fedora 27. https://bodhi.fedoraproject.org/updates/FEDORA-2017-ba0a4dffda

Comment 13 Fedora Update System 2017-11-29 01:46:24 UTC
python-j1m.sphinxautointerface-0.3.0-3.fc27 has been pushed to the Fedora 27 testing repository. If problems still persist, please make note of it in this bug report.
See https://fedoraproject.org/wiki/QA:Updates_Testing for
instructions on how to install test updates.
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2017-ba0a4dffda

Comment 14 Fedora Update System 2017-12-12 11:18:26 UTC
python-j1m.sphinxautointerface-0.3.0-3.fc27 has been pushed to the Fedora 27 stable repository. If problems still persist, 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.