Bug 2326298 - Review Request: python-pydoctor - API documentation generator that works by static analysis
Summary: Review Request: python-pydoctor - API documentation generator that works by s...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Benson Muite
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On: 2326297
Blocks: 2246791 2307417 2316869
TreeView+ depends on / blocked
 
Reported: 2024-11-14 16:46 UTC by Jonathan Steffan
Modified: 2025-01-04 17:13 UTC (History)
6 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2025-01-04 17:13:54 UTC
Type: ---
Embargoed:
benson_muite: fedora-review+


Attachments (Terms of Use)
The .spec file difference from Copr build 8262212 to 8264307 (574 bytes, patch)
2024-11-15 03:09 UTC, Fedora Review Service
no flags Details | Diff
The .spec file difference from Copr build 8264307 to 8264329 (1.37 KB, patch)
2024-11-15 03:32 UTC, Fedora Review Service
no flags Details | Diff
The .spec file difference from Copr build 8264329 to 8393600 (1.32 KB, patch)
2024-12-14 17:34 UTC, Fedora Review Service
no flags Details | Diff
Suggested spec file (3.07 KB, text/plain)
2025-01-02 18:51 UTC, Benson Muite
no flags Details
The .spec file difference from Copr build 8393600 to 8468686 (1.72 KB, patch)
2025-01-03 16:25 UTC, Fedora Review Service
no flags Details | Diff

Description Jonathan Steffan 2024-11-14 16:46:24 UTC
Spec URL: https://jsteffan.fedorapeople.org/python-twisted/python-pydoctor.spec
SRPM URL: https://jsteffan.fedorapeople.org/python-twisted/python-pydoctor-24.3.3-1.20241114git24.3.3.fc40/python-pydoctor-24.3.3-1.20241114git24.3.3.fc42.src.rpm
Description: API documentation generator that works by static analysis
Fedora Account System Username: jsteffan

Comment 1 Fedora Review Service 2024-11-14 17:08:42 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/8262212
(failed)

Build log:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2326298-python-pydoctor/fedora-rawhide-x86_64/08262212-python-pydoctor/builder-live.log.gz

Please make sure the package builds successfully at least for Fedora Rawhide.

- If the build failed for unrelated reasons (e.g. temporary network
  unavailability), please ignore it.
- If the build failed because of missing BuildRequires, please make sure they
  are listed in the "Depends On" field


---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 2 solomoncyj 2024-11-15 01:02:27 UTC
could you try to create a patch file that increases the version tolerance of  python-lunr or create a compat package insted?

