Bug 2252778 - Review Request: python3-gql - GraphQL Library/Client for Python 3.6+
Summary: Review Request: python3-gql - GraphQL Library/Client for Python 3.6+
Keywords:
Status: POST
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
unspecified
medium
Target Milestone: ---
Assignee: Orion Poplawski
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-12-04 16:03 UTC by Andrej Manduch
Modified: 2024-04-03 17:23 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Type: ---
Embargoed:
orion: fedora-review+


Attachments (Terms of Use)

Description Andrej Manduch 2023-12-04 16:03:41 UTC
Spec URL: https://download.copr.fedorainfracloud.org/results/burlak/python3-gql/fedora-rawhide-x86_64/06723744-python-gql/python-gql.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/burlak/python3-gql/fedora-rawhide-x86_64/06723744-python-gql/python-gql-3.5.0b8-2.fc40.src.rpm
Description: 
This is a GraphQL client for Python 3.6+. Plays nicely with graphene, graphql-core, graphql-js and any other GraphQL implementation compatible with the spec.

GQL architecture is inspired by React-Relay and Apollo-Client.



Fedora Account System Username: burlak

Comment 1 Andrej Manduch 2023-12-06 18:18:31 UTC
I made few fixes in specfile (changed description line length so it would pass fedpkg lint and removed unnecessary build dependencies that I added before for tests)

Spec URL: https://download.copr.fedorainfracloud.org/results/burlak/python3-gql/fedora-rawhide-aarch64/06729440-python-gql/python-gql.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/burlak/python3-gql/fedora-rawhide-aarch64/06729440-python-gql/python-gql-3.5.0b8-2.fc40.src.rpm
Description: 
This is a GraphQL client for Python 3.6+. Plays nicely with graphene, graphql-core, graphql-js and any other GraphQL implementation compatible with the spec.

GQL architecture is inspired by React-Relay and Apollo-Client.



Fedora Account System Username: burlak

Comment 2 Orion Poplawski 2023-12-09 20:52:42 UTC
Package Review
==============

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

===== ISSUES =====

* You are using an old python template will old macro (%python_provide).  Please check out the updated guidelines - https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/.  This should also resolve the unowned directories.  ALso note that removal of .egg-info is no longer needed.

* It seems to bundle gql-checker in the source, but not in the packaged files, so I think we are okay there.  But worth looking into unbundling it.

* Remove the rpmautospec cruft from the .spec file and build your src.rpm with rpmbuild -bs *.spec to avoid the rpmautospec stuff I think.  Definitely don't want to import that.

* Use %{_bindir}

* Do you really need the latest beta?

* Add %check with running tests

===== 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. No licenses
     found. Please check the source files for licenses manually.
[!]: Package requires other packages for directories it uses.
     Note: No known owner of /usr/lib/python3.12/site-
     packages/gql/utilities, /usr/lib/python3.12/site-
     packages/gql/transport, /usr/lib/python3.12/site-
     packages/gql/__pycache__, /usr/lib/python3.12/site-
     packages/gql/transport/__pycache__, /usr/lib/python3.12/site-
     packages/gql-3.5.0b8-py3.12.egg-info, /usr/lib/python3.12/site-
     packages/gql/utilities/__pycache__, /usr/lib/python3.12/site-
     packages/gql
[!]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/python3.12/site-
     packages/gql, /usr/lib/python3.12/site-packages/gql/__pycache__,
     /usr/lib/python3.12/site-packages/gql/transport/__pycache__,
     /usr/lib/python3.12/site-packages/gql/utilities,
     /usr/lib/python3.12/site-packages/gql/utilities/__pycache__,
     /usr/lib/python3.12/site-packages/gql/transport,
     /usr/lib/python3.12/site-packages/gql-3.5.0b8-py3.12.egg-info
[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.
[!]: 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.
[!]: 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]: 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]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 4342 bytes in 1 files.
[x]: Packages must not store files under /srv, /opt or /usr/local

