[Bug 1812124] New: Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

Bug ID: 1812124
           Summary: Review Request:  python-sphinxcontrib-openapi -
                    OpenAPI spec renderer for Sphinx
           Product: Fedora
           Version: rawhide
          Hardware: All
                OS: Linux
            Status: NEW
         Component: Package Review
          Severity: medium
          Priority: medium
          Assignee: [e-mail]
          Reporter: [e-mail]
        QA Contact: [e-mail]
                CC: [e-mail]
  Target Milestone: ---
    Classification: Fedora

Spec URL:
https://fbo.fedorapeople.org/python-sphinxcontrib-openapi/python-sphinxcontr...
SRPM URL:
https://fbo.fedorapeople.org/python-sphinxcontrib-openapi/python-sphinxcontr...
Description: OpenAPI spec renderer for Sphinx
Fedora Account System Username: fbo

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

Miro Hrončok  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |ASSIGNED
                 CC|                            |[e-mail]
           Assignee|[e-mail]    |[e-mail]
           Doc Type|---                         |If docs needed, set a value
              Flags|                            |fedora-review?

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #1 from Miro Hrončok  ---
  Source0:        https://pypi.io/packages/source/%(c=%%7Bpypi_name%7D; echo
${c:0:1})/%{pypi_name}/%{pypi_name}-%{version}.tar.gz

There is a amcor:

Source0:        %{pypi_source}

--------------------------

%build
  %{__python3} setup.py build

%install
  %{__python3} setup.py install -O1 --skip-build --root %{buildroot}

This should nowdays be:

%build
  %py3_build

%install
  %py3_install

--------------------------

Requires:       python3-sphinxcontrib-httpdomain
  Requires:       python3-jsonschema
  Requires:       python3-pyyaml

This should use the automatic dependencies instead (possibly by not deleting
the requirements.txt file?)

--------------------------

The two "initial packaging" changelog entries are confusing.

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #2 from Miro Hrončok  ---
> There is a amcor:

Should have been "macro"

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #3 from Fabien Boucher  ---
(In reply to Miro Hrončok from comment #1)
> Source0:        https://pypi.io/packages/source/%(c=%%7Bpypi_name%7D; echo
> ${c:0:1})/%{pypi_name}/%{pypi_name}-%{version}.tar.gz
>
> There is a amcor:
>
> Source0:        %{pypi_source}
>
> %build
>   %{__python3} setup.py build
>
> %install
>   %{__python3} setup.py install -O1 --skip-build --root %{buildroot}
>
> This should nowdays be:
>
> %build
>   %py3_build
>
> %install
>   %py3_install

fixed.
> Requires:       python3-sphinxcontrib-httpdomain
>   Requires:       python3-jsonschema
>   Requires:       python3-pyyaml
>
> This should use the automatic dependencies instead (possibly by not deleting
> the requirements.txt file?)

Yes it worked:

[root@fedora31-packaging python-sphinxcontrib-openapi]# dnf deplist
results_python-sphinxcontrib-openapi/0.6.0/1.fc33/python3-sphinxcontrib-openapi-0.6.0-1.fc33.noarch.rpm
Last metadata expiration check: 1:58:54 ago on Fri 13 Mar 2020 08:34:01 AM UTC.
package: python3-sphinxcontrib-openapi-0.6.0-1.fc33.noarch
  dependency: python(abi) = 3.8
  dependency: python3.8dist(jsonschema) >= 2.5.1
  dependency: python3.8dist(pyyaml) >= 3.12
  dependency: python3.8dist(sphinxcontrib-httpdomain) >= 1.5
  dependency: rpmlib(CompressedFileNames) <= 3.0.4-1
  dependency: rpmlib(FileDigests) <= 4.6.0-1
  dependency: rpmlib(PartialHardlinkSets) <= 4.0.4-1
  dependency: rpmlib(PayloadFilesHavePrefix) <= 4.0-1
  dependency: rpmlib(PayloadIsZstd) <= 5.4.18-1
> The two "initial packaging" changelog entries are confusing.

fixed.

Scratch build: https://koji.fedoraproject.org/koji/taskinfo?taskID=42445205

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #4 from Miro Hrončok  ---
Is this necessary?

sed -e '/.*use_scm_version=.*/d' \
    -e '/.*setuptools_scm.*/d' \
    -e '/long_description=.*/a    version="%{version}",' -i setup.py

------------

Also, %{__python3} can (should?) be replaced by %{python3}.

------------

The description could use more detail over summary.

