Bug 2299129 - Review Request: python-grip - Render local readme files before sending off to GitHub
Summary: Review Request: python-grip - Render local readme files before sending off to...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Ankur Sinha (FranciscoD)
QA Contact: Fedora Extras Quality Assurance
URL: https://github.com/joeyespo/grip
Whiteboard:
Depends On: 2299127
Blocks: fedora-neuro, NeuroFedora
TreeView+ depends on / blocked
 
Reported: 2024-07-21 19:07 UTC by Sandro
Modified: 2024-08-01 07:48 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2024-08-01 07:48:07 UTC
Type: ---
Embargoed:
sanjay.ankur: fedora-review+


Attachments (Terms of Use)

Description Sandro 2024-07-21 19:07:44 UTC
Spec URL: https://gui1ty.fedorapeople.org/review/python-grip.spec
SRPM URL: https://gui1ty.fedorapeople.org/review/python-grip-4.6.2-1.fc41.src.rpm

Description:

Grip is a command-line server application written in Python that uses
the GitHub markdown API to render a local readme file. The styles and
rendering come directly from GitHub, so you'll know exactly how it will
appear. Changes you make to the Readme will be instantly reflected in
the browser without requiring a page refresh.

Fedora Account System Username: gui1ty

Comment 1 Ankur Sinha (FranciscoD) 2024-07-30 12:51:01 UTC
Package Review
==============

Looking good. I noticed it bundles fonts, octicons (MIT licensed). I guess we
should at least note the bundling in the spec?

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


Issues:
=======
- Dist tag is present.


===== 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". 69 files have unknown
     license. Detailed output of licensecheck in /home/asinha/dump/fedora-
     reviews/2299129-python-grip/licensecheck.txt
[-]: Package requires other packages for directories it uses.
     Note: No known owner of /usr/share/man/man1, /usr/lib/python3.13/site-
     packages, /usr/share, /usr/lib, /usr/lib/python3.13, /usr/share/man,
     /usr/bin, /usr, /usr/share/doc
[x]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/python3.13,
     /usr/share/man/man1, /usr/lib/python3.13/site-packages, /usr/share,
     /usr/share/man, /usr/lib, /usr/bin, /usr, /usr/share/doc
[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.
[x]: 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.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 46186 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 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]: 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:
[!]: Avoid bundling fonts in non-fonts packages.
     Note: Package contains font files

^
bundles octicons:
https://github.com/primer/octicons/

Also under the MIT license, so should be OK, but perhaps we need to note the bundling in the spec?

[-]: 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).
[x]: Package functions as described.
^
All tests pass