Python:
[-]: Binary eggs must be removed in %prep
     Note: Cannot find any build in BUILD directory (--prebuilt option?)
[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.
[!]: 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

===== 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).
[x]: 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.
[!]: Spec use %global instead of %define unless justified.
     Note: %define requiring justification: %define autorelease(e:s:pb:n)
     %{?-p:0.}%{lua:
[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.

===== 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-gql-3.5.0b8-2.fc40.noarch.rpm
          python-gql-3.5.0b8-2.fc40.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/tmpcyhytdua')]
checks: 32, packages: 2

python-gql.src: E: spelling-error ('graphql', '%description -l en_US graphql -> graph')
python3-gql.noarch: E: spelling-error ('graphene', '%description -l en_US graphene -> geographer')
python3-gql.noarch: E: spelling-error ('graphql', '%description -l en_US graphql -> graph')
python3-gql.noarch: E: spelling-error ('js', '%description -l en_US js -> dis, ks, j')
python3-gql.noarch: W: python-missing-require yarl
python3-gql.noarch: W: python-missing-require backoff
python3-gql.noarch: W: no-manual-page-for-binary gql-cli
===================================================================== 2 packages and 0 specfiles checked; 4 errors, 3 warnings, 7 filtered, 4 badness; has taken 1.1 s =====================================================================




Rpmlint (installed packages)
----------------------------
============================ 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
checks: 32, packages: 1

python3-gql.noarch: E: spelling-error ('graphene', '%description -l en_US graphene -> geographer')
python3-gql.noarch: E: spelling-error ('graphql', '%description -l en_US graphql -> graph')
python3-gql.noarch: E: spelling-error ('js', '%description -l en_US js -> dis, ks, j')
python3-gql.noarch: W: python-missing-require yarl
python3-gql.noarch: W: python-missing-require backoff
python3-gql.noarch: W: no-manual-page-for-binary gql-cli
 1 packages and 0 specfiles checked; 3 errors, 3 warnings, 3 filtered, 3 badness; has taken 0.3 s



Source checksums
----------------
https://github.com/graphql-python/gql/archive/v3.5.0b8/v3.5.0b8.tar.gz :
  CHECKSUM(SHA256) this package     : a8ce99ac897a0213e5daf791593ddf91d2f1e0ed26c95b335d377574601736cb
  CHECKSUM(SHA256) upstream package : a8ce99ac897a0213e5daf791593ddf91d2f1e0ed26c95b335d377574601736cb


Requires
--------
python3-gql (rpmlib, GLIBC filtered):
    /usr/bin/python3
    python(abi)
    python3-graphql-core



Provides
--------
python3-gql:
    python-gql
    python3-gql
    python3.12-gql



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

Comment 3 Andrej Manduch 2023-12-25 18:40:18 UTC
Spec URL: https://download.copr.fedorainfracloud.org/results/burlak/python3-gql/fedora-39-x86_64/06814416-python-gql/python-gql.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/burlak/python3-gql/fedora-39-x86_64/06814416-python-gql/python-gql-3.4.1-1.fc39.src.rpm

Hi Orion, Thanks for the review.

I'm posting a new spec file and srpm where I tried to fix the issues you mentioned.


> * You are using an old python template will old macro (%python_provide).  Please check out the updated guidelines - https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/.  This should also resolve the unowned directories.  ALso note that removal of .egg-info is no longer needed.

I changed %py3_build  to %pyproject_wheel and %py3_install to %pyproject_install, with this I also included build dependendies for python3-pip and python3-whel.

> * It seems to bundle gql-checker in the source, but not in the packaged files, so I think we are okay there.  But worth looking into unbundling it.
> * Remove the rpmautospec cruft from the .spec file and build your src.rpm with rpmbuild -bs *.spec to avoid the rpmautospec stuff I think.  Definitely don't want to import that.
I removed %autorelease and %autochangelog

> * Use %{_bindir}

done

> * Do you really need the latest beta?
Not really, I felt it's most appropriate as it's the latest version on pip, and changes seem insignificant, but I don't care. I changed it to last non-beta release.

> * Add %check with running tests
This night be a bit tricky. As far as I know, all (or at least most) tests in gql library need an internet connection, and I believe it's not available in the fedora build process. Do you have any suggestions on how can I fix it?

Comment 4 Andrej Manduch 2024-02-11 12:56:45 UTC
I just want to remind myself and ask you if you'll have time time to do a review and maybe ask my questions :)

In meantime as there were updates on upstream I also updated my package:

Spec URL: https://pastebin.com/raw/FpaT1Abm
SRPM URL: https://download.copr.fedorainfracloud.org/results/burlak/python3-gql/fedora-39-x86_64/07007542-python-gql/python-gql-3.5.0-1.fc39.src.rpm

Comment 5 Orion Poplawski 2024-02-11 20:18:46 UTC
Sorry for the delay, missed this over the holidays.  

I would suggest:

Source:         https://github.com/graphql-python/gql/archive/v%{version}/%{name}-%{version}.tar.gz

Still no %check.  It looks like upstream already does not run tests that need online resources unless --run-online is given to pytest.

No need to remove .egg-info

Are the Requires not picked up automatically?  This is what I get without them:
Requires: (python3.12dist(anyio) < 5~~ with python3.12dist(anyio) >= 3) (python3.12dist(backoff) < 3~~ with python3.12dist(backoff) >= 1.11.1) (python3.12dist(graphql-core) < 3.3~~ with python3.12dist(graphql-core) >= 3.2) (python3.12dist(yarl) < 2~~ with python3.12dist(yarl) >= 1.6) /usr/bin/python3 python(abi) = 3.12

Use %pyproject_save_files

Do rm -r gql-checker in %prep to make it clear it's not needed/used.

This is what I have:  https://fedorapeople.org/~orion/python-gql.spec

Comment 6 Andrej Manduch 2024-02-16 16:50:23 UTC
Hi Orion,

Thanks for response.

> Sorry for the delay, missed this over the holidays.
Don't even worry about it.


> Still no %check.  It looks like upstream already does not run tests that need online resources unless --run-online is given to pytest.
Thanks, I didn't realize that. Last time when I tried that it was running online tests. But maybe I was doing something wrong.


Thanks for all the changes and points. One thing I noticed is that in your spec file was an incorrect tarball name. Other than that I would love to use the one what you provided.

Spec URL: https://download.copr.fedorainfracloud.org/results/burlak/python3-gql/fedora-39-aarch64/07026340-python-gql/python-gql.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/burlak/python3-gql/fedora-39-aarch64/07026340-python-gql/python-gql-3.5.0-1.fc39.src.rpm

Comment 7 Orion Poplawski 2024-02-16 23:40:53 UTC
Great.  Welcome aboard!

Comment 8 Fedora Review Service 2024-02-17 02:49:00 UTC
Hello @burlak,
since this is your first Fedora package, you need to get sponsored by a package
sponsor before it can be accepted.

A sponsor is an experienced package maintainer who will guide you through
the processes that you will follow and the tools that you will use as a future
maintainer. A sponsor will also be there to answer your questions related to
packaging.

You can find all active sponsors here:
https://docs.pagure.org/fedora-sponsors/

I created a sponsorship request for you:
https://pagure.io/packager-sponsors/issue/626
Please take a look and make sure the information is correct.

Thank you, and best of luck on your packaging journey.

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

Comment 9 Orion Poplawski 2024-03-20 00:20:22 UTC
Andrej - you should be free to import and build this now.

Comment 10 Andrej Manduch 2024-04-03 17:16:05 UTC
@orion Thanks for the heads up, I was a bit procrastinating :)

Comment 11 Fedora Admin user for bugzilla script actions 2024-04-03 17:23:20 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/python3-gql


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