Bug 2083142 - Review Request: cffconvert - Command line program to validate and convert CITATION.cff files
Summary: Review Request: cffconvert - Command line program to validate and convert CIT...
Keywords:
Status: CLOSED RAWHIDE
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:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-05-09 12:53 UTC by Iztok Fister Jr.
Modified: 2022-06-28 07:09 UTC (History)
3 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2022-06-28 07:09:14 UTC
Type: ---
Embargoed:
sanjay.ankur: fedora-review+


Attachments (Terms of Use)

Description Iztok Fister Jr. 2022-05-09 12:53:43 UTC
Spec URL: https://raw.githubusercontent.com/firefly-cpp/rpm-reviews/cffconvert/python-cffconvert.spec
SRPM URL: https://github.com/firefly-cpp/rpm-reviews/raw/cffconvert/python-cffconvert-2.0.0-1.fc34.src.rpm
Description: Implementation of Command-line program to validate and convert
CITATION.cff files in Python.
Fedora Account System Username: iztokf

Comment 1 Ben Beasley 2022-05-11 13:09:56 UTC
I started working on a review before I noticed Ankur had taken this bug. I’ll still follow up with my informal suggestions.

Comment 2 Ankur Sinha (FranciscoD) 2022-05-11 13:43:21 UTC
Sorry about that Ben.

Here's my review, please add anything I've missed.

Looks very good, a few minor fixes to be made:


Package Review
==============

[x]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
^
The pyproject macros already include the license file, so you can remove the `%license ..` line
$ rpm -ql --licensefiles -p ./python3-cffconvert-2.0.0-1.fc37.noarch.rpm
/usr/lib/python3.10/site-packages/cffconvert-2.0.0.dist-info/LICENSE
/usr/share/licenses/python3-cffconvert/LICENSE

[!]: %check is present and all tests pass.
^
I see some tests fail.
Should we at least add comments to note what the failures are to begin with.
Ideally, we should also report these upstream and where possible submit
patches.


- Optional: we could generate a man page (using `help2man` , for example) and
  include it in the package + submit it upstream.

- I don't think the make BR is being used for anything, so we should remove it.

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", "*No copyright* Apache License 2.0",
     "*No copyright* Apache License". 1014 files have unknown license.
     Detailed output of licensecheck in /home/asinha/dump/fedora-
     reviews/2083142-python-cffconvert/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.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 20480 bytes in 9 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:
[x]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
^
The pyproject macros already include the license file, so you can remove the `%license ..` line
$ rpm -ql --licensefiles -p ./python3-cffconvert-2.0.0-1.fc37.noarch.rpm
/usr/lib/python3.10/site-packages/cffconvert-2.0.0.dist-info/LICENSE
/usr/share/licenses/python3-cffconvert/LICENSE


[x]: Final provides and requires are sane (see attachments).
[x]: Package functions as described.
^
Tests pass.

