https://bugzilla.redhat.com/show_bug.cgi?id=2169846
Bug ID: 2169846 Summary: Review Request: python-moddb - ModDB Reader for Python Product: Fedora Version: rawhide Hardware: All OS: Linux Status: NEW Component: Package Review Severity: medium Priority: medium Assignee: nobody@fedoraproject.org Reporter: bunnyapocalypse@protonmail.com QA Contact: extras-qa@fedoraproject.org CC: package-review@lists.fedoraproject.org Target Milestone: --- Classification: Fedora
Spec URL: https://bunnyapocalypse.fedorapeople.org/python-moddb.spec SRPM URL: https://bunnyapocalypse.fedorapeople.org/python-moddb-0.8.1-1.fc37.src.rpm Description: Moddb is a mod database for videogames. This is a python client for navigating it. It is a requirement for the upcoming version of the Lutris package which I am a package maintainer for Fedora Account System Username: bunnyapocalypse
https://bugzilla.redhat.com/show_bug.cgi?id=2169846
Jakub Kadlčík jkadlcik@redhat.com changed:
What |Removed |Added ---------------------------------------------------------------------------- URL| |https://github.com/ClementJ | |18/moddb
--- Comment #1 from Jakub Kadlčík jkadlcik@redhat.com --- Copr build: https://copr.fedorainfracloud.org/coprs/build/5526544 (succeeded)
Review template: https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-rev...
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.
https://bugzilla.redhat.com/show_bug.cgi?id=2169846
Ben Beasley code@musicinmybrain.net changed:
What |Removed |Added ---------------------------------------------------------------------------- Doc Type|--- |If docs needed, set a value CC| |code@musicinmybrain.net
--- Comment #2 from Ben Beasley code@musicinmybrain.net --- Would you consider basing this on the current version of the Python guidelines?
https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/
You should find that doing so significantly simplifies this already-simple spec file.
Let me know if you have any questions about the details.
https://bugzilla.redhat.com/show_bug.cgi?id=2169846
Chris King bunnyapocalypse@protonmail.com changed:
What |Removed |Added ---------------------------------------------------------------------------- Flags| |needinfo?(code@musicinmybra | |in.net)
--- Comment #3 from Chris King bunnyapocalypse@protonmail.com --- Hi @code@musicinmybrain.net , thanks for the rec. I have changed the spec accordingly. It (and the corresponding SRPM are available using the same links as earlier.
https://bugzilla.redhat.com/show_bug.cgi?id=2169846
Ben Beasley code@musicinmybrain.net changed:
What |Removed |Added ---------------------------------------------------------------------------- Flags|needinfo?(code@musicinmybra | |in.net) |
--- Comment #4 from Ben Beasley code@musicinmybrain.net --- Did you try building this in mock? I get:
ERROR: %pyproject_check_import only works when %pyproject_save_files is used
Try this:
%install %pyproject_install %pyproject_save_files moddb
And this:
%files -n python3-moddb -f %{pyproject_files} %doc README.md
In this case, you don’t even need “%license LICENSE” because it is properly handled in pyproject_files. There are some packages where that isn’t the case (depending mostly on which build backend is used, e.g. setuptools/hatchling/flit-core/poetry), so it’s best to check:
$ rpm -qL -p python3-moddb-0.8.1-1.fc39.noarch.rpm /usr/lib/python3.11/site-packages/moddb-0.8.1.dist-info/LICENSE
You don’t really need to use %pyproject_check_import if you are running the tests with %pytest (and the test coverage is decent), although it’s fairly harmless to have both.
The PyPI sdist doesn’t have the tests in it, so you are going to need to package from the GitHub archive:
https://github.com/ClementJ18/moddb/archive/v%%7Bversion%7D/moddb-%%7Bversio...
…in order to run them. You are also going to need some of the BuildRequires in requirements-dev.txt, such as pytest. Don’t depend on black or flakeheaven (https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_linters), or on the sphinx packages if you are not building the documentation. Note that %pyproject_buildrequires *can* consume requirements text files.
https://bugzilla.redhat.com/show_bug.cgi?id=2169846
--- Comment #5 from Chris King bunnyapocalypse@protonmail.com --- Hey Thanks for the further feedback.
Regarding whether I ran mock on this, I did. I must've somehow not seen that it failed last night... Don't ask me how, probably has something to do with being tired...
Regardless. I've reworked the package to your suggestions with the exception of the test suite. Many of the tests rely on having a username and password for moddb in your os environment and I'm not aware of any way to safely do that in Fedora's build process.
Perhaps I could patch out all tests relating to that, but I'd imagine that's the large bulk of them...
As last time, the SRPM and SPEC are now updated.
https://bugzilla.redhat.com/show_bug.cgi?id=2169846
Chris King bunnyapocalypse@protonmail.com changed:
What |Removed |Added ---------------------------------------------------------------------------- Flags| |needinfo?(code@musicinmybra | |in.net)
--- Comment #6 from Chris King bunnyapocalypse@protonmail.com --- Hey @code@musicinmybrain.net , would you be able to review and approve this for me?
https://bugzilla.redhat.com/show_bug.cgi?id=2169846
Ben Beasley code@musicinmybrain.net changed:
What |Removed |Added ---------------------------------------------------------------------------- Flags| |fedora-review? Assignee|nobody@fedoraproject.org |code@musicinmybrain.net Status|NEW |ASSIGNED
https://bugzilla.redhat.com/show_bug.cgi?id=2169846
Ben Beasley code@musicinmybrain.net changed:
What |Removed |Added ---------------------------------------------------------------------------- Flags|fedora-review? |fedora-review+ |needinfo?(code@musicinmybra | |in.net) |
--- Comment #7 from Ben Beasley code@musicinmybrain.net --- The package is APPROVED, although I have a few suggestions:
Package Review ==============
Legend: [x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
===== Notes (no change required for approval) =====
- There is a typo in the changelog entry (Initital/initial)
- You can write the _description macro without backslash-continuations as:
%global _description %{expand: The goal of the library is to be able to navigate ModDB purely programmatically through scraping and parsing of the various models present on the website. This is based off a command of my bot which can parse either a game or a mod, this command gave birth to the original library which was extremely limited in its abilities and only able to parse a few pages with inconsistencies. This library is a much more mature and professional attempt at the whole idea, adding on a much deeper understanding of OOP.}
Personally, I would edit the upstream description to remove the first-person perspective (“my”).
- The Summary should not end with a period.
rpmlint says:
python-moddb.src: W: summary-ended-with-dot A Python scraper/parser for ModDB. python3-moddb.noarch: W: summary-ended-with-dot A Python scraper/parser for ModDB.
- You can, if you like, write the Source0 more concisely:
Source0: %{url}/archive/v%{version}/moddb-%{version}.tar.gz
- It would be good to add a spec-file comment in %check explaining why you aren’t running the upstream tests, e.g.:
%check # Upstream tests generally require network access and authentication %pyproject_check_import
===== 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". 64 files have unknown license. Detailed output of licensecheck in /home/reviewer/2169846-python-moddb/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]: 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.
$ rpm -qL -p results/python3-moddb-0.8.1-1.fc39.noarch.rpm /usr/lib/python3.11/site-packages/moddb-0.8.1.dist-info/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. [x]: Latest version is packaged. [x]: Package does not include license text files separate from upstream. [x]: 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. [x]: Package should compile and build into binary rpms on all supported architectures.
https://koji.fedoraproject.org/koji/taskinfo?taskID=98285467
[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-moddb-0.8.1-1.fc39.noarch.rpm python-moddb-0.8.1-1.fc39.src.rpm =============================================== rpmlint session starts =============================================== rpmlint: 2.4.0 configuration: /usr/lib/python3.11/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/tmpuqa11q1z')] checks: 31, packages: 2
python-moddb.src: W: summary-ended-with-dot A Python scraper/parser for ModDB. python3-moddb.noarch: W: summary-ended-with-dot A Python scraper/parser for ModDB. ================ 2 packages and 0 specfiles checked; 0 errors, 2 warnings, 0 badness; has taken 1.4 s ================
Rpmlint (installed packages) ---------------------------- ============================ rpmlint session starts ============================ rpmlint: 2.4.0 configuration: /usr/lib/python3.11/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 checks: 31, packages: 1
python3-moddb.noarch: W: summary-ended-with-dot A Python scraper/parser for ModDB. 1 packages and 0 specfiles checked; 0 errors, 1 warnings, 0 badness; has taken 0.1 s
Source checksums ---------------- https://github.com/ClementJ18/moddb/archive/v0.8.1/moddb-0.8.1.tar.gz : CHECKSUM(SHA256) this package : 43a104f76dd7d5fbc3b46e36f041b3391e4b970aceba42fc5bb59cf1405c631d CHECKSUM(SHA256) upstream package : 43a104f76dd7d5fbc3b46e36f041b3391e4b970aceba42fc5bb59cf1405c631d
Requires -------- python3-moddb (rpmlib, GLIBC filtered): python(abi) python3.11dist(beautifulsoup4) python3.11dist(pyrate-limiter) python3.11dist(requests) python3.11dist(toolz)
Provides -------- python3-moddb: python-moddb python3-moddb python3.11-moddb python3.11dist(moddb) python3dist(moddb)
Generated by fedora-review 0.9.0 (6761b6c) last change: 2022-08-23 Command line :/usr/bin/fedora-review -b 2169846 Buildroot used: fedora-rawhide-x86_64 Active plugins: Shell-api, Generic, Python Disabled plugins: Java, PHP, Ocaml, SugarActivity, fonts, Perl, R, C/C++, Haskell Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH
https://bugzilla.redhat.com/show_bug.cgi?id=2169846
--- Comment #8 from Fedora Admin user for bugzilla script actions fedora-admin-xmlrpc@fedoraproject.org --- The Pagure repository was created at https://src.fedoraproject.org/rpms/python-moddb
package-review@lists.fedoraproject.org