Bug 2208353 - Review Request: python-unicode-slugify - Slug generator that turns strings into unicode slugs [NEEDINFO]
Summary: Review Request: python-unicode-slugify - Slug generator that turns strings in...
Keywords:
Status: NEW
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Nobody's working on this, feel free to take it
QA Contact: Fedora Extras Quality Assurance
URL: http://github.com/mozilla/unicode-slu...
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-05-18 17:11 UTC by Davide Cavalca
Modified: 2025-06-18 00:45 UTC (History)
4 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed:
Type: ---
Embargoed:
package-review: needinfo? (davide)


Attachments (Terms of Use)

Description Davide Cavalca 2023-05-18 17:11:16 UTC
Spec URL: https://dcavalca.fedorapeople.org/review/python-unicode-slugify/python-unicode-slugify.spec
SRPM URL: https://dcavalca.fedorapeople.org/review/python-unicode-slugify/python-unicode-slugify-0.1.5-1.fc39.src.rpm

Description:
Unicode Slugify is a slugifier that generates unicode slugs. It was originally
used in the Firefox Add-ons web site to generate slugs for add-ons and add-on
collections. Many of these add-ons and collections had unicode characters and
required more than simple transliteration.

Fedora Account System Username: dcavalca

Comment 1 Davide Cavalca 2023-05-18 17:11:18 UTC
This package built on koji:  https://koji.fedoraproject.org/koji/taskinfo?taskID=101293601

Comment 2 Fedora Review Service 2023-05-18 17:18:19 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/5932719
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2208353-python-unicode-slugify/fedora-rawhide-x86_64/05932719-python-unicode-slugify/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 3 Package Review 2024-05-18 00:45:31 UTC
This is an automatic check from review-stats script.

This review request ticket hasn't been updated for some time. We're sorry
it is taking so long. If you're still interested in packaging this software
into Fedora repositories, please respond to this comment clearing the
NEEDINFO flag.

You may want to update the specfile and the src.rpm to the latest version
available and to propose a review swap on Fedora devel mailing list to increase
chances to have your package reviewed. If this is your first package and you
need a sponsor, you may want to post some informal reviews. Read more at
https://fedoraproject.org/wiki/How_to_get_sponsored_into_the_packager_group.

Without any reply, this request will shortly be considered abandoned
and will be closed.
Thank you for your patience.

Comment 5 Fedora Review Service 2024-05-19 03:07:35 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/7460301
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2208353-python-unicode-slugify/fedora-rawhide-x86_64/07460301-python-unicode-slugify/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 6 Adam McCartney 2024-06-08 09:12:59 UTC
Please note that this is a non-binding review.

Summary:
- License needs clarification, ambiguity with between spec file and upstream.
  See comment below.

- It's not clear what is being packaged. The package depends on python3-slugify
  but does not specify this as a dependency in the spec file. See the Provides and Requires
  section of the python packaging guidelines: https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_provides_and_requirements

- The upstream sources for the package seem to only contain a test suite that uses a
  dependecy to carry out checks. If this is the case, then it is perhaps better
  to simply include the tests with the upstream package for python3-slugify.




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

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



===== MUST items =====

Generic:
[ ]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
     The license is open-source compatible, the reason for missing this check
     is that there is ambiguity about specific license being used. 
     It looks like the license in the upstream `setup.py` is 'BSD', this
     should match the version in the spec file.
     SPDX short identifier: BSD-3-Clause
[ ]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "BSD 3-Clause License", "Unknown or generated". 13 files have
     unknown license. Detailed output of licensecheck in
     /home/amccartn/fedora/reviews/2208353-python-unicode-
     slugify/licensecheck.txt
[ ]: Package does not own files or directories owned by other packages.
     Note: Dirs in package are owned also by: /usr/lib/python3.12/site-
     packages/slugify(python3-slugify), /usr/lib/python3.12/site-
     packages/slugify/__pycache__(python3-slugify)
[ ]: Package contains no bundled libraries without FPC exception.
[ ]: Changelog in prescribed format.
[ ]: 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
[ ]: Package uses nothing in %doc for runtime.
[ ]: Package consistently uses macros (instead of hard-coded directory
     names).