[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.
^
I see some tests fail.
Should we at least add comments to note what the failures are to begin with. Ideally, we should also report these upstream and where possible submit patches.

[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
-------
Cannot parse rpmlint output:


rpmlint *.rpm
======================================================== rpmlint session starts ========================================================
rpmlint: 2.2.0
configuration:
    /usr/lib/python3.10/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/licenses.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 32, packages: 2

python3-cffconvert.noarch: W: no-manual-page-for-binary cffconvert
^
We could generate a man page and include it in the package + submit it upstream, but this is optional.


python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/schemaorg_urls.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_0_x/schemaorg_urls.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/apalike_author.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/apalike_author.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/apalike_url.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/apalike_url.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/bibtex_author.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/bibtex_author.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/bibtex_url.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/bibtex_url.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/endnote_author.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/endnote_author.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/endnote_url.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/endnote_url.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/ris_author.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/ris_author.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/ris_url.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/ris_url.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/schemaorg_author.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/schemaorg_author.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/zenodo_creator.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/zenodo_creator.py
======================== 2 packages and 0 specfiles checked; 0 errors, 12 warnings, 0 badness; has taken 0.7 s =========================


^ These are fine.


rpmlint ../srpm-unpacked/python-cffconvert.spec
======================================================== rpmlint session starts ========================================================
rpmlint: 2.2.0
configuration:
    /usr/lib/python3.10/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/licenses.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 32, packages: 1

========================= 0 packages and 1 specfiles checked; 0 errors, 0 warnings, 0 badness; has taken 0.6 s =========================


Rpmlint (installed packages)
----------------------------
Cannot parse rpmlint output:

*sigh*

Source checksums
----------------
https://github.com/citation-file-format/cff-converter-python/archive/2.0.0/cff-converter-python-2.0.0.tar.gz :
  CHECKSUM(SHA256) this package     : 81915a8b1e8ec342af218155c7db2f079a12da8e60c46f5579060b2c3a7109b5
  CHECKSUM(SHA256) upstream package : 81915a8b1e8ec342af218155c7db2f079a12da8e60c46f5579060b2c3a7109b5


Requires
--------
python3-cffconvert (rpmlib, GLIBC filtered):
    (python3.10dist(click) < 9~~ with python3.10dist(click) >= 7)
    (python3.10dist(jsonschema) < 4~~ with python3.10dist(jsonschema) >= 3)
    (python3.10dist(requests) < 3~~ with python3.10dist(requests) >= 2.20)
    /usr/bin/python3
    python(abi)
    python3.10dist(pykwalify)
    python3.10dist(ruamel-yaml)



Provides
--------
python3-cffconvert:
    python-cffconvert
    python3-cffconvert
    python3.10-cffconvert
    python3.10dist(cffconvert)
    python3dist(cffconvert)



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

Comment 3 Ben Beasley 2022-05-12 13:24:44 UTC
Package Review
==============

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

===== Issues =====

- It looks like this is purely a command-line tool and is not intended to be
  used as a Python library. It should therefore be named “cffconvert” rather
  than “python-cffconvert”. The appropriate 'python3dist(…)' Provides will
  still be generated.

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

  To change the name, you should be able to change the title of this bug and
  re-upload spec/SRPM under the new name, rather than having to create a new
  bug.

- Consider adding some or all of these as %doc, too:

    CHANGELOG.md
    CITATION.cff
    CONTRIBUTING.md

- There is a “gcloud” extra that should be packaged in accordance with:

    https://fedoraproject.org/wiki/Changes/PythonExtras#Extras_metapackages

  Assuming you have renamed the package to “cffconvert”, this can look like:

    %pyproject_extras_subpkg -n %{pypi_name} gcloud

  You can/should also install the corresponding BuildRequires:

    %pyproject_buildrequires -x gcloud

  Even if not needed in the tests, this helps confirm that the extras metapackage
  will be installable.

- You should patch out the dependency on python3dist(pytest-cov):

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

  Remove:

    BuildRequires:  python3dist(pytest-cov)

  and in %prep, add something like:

    # https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_linters
    sed -r -i 's/--[^[:blank:]]*\bcov\b[^[:blank:]]*//' setup.cfg

- It looks like you can fix all of the tests by changing

    %pytest -k '…'

  to

    %pytest -v

  which is a little bit crazy. I think the -v option is affecting how pytest
  handles the standard I/O descriptors, and the tests are sensitive to the
  difference.

- This doesn’t seem to be needed:

    BuildRequires:  make

- A man page is always desired for a command-line tool:

  https://docs.fedoraproject.org/en-US/packaging-guidelines/#_manpages

  You can generate an adequate one by adding:

    BuildRequires:  help2man

  then, in %install:

    install -d '%{buildroot}%{_mandir}/man1'
    env PATH="${PATH}:%{buildroot}%{_bindir}" \
        PYTHONPATH='%{buildroot}%{python3_sitelib}' \
        help2man --no-info '%{pypi_name}' \
            --output='%{buildroot}%{_mandir}/man1/%{pypi_name}.1'

  (doing this in %build could be possible but would be much fussier), then, in
  %files:

     %{_mandir}/man1/%{pypi_name}.1*

===== Notes (no change required) =====

- In this case, pyproject_files properly marks the license file in dist-info, and

    %license LICENSE

  is not required. You can verify this with:

    rpm -qL -p results/python3-cffconvert-2.0.0-1.fc37.noarch.rpm

  If you’re going to rely on pyproject_files for the license file, it’s always
  worth checking that it actually works. It doesn’t work for most
  non-setuptools build backends, and for setuptools it’s based on a license
  file name heuristic, so it doesn’t work for all packages. It should keep
  working as long as the build backend and license file name stay the same.

===== 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", "*No copyright* Apache License 2.0",
     "*No copyright* Apache License". 1014 files have unknown license.
     Detailed output of licensecheck in /home/reviewer/2083142-python-
     cffconvert/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).
[!]: Package is named according to the Package Naming Guidelines.

     Application package should not be named “python-foo”

[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 20480 bytes in 9 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

     (except application naming)

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

     (tests pass)

[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.

     Some tests are skipped because they fail.

[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
-------
Cannot parse rpmlint output:


Rpmlint (installed packages)
----------------------------
Cannot parse rpmlint output:


Source checksums
----------------
https://github.com/citation-file-format/cff-converter-python/archive/2.0.0/cff-converter-python-2.0.0.tar.gz :
  CHECKSUM(SHA256) this package     : 81915a8b1e8ec342af218155c7db2f079a12da8e60c46f5579060b2c3a7109b5
  CHECKSUM(SHA256) upstream package : 81915a8b1e8ec342af218155c7db2f079a12da8e60c46f5579060b2c3a7109b5


Requires
--------
python3-cffconvert (rpmlib, GLIBC filtered):
    (python3.10dist(click) < 9~~ with python3.10dist(click) >= 7)
    (python3.10dist(jsonschema) < 4~~ with python3.10dist(jsonschema) >= 3)
    (python3.10dist(requests) < 3~~ with python3.10dist(requests) >= 2.20)
    /usr/bin/python3
    python(abi)
    python3.10dist(pykwalify)
    python3.10dist(ruamel-yaml)



Provides
--------
python3-cffconvert:
    python-cffconvert
    python3-cffconvert
    python3.10-cffconvert
    python3.10dist(cffconvert)
    python3dist(cffconvert)



Generated by fedora-review 0.8.0 (e988316) last change: 2022-04-07
Command line :/usr/bin/fedora-review -b 2083142
Buildroot used: fedora-rawhide-x86_64
Active plugins: Python, Shell-api, Generic
Disabled plugins: Perl, PHP, C/C++, Haskell, Java, R, fonts, SugarActivity, Ocaml
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH
============================ rpmlint session starts ============================
rpmlint: 2.2.0
configuration:
    /usr/lib/python3.10/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/licenses.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 32, packages: 2

python3-cffconvert.noarch: W: no-manual-page-for-binary cffconvert
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/schemaorg_urls.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_0_x/schemaorg_urls.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/apalike_author.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/apalike_author.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/apalike_url.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/apalike_url.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/bibtex_author.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/bibtex_author.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/bibtex_url.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/bibtex_url.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/endnote_author.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/endnote_author.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/endnote_url.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/endnote_url.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/ris_author.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/ris_author.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/ris_url.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/ris_url.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/schemaorg_author.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/schemaorg_author.py
python3-cffconvert.noarch: W: files-duplicate /usr/lib/python3.10/site-packages/cffconvert/behavior_1_2_x/zenodo_creator.py /usr/lib/python3.10/site-packages/cffconvert/behavior_1_1_x/zenodo_creator.py
 2 packages and 0 specfiles checked; 0 errors, 12 warnings, 0 badness; has taken 0.6 s

Comment 4 Iztok Fister Jr. 2022-05-14 13:23:10 UTC
I thank both reviewers for their helpful comments. All issues are now resolved in the revision. For a more accessible 
following of the changes, I am attaching point-to-point answers to the comments you raised.
------------------------------------

Review 1:
===========
1. I see some tests fail.
Should we at least add comments to note what the failures are to begin with.
Ideally, we should also report these upstream and where possible submit
patches.

ANSWER: Some files are missing also in the upstream repository.

2. - Optional: we could generate a man page (using `help2man` , for example) and
  include it in the package + submit it upstream.

ANSWER: Man page generated.
  
3. - I don't think the make BR is being used for anything, so we should remove it.

ANSWER: make BR was removed.
-----------------

Review 2:
===============

1. It looks like this is purely a command-line tool and is not intended to be
  used as a Python library. It should therefore be named “cffconvert” rather
  than “python-cffconvert”. The appropriate 'python3dist(…)' Provides will
  still be generated.

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

  To change the name, you should be able to change the title of this bug and
  re-upload spec/SRPM under the new name, rather than having to create a new
  bug.

ANSWER: Done!

2. - Consider adding some or all of these as %doc, too:

    CHANGELOG.md
    CITATION.cff
    CONTRIBUTING.md

ANSWER: Done!
    
3.  There is a “gcloud” extra that should be packaged in accordance with:

    https://fedoraproject.org/wiki/Changes/PythonExtras#Extras_metapackages

  Assuming you have renamed the package to “cffconvert”, this can look like:

    %pyproject_extras_subpkg -n %{pypi_name} gcloud

  You can/should also install the corresponding BuildRequires:

    %pyproject_buildrequires -x gcloud

  Even if not needed in the tests, this helps confirm that the extras metapackage
  will be installable.

ANSWER: Done!
  
4. - You should patch out the dependency on python3dist(pytest-cov):

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

  Remove:

    BuildRequires:  python3dist(pytest-cov)

  and in %prep, add something like:

    # https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_linters
    sed -r -i 's/--[^[:blank:]]*\bcov\b[^[:blank:]]*//' setup.cfg

- It looks like you can fix all of the tests by changing

    %pytest -k '…'

  to

    %pytest -v

  which is a little bit crazy. I think the -v option is affecting how pytest
  handles the standard I/O descriptors, and the tests are sensitive to the
  difference.

ANSWER: -v command is not able to discover test suite.

5. 
- This doesn’t seem to be needed:

    BuildRequires:  make

ANSWER: Done!
    
6. - A man page is always desired for a command-line tool:

  https://docs.fedoraproject.org/en-US/packaging-guidelines/#_manpages

  You can generate an adequate one by adding:

    BuildRequires:  help2man

  then, in %install:

    install -d '%{buildroot}%{_mandir}/man1'
    env PATH="${PATH}:%{buildroot}%{_bindir}" \
        PYTHONPATH='%{buildroot}%{python3_sitelib}' \
        help2man --no-info '%{pypi_name}' \
            --output='%{buildroot}%{_mandir}/man1/%{pypi_name}.1'

  (doing this in %build could be possible but would be much fussier), then, in
  %files:

     %{_mandir}/man1/%{pypi_name}.1*

ANSWER: Done!

Comment 6 Ankur Sinha (FranciscoD) 2022-05-18 08:12:41 UTC
Thanks. I think that looks good.

Can you please file issues with upstream about the tests and note this issue in the spec?


XXX APPROVED XXX

Comment 7 Iztok Fister Jr. 2022-05-18 08:18:43 UTC
Thank you. 

Yes. I will study all test issues and report to the upstream.

Comment 8 Gwyn Ciesla 2022-05-18 14:00:18 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/cffconvert


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