Bug 1796711 - Review Request: python-readthedocs-sphinx-ext - Sphinx extension for Read the Docs overrides
Summary: Review Request: python-readthedocs-sphinx-ext - Sphinx extension for Read the...
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Sandro Mani
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-01-31 03:07 UTC by Jerry James
Modified: 2020-02-05 18:25 UTC (History)
4 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2020-02-04 04:07:15 UTC
Type: ---
Embargoed:
manisandro: fedora-review+


Attachments (Terms of Use)

Description Jerry James 2020-01-31 03:07:37 UTC
Spec URL: https://jjames.fedorapeople.org/python-readthedocs-sphinx-ext/python-readthedocs-sphinx-ext.spec
SRPM URL: https://jjames.fedorapeople.org/python-readthedocs-sphinx-ext/python-readthedocs-sphinx-ext-1.0.1-1.fc32.src.rpm
Fedora Account System Username: jjames
Description: This module adds extensions that make Sphinx easier to use.  Some of them require Read the Docs features, others are just code that we ship and enable during builds on Read the Docs.  We currently ship:
- An extension for building docs like Read the Docs
- template-meta - allows users to specify template overrides in per-page
  contexts.

Comment 1 Sandro Mani 2020-02-03 23:05:00 UTC
Not terribly familiar with pyproject-rpm-macros, but it looks like it also autogenerates BR: python3-devel, so the issue marked below is a non-issue. Hence all good as far as I can see!

(Curiosity: [1] states that the pyproject macros work if the project includes pyproject.toml, but the sources contain no such file. So how is this actually working?)

[1] https://src.fedoraproject.org/rpms/pyproject-rpm-macros/blob/master/f/README.md


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

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


Issues:
=======
- Package contains BR: python2-devel or python3-devel


===== 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 does not own files or directories owned by other packages.
[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 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: No rpmlint messages.
[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 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.
[-]: A package which is used by another package via an egg interface should
     provide egg info.
[x]: Package meets the Packaging Guidelines::Python
[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]: 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.
[-]: 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]: 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: python3-readthedocs-sphinx-ext-1.0.1-1.fc32.noarch.rpm
          python-readthedocs-sphinx-ext-1.0.1-1.fc32.src.rpm
2 packages and 0 specfiles checked; 0 errors, 0 warnings.




Rpmlint (installed packages)
----------------------------
1 packages and 0 specfiles checked; 0 errors, 0 warnings.



Source checksums
----------------
https://github.com/readthedocs/readthedocs-sphinx-ext/archive/1.0.1/readthedocs-sphinx-ext-1.0.1.tar.gz :
  CHECKSUM(SHA256) this package     : e92ecbf386aaf86e2fcc61a04b0dde49f98a62470da5c762caa27141e7cf315f
  CHECKSUM(SHA256) upstream package : e92ecbf386aaf86e2fcc61a04b0dde49f98a62470da5c762caa27141e7cf315f


Requires
--------
python3-readthedocs-sphinx-ext (rpmlib, GLIBC filtered):
    python(abi)
    python3.8dist(jinja2)
    python3.8dist(requests)



Provides
--------
python3-readthedocs-sphinx-ext:
    python-readthedocs-sphinx-ext
    python3-readthedocs-sphinx-ext
    python3.8dist(readthedocs-sphinx-ext)
    python3dist(readthedocs-sphinx-ext)



Generated by fedora-review 0.7.4 (54fa030) last change: 2019-12-07
Command line :/usr/bin/fedora-review -b 1796711
Buildroot used: fedora-rawhide-x86_64
Active plugins: Generic, Python, Shell-api
Disabled plugins: PHP, Haskell, Java, fonts, Perl, Ocaml, SugarActivity, C/C++, R
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 2 Jerry James 2020-02-04 00:22:59 UTC
Thanks for the review!

(In reply to Sandro Mani from comment #1)
> (Curiosity: [1] states that the pyproject macros work if the project
> includes pyproject.toml, but the sources contain no such file. So how is
> this actually working?)

I'm afraid I don't know the answer to that question myself, although I'm sure Miro does.  It looks like the commands invoked by the pyproject macros must parse setup.py, since they find the requests and Jinja2 dependencies.  Either that or they invoke black magic.  Possibly both.

Comment 3 Gwyn Ciesla 2020-02-04 03:10:07 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-readthedocs-sphinx-ext

Comment 4 Jerry James 2020-02-04 04:07:15 UTC
Built in Rawhide.

Comment 5 Miro Hrončok 2020-02-05 11:05:32 UTC
(In reply to Jerry James from comment #2)
> Thanks for the review!
> 
> (In reply to Sandro Mani from comment #1)
> > (Curiosity: [1] states that the pyproject macros work if the project
> > includes pyproject.toml, but the sources contain no such file. So how is
> > this actually working?)
> 
> I'm afraid I don't know the answer to that question myself, although I'm
> sure Miro does.  It looks like the commands invoked by the pyproject macros
> must parse setup.py, since they find the requests and Jinja2 dependencies. 
> Either that or they invoke black magic.  Possibly both.

Here I come, summoned by my name being spoken.

The pyproject.toml file specifies a build backend. For easier adoption, we select "setuptools.build_meta" build backend when the pyproject.toml file is not present or it is oresent but the backend is not specified. The "setuptools.build_meta" build backend is backwards compatible with setup.py files.

For curiosity, see get_backend() in https://src.fedoraproject.org/rpms/pyproject-rpm-macros/blob/master/f/pyproject_buildrequires.py#_125

Comment 6 Miro Hrončok 2020-02-05 11:15:30 UTC
I've also opened https://src.fedoraproject.org/rpms/python-readthedocs-sphinx-ext/pull-request/1

For https://github.com/readthedocs/readthedocs-sphinx-ext/issues/64 this is a bit messy, but once that is fixed upstream, it will be better.

The idea was that when you use %pyproject_buildrequires -t, you already have tox, but OTOH from reading the specfile, you don't know you have pytest.

Comment 7 Petr Viktorin (pviktori) 2020-02-05 11:44:01 UTC
> The pyproject.toml file specifies a build backend. For easier adoption, we select "setuptools.build_meta" build backend when the pyproject.toml file is not present or it is oresent but the backend is not specified.

Note that this is standard behavior, not something Fedora-specific. See https://www.python.org/dev/peps/pep-0517/:

> If the pyproject.toml file is absent, or the build-backend key is missing, the source tree is not using this specification, and tools should revert to the legacy behaviour of running setup.py (either directly, or by implicitly invoking the setuptools.build_meta:__legacy__ backend).

Comment 8 Miro Hrončok 2020-02-05 12:37:15 UTC
Ha! We should fallback to setuptools.build_meta:__legacy__, not just setuptools.build_meta. https://src.fedoraproject.org/rpms/pyproject-rpm-macros/pull-request/29

Comment 9 Jerry James 2020-02-05 18:25:57 UTC
(In reply to Miro Hrončok from comment #5)
> Here I come, summoned by my name being spoken.

Kibo is back!  Thanks for the explanations, Miro and Petr.  I feel enlightened.


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