[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.
[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:
[!]: Spec file according to URL is the same as in SRPM.
     Note: Spec file as given by url is not the same as in SRPM (see
     attached diff).
     See: (this test has no URL)

^
Using rpmautospec, we're fine.
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).

^
These are OK.


Rpmlint
-------
Checking: python3-grip-4.6.2-1.fc41.noarch.rpm
          python-grip-4.6.2-1.fc41.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/tmpzhl477jt')]
checks: 32, packages: 2

python-grip.src: E: spelling-error ('readme', 'Summary(en_US) readme -> reamed, remade, read me')
python-grip.src: E: spelling-error ('readme', '%description -l en_US readme -> reamed, remade, read me')
python3-grip.noarch: E: spelling-error ('readme', 'Summary(en_US) readme -> reamed, remade, read me')
python3-grip.noarch: E: spelling-error ('readme', '%description -l en_US readme -> reamed, remade, read me')
python-grip.spec: W: patch-not-applied Patch0: unvendor_six.patch

^
These are OK.

============================================= 2 packages and 0 specfiles checked; 4 errors, 1 warnings, 15 filtered, 4 badness; has taken 0.4 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-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: 32, packages: 1

python3-grip.noarch: E: spelling-error ('readme', 'Summary(en_US) readme -> reamed, remade, read me')
python3-grip.noarch: E: spelling-error ('readme', '%description -l en_US readme -> reamed, remade, read me')
 1 packages and 0 specfiles checked; 2 errors, 0 warnings, 11 filtered, 2 badness; has taken 0.1 s 



Source checksums
----------------
https://github.com/joeyespo/grip/archive/ed3adea5a2f32af8062a97917e26a61dfe9fb589/grip-ed3adea5a2f32af8062a97917e26a61dfe9fb589.tar.gz :
  CHECKSUM(SHA256) this package     : c14c57b0dc6bf58a1a67a1303a39a7f2436b130214e21eb3a9ecc850e4820107
  CHECKSUM(SHA256) upstream package : c14c57b0dc6bf58a1a67a1303a39a7f2436b130214e21eb3a9ecc850e4820107


Requires
--------
python3-grip (rpmlib, GLIBC filtered):
    /usr/bin/python3
    python(abi)
    python3.13dist(docopt)
    python3.13dist(flask)
    python3.13dist(markdown)
    python3.13dist(path-and-address)
    python3.13dist(pygments)
    python3.13dist(requests)
    python3.13dist(six)
    python3.13dist(werkzeug)



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



Diff spec file in url and in SRPM
---------------------------------
--- /home/asinha/dump/fedora-reviews/2299129-python-grip/srpm/python-grip.spec	2024-07-30 13:32:38.539226932 +0100
+++ /home/asinha/dump/fedora-reviews/2299129-python-grip/srpm-unpacked/python-grip.spec	2024-07-21 01:00:00.000000000 +0100
@@ -1,2 +1,12 @@
+## START: Set by rpmautospec
+## (rpmautospec version 0.6.3)
+## RPMAUTOSPEC: autorelease, autochangelog
+%define autorelease(e:s:pb:n) %{?-p:0.}%{lua:
+    release_number = 1;
+    base_release_number = tonumber(rpm.expand("%{?-b*}%{!?-b:1}"));
+    print(release_number + base_release_number - 1);
+}%{?-e:.%{-e*}}%{?-s:.%{-s*}}%{!?-n:%{?dist}}
+## END: Set by rpmautospec
+
 %global pypi_name grip
 
@@ -83,3 +93,6 @@
 
 %changelog
-%autochangelog
+## START: Generated by rpmautospec
+* Sun Jul 21 2024 Sandro <devel> - 4.6.2-1
+- Initial package
+## END: Generated by rpmautospec


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

Comment 2 Sandro 2024-07-30 14:10:17 UTC
(In reply to Ankur Sinha (FranciscoD) from comment #1)
> Package Review
> ==============
> 
> Looking good. I noticed it bundles fonts, octicons (MIT licensed). I guess we
> should at least note the bundling in the spec?

Good catch. I think a 'Provides bundled(...)' would be warranted. Though, I'm not exactly sure what to put in place of '...'.

Having bumped into a few questionable items license wise, I'm also wondering about [1]:

```
(c) GitHub, Inc.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.

Code License: MIT Applies to all other files
```

I will check that no GitHub logos are being used, in which case I assume you are right that MIT should apply.

[1] https://github.com/primer/octicons/tree/main#license

Comment 3 Sandro 2024-07-30 15:20:25 UTC
I added a Provides for the bundled fonts.

Spec URL: https://gui1ty.fedorapeople.org/review/python-grip.spec
SRPM URL: https://gui1ty.fedorapeople.org/review/python-grip-4.6.2-2.fc41.src.rpm

Comment 4 Ankur Sinha (FranciscoD) 2024-07-31 09:33:36 UTC
Looks good. XXX APPROVED XXX

Comment 5 Fedora Admin user for bugzilla script actions 2024-08-01 07:27:44 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/python-grip

Comment 6 Fedora Update System 2024-08-01 07:43:43 UTC
FEDORA-2024-5e9506abc4 (python-grip-4.6.2-1.fc41) has been submitted as an update to Fedora 41.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-5e9506abc4

Comment 7 Fedora Update System 2024-08-01 07:48:07 UTC
FEDORA-2024-5e9506abc4 (python-grip-4.6.2-1.fc41) has been pushed to the Fedora 41 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.