Comment 3 Jonathan Steffan 2024-11-15 02:35:03 UTC
(In reply to solomoncyj from comment #2)
> could you try to create a patch file that increases the version tolerance of
> python-lunr or create a compat package insted?

I missed that python-lunr was already packaged, just too new of a version.

Comment 5 Fedora Review Service 2024-11-15 03:09:59 UTC
Created attachment 2057817 [details]
The .spec file difference from Copr build 8262212 to 8264307

Comment 6 Fedora Review Service 2024-11-15 03:10:01 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/8264307
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2326298-python-pydoctor/fedora-rawhide-x86_64/08264307-python-pydoctor/fedora-review/review.txt

Found issues:

- python3-toml is deprecated, you must not depend on it.
  Read more: https://docs.fedoraproject.org/en-US/packaging-guidelines/deprecating-packages/

Please know that there can be false-positives.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 7 solomoncyj 2024-11-15 03:15:13 UTC
under %prep, use %forgesetup over %forgeautosetup
use %package -n python3-%{srcname}
remove python_provide
under %build, use %make_build docs
for %files, use the newer %files -n python3-%{srcname} -f %{pyproject_files} and remove all %{python3_sitelib} ...

Comment 8 Jonathan Steffan 2024-11-15 03:26:34 UTC
Spec URL: https://jsteffan.fedorapeople.org/python-twisted/python-pydoctor.spec
SRPM URL: https://jsteffan.fedorapeople.org/python-twisted/python-pydoctor-24.3.3-1.20240517git24.3.3.fc40/python-pydoctor-24.3.3-1.20240517git24.3.3.fc42.src.rpm

Changelog:

* Modernize use of python macros

Seems rpmdev-newspec -t python is in need of an update. Also, I want to use %forgeautosetup so patches are automatically applied.

forgesetup: invalid option -- 'p'
error: ~/SPECS/python-pydoctor.spec: line 49: Unknown option p in forgesetup(z:va)
RPM Failed to parse spec file.

Comment 9 Fedora Review Service 2024-11-15 03:32:41 UTC
Created attachment 2057818 [details]
The .spec file difference from Copr build 8264307 to 8264329

Comment 10 Fedora Review Service 2024-11-15 03:32:43 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/8264329
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2326298-python-pydoctor/fedora-rawhide-x86_64/08264329-python-pydoctor/fedora-review/review.txt

Found issues:

- python3-toml is deprecated, you must not depend on it.
  Read more: https://docs.fedoraproject.org/en-US/packaging-guidelines/deprecating-packages/

Please know that there can be false-positives.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 11 Benson Muite 2024-12-09 03:57:44 UTC
Package Review
==============

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


Issues:
=======
- Package must not depend on deprecated() packages.
  Note: python3-toml is deprecated, you must not depend on it.
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/deprecating-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.
[ ]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "MIT License", "*No copyright* MIT
     License", "BSD 3-Clause License". 241 files have unknown license.
     Detailed output of licensecheck in
     /home/FedoraPackaging/reviews/python-pydoctor/2326298-python-
     pydoctor/licensecheck.txt
[!]: If the package is under multiple licenses, the licensing breakdown
     must be documented in the spec.
[x]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/python3.13/site-
     packages, /usr/lib/python3.13
[ ]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[ ]: Sources contain only permissible code or content.
[ ]: Macros in Summary, %description expandable at SRPM build time.
     Note: Macros in: python3-pydoctor (description)
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[ ]: 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.
[ ]: 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.
[ ]: 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 21188 bytes in 2 files.
[ ]: 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]: The License field must be a valid SPDX expression.
[x]: Package requires other packages for directories it uses.
[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]: 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:
[-]: 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.
[ ]: 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.
[ ]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.
[-]: 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.
[!]: %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-pydoctor-24.3.3-1.20240517git24.3.3.fc42.noarch.rpm
          python-pydoctor-24.3.3-1.20240517git24.3.3.fc42.src.rpm
============================ rpmlint session starts ============================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.12/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
rpmlintrc: [PosixPath('/tmp/tmp1gj0hrjd')]
checks: 32, packages: 2

python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/extra.css
python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/header.html
python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/subheader.html
python3-pydoctor.noarch: W: unexpanded-macro %description -l C %{description}
python-pydoctor.src: E: spelling-error ('epydoc', '%description -l en_US epydoc -> epoch')
python-pydoctor.src: E: spelling-error ('zope', '%description -l en_US zope -> ope, zone, nope')
python-pydoctor.spec: W: patch-not-applied Patch0: python-pydoctor-24.3.3-relax-lunr-version.patch
python3-pydoctor.noarch: W: no-manual-page-for-binary pydoctor
python3-pydoctor.noarch: W: description-shorter-than-summary
 2 packages and 0 specfiles checked; 5 errors, 4 warnings, 17 filtered, 5 badness; has taken 6.6 s 




Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.13/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 32, packages: 1

python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/extra.css
python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/header.html
python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/subheader.html
python3-pydoctor.noarch: W: unexpanded-macro %description -l C %{description}
python3-pydoctor.noarch: W: no-manual-page-for-binary pydoctor
python3-pydoctor.noarch: W: description-shorter-than-summary
 1 packages and 0 specfiles checked; 3 errors, 3 warnings, 13 filtered, 3 badness; has taken 2.0 s 