------------

Running automated checks, will report back.

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #5 from Miro Hrončok  ---
Please add:

%files -n python3-%{srcname}
%license LICENSE
%doc README.rst

Also, there are test files under the ASL 2.0 license, but we don't ship them in
the built RPM. I suggest to note that in a comment near the License tag.

sphinxcontrib-openapi-0.6.0/tests/OpenAPI-Specification/versions/1.2.md
sphinxcontrib-openapi-0.6.0/tests/OpenAPI-Specification/versions/2.0.md
sphinxcontrib-openapi-0.6.0/tests/OpenAPI-Specification/versions/3.0.0.md
sphinxcontrib-openapi-0.6.0/tests/OpenAPI-Specification/versions/3.0.1.md
sphinxcontrib-openapi-0.6.0/tests/OpenAPI-Specification/versions/3.0.2.md

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #6 from Fabien Boucher  ---
(In reply to Miro Hrončok from comment #4)
> Is this necessary?
>
> sed -e '/.*use_scm_version=.*/d' \
>     -e '/.*setuptools_scm.*/d' \
>     -e '/long_description=.*/a    version="%{version}",' -i setup.py

Hum in fact no. Miss that setuptools_scm is packaged in Fedora. So adding the
BR worked just fine.
Fixed.
> Also, %{__python3} can (should?) be replaced by %{python3}.

Fixed.
> The description could use more detail over summary.

Done.
> Running automated checks, will report back.

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #7 from Fabien Boucher  ---
(In reply to Miro Hrončok from comment #5)
> Please add:
>
> %files -n python3-%{srcname}
> %license LICENSE
> %doc README.rst

Done.
> Also, there are test files under the ASL 2.0 license, but we don't ship them
> in the built RPM. I suggest to note that in a comment near the License tag.
>
> sphinxcontrib-openapi-0.6.0/tests/OpenAPI-Specification/versions/1.2.md
> sphinxcontrib-openapi-0.6.0/tests/OpenAPI-Specification/versions/2.0.md
> sphinxcontrib-openapi-0.6.0/tests/OpenAPI-Specification/versions/3.0.0.md
> sphinxcontrib-openapi-0.6.0/tests/OpenAPI-Specification/versions/3.0.1.md
> sphinxcontrib-openapi-0.6.0/tests/OpenAPI-Specification/versions/3.0.2.md

Done.

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #8 from Fabien Boucher  ---
https://koji.fedoraproject.org/koji/taskinfo?taskID=42530243

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #9 from Miro Hrončok  ---
Package Review
==============

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

Please fix the summary and description:

python3-sphinxcontrib-openapi.noarch: W: summary-ended-with-dot C OpenAPI spec
renderer for Sphinx.
python3-sphinxcontrib-openapi.noarch: E: description-line-too-long C Sphinx
extension to generate APIs docs from OpenAPI (fka Swagger) spec. It depends on
sphinxcontrib-httpdomain

===== 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: "Unknown or generated", "BSD 2-clause "Simplified" License",
     "*No copyright* Apache License 2.0".
[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.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[?]: 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: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.

Rpmlint
-------
Checking: python3-sphinxcontrib-openapi-0.6.0-1.fc33.noarch.rpm
          python-sphinxcontrib-openapi-0.6.0-1.fc33.src.rpm
python3-sphinxcontrib-openapi.noarch: W: spelling-error Summary(en_US) renderer
-> tenderer, rendered, render
python3-sphinxcontrib-openapi.noarch: W: summary-ended-with-dot C OpenAPI spec
renderer for Sphinx.
python3-sphinxcontrib-openapi.noarch: W: spelling-error %description -l en_US
fka -> fa, ska, aka
python3-sphinxcontrib-openapi.noarch: W: spelling-error %description -l en_US
httpdomain -> ptomaine
python3-sphinxcontrib-openapi.noarch: E: description-line-too-long C Sphinx
extension to generate APIs docs from OpenAPI (fka Swagger) spec. It depends on
sphinxcontrib-httpdomain
python3-sphinxcontrib-openapi.noarch: E: description-line-too-long C that
provides an HTTP domain for describing RESTful HTTP APIs, so we don’t need to
reinvent the wheel.
python-sphinxcontrib-openapi.src: W: spelling-error Summary(en_US) renderer ->
tenderer, rendered, render
python-sphinxcontrib-openapi.src: W: summary-ended-with-dot C OpenAPI spec
renderer for Sphinx.
python-sphinxcontrib-openapi.src: W: spelling-error %description -l en_US fka
-> fa, ska, aka
python-sphinxcontrib-openapi.src: W: spelling-error %description -l en_US
httpdomain -> ptomaine
python-sphinxcontrib-openapi.src: E: description-line-too-long C Sphinx
extension to generate APIs docs from OpenAPI (fka Swagger) spec. It depends on
sphinxcontrib-httpdomain
python-sphinxcontrib-openapi.src: E: description-line-too-long C that provides
an HTTP domain for describing RESTful HTTP APIs, so we don’t need to reinvent
the wheel.
2 packages and 0 specfiles checked; 4 errors, 8 warnings.

Rpmlint (installed packages)
----------------------------
python3-sphinxcontrib-openapi.noarch: W: spelling-error Summary(en_US) renderer
-> tenderer, rendered, render
python3-sphinxcontrib-openapi.noarch: W: summary-ended-with-dot C OpenAPI spec
renderer for Sphinx.
python3-sphinxcontrib-openapi.noarch: W: spelling-error %description -l en_US
fka -> fa, ska, aka
python3-sphinxcontrib-openapi.noarch: W: spelling-error %description -l en_US
httpdomain -> ptomaine
python3-sphinxcontrib-openapi.noarch: E: description-line-too-long C Sphinx
extension to generate APIs docs from OpenAPI (fka Swagger) spec. It depends on
sphinxcontrib-httpdomain
python3-sphinxcontrib-openapi.noarch: E: description-line-too-long C that
provides an HTTP domain for describing RESTful HTTP APIs, so we don’t need to
reinvent the wheel.
python3-sphinxcontrib-openapi.noarch: W: invalid-url URL:
https://sphinxcontrib-openapi.readthedocs.io/ <urlopen error [Errno -2] Name or
service not known>
1 packages and 0 specfiles checked; 2 errors, 5 warnings.

Source checksums
----------------
https://files.pythonhosted.org/packages/source/s/sphinxcontrib-openapi/sphin...
:
  CHECKSUM(SHA256) this package     :
d5974b779104be45b56a759b2f096234d05f3db49469c7f6dc8ecdd82bfbf30a
  CHECKSUM(SHA256) upstream package :
d5974b779104be45b56a759b2f096234d05f3db49469c7f6dc8ecdd82bfbf30a

Requires
--------
python3-sphinxcontrib-openapi (rpmlib, GLIBC filtered):
    python(abi)
    python3.8dist(jsonschema)
    python3.8dist(pyyaml)
    python3.8dist(sphinxcontrib-httpdomain)

Provides
--------
python3-sphinxcontrib-openapi:
    python-sphinxcontrib-openapi
    python3-sphinxcontrib-openapi
    python3.8dist(sphinxcontrib-openapi)
    python3dist(sphinxcontrib-openapi)

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

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #10 from Fabien Boucher  ---
Thanks a lot for all those reviews. It was really helpful !

Now trying to request the repo, I get this:
fedpkg request-repo python-sphinxcontrib-openapi 1812124        
Could not execute request_repo: The Bugzilla bug is not approved yet

And the same for python-APScheduler.

request-repo for re2 and ws4py worked.

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #11 from Miro Hrončok  ---
That is correct, I've requested one final thing (might get lost in the wall of
text):

Please fix the summary and description:

python3-sphinxcontrib-openapi.noarch: W: summary-ended-with-dot C OpenAPI spec
renderer for Sphinx.
python3-sphinxcontrib-openapi.noarch: E: description-line-too-long C Sphinx
extension to generate APIs docs from OpenAPI (fka Swagger) spec. It depends on
sphinxcontrib-httpdomain

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #12 from Fabien Boucher  ---
Add sorry. I've missed that. Fixed now.

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

Miro Hrončok  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|ASSIGNED                    |POST
              Flags|fedora-review?              |fedora-review+

--- Comment #13 from Miro Hrončok  ---
APPROVED.

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

--- Comment #14 from Gwyn Ciesla  ---
(fedscm-admin):  The Pagure repository was created at
https://src.fedoraproject.org/rpms/python-sphinxcontrib-openapi

[Bug 1812124] Review Request: python-sphinxcontrib-openapi - OpenAPI spec renderer for Sphinx

https://bugzilla.redhat.com/show_bug.cgi?id=1812124

Miro Hrončok  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|POST                        |CLOSED
         Resolution|---                         |RAWHIDE
        Last Closed|                            |2020-05-05 13:45:15