[ ]: Package is named according to the Package Naming Guidelines.
[ ]: Package does not generate any conflict.
[ ]: 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.
[ ]: Spec file is legible and written in American English.
[ ]: Package contains systemd file(s) if in need.
[ ]: 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 requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[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 1381 bytes in 1 files.
[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.
[ ]: Final provides and requires are sane (see attachments).
[ ]: Package functions as described.
[ ]: Latest version is packaged.
[ ]: 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.
[ ]: 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-unicode-slugify-0.1.5-1.fc41.noarch.rpm
          python-unicode-slugify-0.1.5-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/tmpi0v_m2z0')]
checks: 32, packages: 2

python-unicode-slugify.src: E: spelling-error ('slugifier', '%description -l en_US slugifier -> emulsifier')
python-unicode-slugify.src: E: spelling-error ('ons', '%description -l en_US ons -> nos, ins, obs')
python3-unicode-slugify.noarch: E: spelling-error ('slugifier', '%description -l en_US slugifier -> emulsifier')
python3-unicode-slugify.noarch: E: spelling-error ('ons', '%description -l en_US ons -> nos, ins, obs')
 2 packages and 0 specfiles checked; 4 errors, 0 warnings, 9 filtered, 4 badness; has taken 0.4 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-unicode-slugify.noarch: E: spelling-error ('slugifier', '%description -l en_US slugifier -> emulsifier')
python3-unicode-slugify.noarch: E: spelling-error ('ons', '%description -l en_US ons -> nos, ins, obs')
 1 packages and 0 specfiles checked; 2 errors, 0 warnings, 5 filtered, 2 badness; has taken 0.1 s 



Source checksums
----------------
https://files.pythonhosted.org/packages/source/u/unicode-slugify/unicode-slugify-0.1.5.tar.gz :
  CHECKSUM(SHA256) this package     : 25f424258317e4cb41093e2953374b3af1f23097297664731cdb3ae46f6bd6c3
  CHECKSUM(SHA256) upstream package : 25f424258317e4cb41093e2953374b3af1f23097297664731cdb3ae46f6bd6c3


Requires
--------
python3-unicode-slugify (rpmlib, GLIBC filtered):
    python(abi)
    python3.12dist(six)
    python3.12dist(unidecode)



Provides
--------
python3-unicode-slugify:
    python-unicode-slugify
    python3-unicode-slugify
    python3.12-unicode-slugify
    python3.12dist(unicode-slugify)
    python3dist(unicode-slugify)



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

Comment 7 Cristian Le 2024-06-17 13:14:55 UTC
> License needs clarification, ambiguity with between spec file and upstream.

If I understand correctly you are referring to the pypi showing BSD and spec BSD-3-clause. Comparing BSD-3-clause [1] with LICENSE, it seems the latter is correct. But please make a patch to fix the metadata.

But unicode projects seem to very tricky w.r.t. licensing. Afaics, it doesn't use any unicode licensed data, so it should be fine with the current license metadata. The "Unknown or generated" part should be fine since if you look at the whole project, there isn't much there.

> It's not clear what is being packaged. The package depends on python3-slugify

Actually it doesn't, but it should be marked as `Conflicts`/`Obsoletes` since python3-slugify is effectively dead. Here are some affected packages:
```console
$ fedrq wr --branch=rawhide python3-slugify
python-agate-1.11.0-1.fc41.src
python-cookiecutter-2.6.0-2.fc41.src
python-django-uuslug-2.0.0-9.fc41.src
python3-agate-1.11.0-1.fc41.noarch
python3-cookiecutter-2.6.0-2.fc41.noarch
python3-django-uuslug-2.0.0-9.fc41.noarch
transifex-client-0.13.7-15.fc41.noarch
transifex-client-0.13.7-15.fc41.src
```

> The upstream sources for the package seem to only contain a test suite

It also includes `__init__.py` which I think is what's meant to be the main thing packaged. As for having `tests` inside the main package, that is a rather common pattern, even though I personally don't like it.

From my side:
- would you consider adding the patch: https://github.com/mozilla/unicode-slugify/pull/41
- could you bug upstream to add appropriate tags/releases when they make a pypi release. If they need, they can copy one of my github workflows [2] (although they can simplify the `release.yaml` by adding `pipx run build` instead of calling the other workflows)

[1]: https://opensource.org/license/bsd-3-clause
[2]: https://github.com/click-contrib/click-option-group/tree/master/.github/workflows

Comment 8 Fabio Valentini 2024-06-17 14:33:51 UTC
From what I can tell, the tests aren't even run. It looks like "tox" doesn't find them.
If they *were* run, they would probably fail, because they use "nose", which is not pulled in as a dependency.

> it should be marked as `Conflicts`/`Obsoletes` since python3-slugify is effectively dead

In that case, the package should probably use the %py_provides macro to generate the correct Provides.

Note that this project doesn't look so alive either, the last upstream commit was three years ago.

==========

>Please note that this is a non-binding review.

Some notes on the issues from the future sponsor:

>Summary:
>- License needs clarification, ambiguity with between spec file and upstream.
>  See comment below.

I agree with Cristian, this should be OK. The included license file matches the BSD-3-Clause license.

>- It's not clear what is being packaged. The package depends on python3-slugify
>  but does not specify this as a dependency in the spec file. See the Provides and Requires
>  section of the python packaging guidelines: https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_provides_and_requirements

It looks like this is a replacement for the "slugify" Python package (and it doesn't depend on it).
But if it *is* a replacement, it needs to be handled as such (see Conflicts / Obsoletes / Provides mentioned above).

>- The upstream sources for the package seem to only contain a test suite that uses a
>  dependecy to carry out checks. If this is the case, then it is perhaps better
>  to simply include the tests with the upstream package for python3-slugify.

It looks like __init__.py contains the actual code.
It's a bit unusual, but not wrong.

Comment 9 Package Review 2025-06-18 00:45:24 UTC
This is an automatic check from review-stats script.

This review request ticket hasn't been updated for some time. We're sorry
it is taking so long. If you're still interested in packaging this software
into Fedora repositories, please respond to this comment clearing the
NEEDINFO flag.

You may want to update the specfile and the src.rpm to the latest version
available and to propose a review swap on Fedora devel mailing list to increase
chances to have your package reviewed. If this is your first package and you
need a sponsor, you may want to post some informal reviews. Read more at
https://fedoraproject.org/wiki/How_to_get_sponsored_into_the_packager_group.

Without any reply, this request will shortly be considered abandoned
and will be closed.
Thank you for your patience.


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