Source checksums
----------------
https://github.com/twisted/pydoctor/archive/24.3.3/pydoctor-24.3.3.tar.gz :
  CHECKSUM(SHA256) this package     : 42660efc1b89ad6a1438dfe22749c5c5e0d7ee323e5740722fd6f543b5ed4cd8
  CHECKSUM(SHA256) upstream package : 42660efc1b89ad6a1438dfe22749c5c5e0d7ee323e5740722fd6f543b5ed4cd8


Requires
--------
python3-pydoctor (rpmlib, GLIBC filtered):
    /usr/bin/python3
    python(abi)
    python3.13dist(appdirs)
    python3.13dist(attrs)
    python3.13dist(cachecontrol)
    python3.13dist(cachecontrol[filecache])
    python3.13dist(configargparse)
    python3.13dist(docutils)
    python3.13dist(lunr)
    python3.13dist(requests)
    python3.13dist(toml)
    python3.13dist(twisted)
    python3.13dist(urllib3)



Provides
--------
python3-pydoctor:
    python-pydoctor
    python3-pydoctor
    python3.13-pydoctor
    python3.13dist(pydoctor)
    python3dist(pydoctor)



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

Comments:
a) Please update to latest release 24.11.0
b) There are bundled font files
lato-bold.woff2
lato-normal.woff2
Roboto-Slab-Bold.woff2
Roboto-Slab-Regular.woff2
Can ttf fonts packaged in Fedora be used instead?
If not, licenses for these files should be added to the license list.
c) Can unit tests be run with tox?
d) Can a license breakdown be added to the spec file?

Comment 12 Jonathan Steffan 2024-12-14 17:29:16 UTC
Spec URL: https://jsteffan.fedorapeople.org/python-twisted/python-pydoctor.spec
SRPM URL: https://jsteffan.fedorapeople.org/python-twisted/python-pydoctor-24.11.1-1.20241208git24.11.1.fc40/python-pydoctor-24.11.1-1.20241208git24.11.1.fc42.src.rpm

a) Updated to 24.11.1 and removed patch that was addressed upstream
b) As this is a documentation generation program, and the theme is included as part of that, I think we are in the clear with shipping woffs https://docs.fedoraproject.org/en-US/packaging-guidelines/FontsPolicy/#_web_fonts
c) Added, thanks for noticing that
d) Added

Comment 13 Fedora Review Service 2024-12-14 17:34:57 UTC
Created attachment 2062469 [details]
The .spec file difference from Copr build 8264329 to 8393600

Comment 14 Fedora Review Service 2024-12-14 17:35:00 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/8393600
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2326298-python-pydoctor/fedora-rawhide-x86_64/08393600-python-pydoctor/fedora-review/review.txt

Please take a look if any issues were found.


---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 15 Yaakov Selkowitz 2025-01-01 18:15:08 UTC
Do you plan on continuing this review?  python-twisted has been FTBFS for months, and this is blocking a long-overdue update.

Comment 16 Benson Muite 2025-01-02 18:04:31 UTC
Package Review
==============

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



===== 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", "MIT License", "*No copyright* MIT
     License", "BSD 3-Clause License". 244 files have unknown license.
     Detailed output of licensecheck in
     /FedoraPackaging/reviews/python-pydoctor/2326298-python-
     pydoctor/licensecheck.txt
[x]: If the package is under multiple licenses, the licensing breakdown
     must be documented in the spec.
[x]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/python3.13,
     /usr/lib/python3.13/site-packages
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[ ]: Macros in Summary, %description expandable at SRPM build time.
     Note: Macros in: python3-pydoctor (description)
[-]: 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.
[ ]: 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 23728 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]: 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]: The License field must be a valid SPDX expression.
[x]: Package requires other packages for directories it uses.
[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]: 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:
[-]: 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.
[ ]: 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.
[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.
[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: python3-pydoctor-24.11.1-1.20241208git24.11.1.fc42.noarch.rpm
          python-pydoctor-24.11.1-1.20241208git24.11.1.fc42.src.rpm
============================ rpmlint session starts ============================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.13/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
rpmlintrc: [PosixPath('/tmp/tmp04ybnajs')]
checks: 32, packages: 2

python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/extra.css
python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/header.html
python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/subheader.html
python3-pydoctor.noarch: W: unexpanded-macro %description -l C %{description}
python-pydoctor.src: E: spelling-error ('epydoc', '%description -l en_US epydoc -> epoch')
python-pydoctor.src: E: spelling-error ('zope', '%description -l en_US zope -> ope, zone, nope')
python3-pydoctor.noarch: W: no-manual-page-for-binary pydoctor
python3-pydoctor.noarch: W: description-shorter-than-summary
 2 packages and 0 specfiles checked; 5 errors, 3 warnings, 16 filtered, 5 badness; has taken 2.2 s 




Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.13/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 32, packages: 1

python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/extra.css
python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/header.html
python3-pydoctor.noarch: E: zero-length /usr/lib/python3.13/site-packages/pydoctor/themes/base/subheader.html
python3-pydoctor.noarch: W: unexpanded-macro %description -l C %{description}
python3-pydoctor.noarch: W: no-manual-page-for-binary pydoctor
python3-pydoctor.noarch: W: description-shorter-than-summary
 1 packages and 0 specfiles checked; 3 errors, 3 warnings, 12 filtered, 3 badness; has taken 1.3 s 



Source checksums
----------------
https://github.com/twisted/pydoctor/archive/24.11.1/pydoctor-24.11.1.tar.gz :
  CHECKSUM(SHA256) this package     : 2f9648f19b45d8a8b3fece3f3f4160a50d798257807cdb9d8cc1f0a82770fcb5
  CHECKSUM(SHA256) upstream package : 2f9648f19b45d8a8b3fece3f3f4160a50d798257807cdb9d8cc1f0a82770fcb5


Requires
--------
python3-pydoctor (rpmlib, GLIBC filtered):
    (python3.13dist(lunr) < 0.8~~ with python3.13dist(lunr) >= 0.6.2)
    /usr/bin/python3
    python(abi)
    python3.13dist(attrs)
    python3.13dist(cachecontrol)
    python3.13dist(cachecontrol[filecache])
    python3.13dist(configargparse)
    python3.13dist(docutils)
    python3.13dist(platformdirs)
    python3.13dist(requests)
    python3.13dist(twisted)
    python3.13dist(urllib3)



Provides
--------
python3-pydoctor:
    python-pydoctor
    python3-pydoctor
    python3.13-pydoctor
    python3.13dist(pydoctor)
    python3dist(pydoctor)



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


Comments:
a) License tag is not needed:
$ rpm -qL python3-pydoctor-24.11.1-1.20241208git24.11.1.fc42.noarch.rpm
/usr/lib/python3.13/site-packages/pydoctor-24.11.1.dist-info/LICENSE.txt
/usr/share/licenses/python3-pydoctor/LICENSE.txt

Please change
%pyproject_save_files %{srcname}
to
%pyproject_save_files %{srcname} -l

and change
%files -n python3-%{srcname} -f %{pyproject_files}
%license LICENSE.txt
%doc README.rst CONTRIBUTING.rst
to
%files -n python3-%{srcname} -f %{pyproject_files}
%doc README.rst CONTRIBUTING.rst

see https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_build_macros

b) Fonts seem to be only imported in css files:
pydoctor/themes/readthedocs/readthedocstheme.css:    src: url(fonts/lato-normal.woff2) format("woff2"), url(fonts/lato-normal.woff) format("woff");
pydoctor/themes/readthedocs/readthedocstheme.css:    src: url(fonts/lato-bold.woff2) format("woff2"), url(fonts/lato-bold.woff) format("woff");
pydoctor/themes/readthedocs/readthedocstheme.css:    src: url(fonts/Roboto-Slab-Regular.woff2) format("woff2"), url(fonts/Roboto-Slab-Regular.woff) format("woff");
pydoctor/themes/readthedocs/readthedocstheme.css:    src: url(fonts/Roboto-Slab-Bold.woff2) format("woff2"), url(fonts/Roboto-Slab-Bold.woff) format("woff");


They could be replaced by ttf that is packaged in Fedora, but it is not blocking.

c) Tests still do not run.
https://github.com/twisted/cython-test-exception-raiser
seems to be required, but is not yet packaged.

Will attach a spec file that enables tests. Feel free to modify if it helps.


At present the following tests fail:
FAILED pydoctor/test/test_commandline.py::test_main_project_name_guess - DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp, datetime.UTC).
FAILED pydoctor/test/test_cyclic_imports_base_classes.py::test_cyclic_imports_base_classes - AssertionError: assert 1 == 0
 +  where 1 = wait()
 +    where wait = <Popen: returncode: 1 args: ['/usr/bin/python3', 'test_cyclic_imports_base_c...>.wait
FAILED pydoctor/test/test_commandline.py::test_main_project_name_option - DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp, datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_main_return_zero_on_warnings - DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp, datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_main_return_non_zero_on_warnings - DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp, datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_main_symlinked_paths - DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp, datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_main_source_outside_basedir - DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp, datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_make_intersphix - DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp, datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_index_symlink - DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp, datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_index_hardlink - DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp, datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_apidocs_help - DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp, datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_htmlbaseurl_option_all_pages - DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp, datetime.UTC).
FAILED pydoctor/test/test_configparser.py::test_unquote_naughty_quoted_strings - requests.exceptions.ConnectionError: HTTPSConnectionPool(host='raw.githubusercontent.com', port=443): Max retries exceeded with url: /minimaxir/big-list-of-naughty-strings/master/blns.txt (Caused by NameResolutionError("<urllib3.connection.HTTPSConnection object at 0x7fffa8980690>: Failed to resolve 'raw.githubusercontent.com' ([Errno -3] Temporary failure in name resolution)"))


See https://koji.fedoraproject.org/koji/taskinfo?taskID=127493857

Comment 17 Benson Muite 2025-01-02 18:51:04 UTC
Created attachment 2064547 [details]
Suggested spec file

Associated build https://koji.fedoraproject.org/koji/taskinfo?taskID=127495442

Please check build requirements for tests.

Comment 19 Fedora Review Service 2025-01-03 16:25:05 UTC
Created attachment 2064596 [details]
The .spec file difference from Copr build 8393600 to 8468686

Comment 20 Fedora Review Service 2025-01-03 16:25:07 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/8468686
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2326298-python-pydoctor/fedora-rawhide-x86_64/08468686-python-pydoctor/fedora-review/review.txt

Found issues:

- python3-pytest7 is deprecated, you must not depend on it.
  Read more: https://docs.fedoraproject.org/en-US/packaging-guidelines/deprecating-packages/

Please know that there can be false-positives.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 21 Jonathan Wright 2025-01-03 19:35:00 UTC
(> Found issues:
> 
> - python3-pytest7 is deprecated, you must not depend on it.
>   Read more:

This should not be a blocker.  The spec file is calling python3-pytest which is perfectly valid.  I believe this is a false positive.

Comment 22 Benson Muite 2025-01-04 08:31:15 UTC
Would be helpful to get the fonts problem clarified as it affects a number of other documentation generators.

Approved.

Comment 23 Fedora Admin user for bugzilla script actions 2025-01-04 16:58:34 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/python-pydoctor

Comment 24 Jonathan Steffan 2025-01-04 17:03:57 UTC
https://pagure.io/packaging-committee/issue/1428

Comment 25 Fedora Update System 2025-01-04 17:09:51 UTC
FEDORA-2025-0d83e23728 (python-pydoctor-24.11.1-1.20241208git24.11.1.fc42) has been submitted as an update to Fedora 42.
https://bodhi.fedoraproject.org/updates/FEDORA-2025-0d83e23728

Comment 26 Fedora Update System 2025-01-04 17:13:54 UTC
FEDORA-2025-0d83e23728 (python-pydoctor-24.11.1-1.20241208git24.11.1.fc42) has been pushed to the Fedora 42 stable repository.
If problem still persists, 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.