Bug#990235: RFS: python-pylatexenc/2.10-1 [ITP] -- Simple LaTeX parser providing conversion to/from unicode

[Diego M. Rodriguez]

Package: sponsorship-requests
Severity: wishlist

Dear mentors,

I am looking for a sponsor for my package "python-pylatexenc":

* Package name : python-pylatexenc
Version : 2.10-1
Upstream Author : Philippe Faist <philipp...@bluewin.ch>
* URL : https://github.com/phfaist/pylatexenc
* License : Expat, Expat and W3C, W3C
* Vcs :
https://salsa.debian.org/python-team/packages/python-pylatexenc
Section : python

For context, the issues that I most struggled with were:
1. declaring the d/copyright correctly: hopefully this is addressed
thanks to the help of the helpful folks of the debian-legal list [1],
which involved switching to using GitHub releases as upstream and
incorporating their suggestions.
2. including manpages for the 3 executables (as setup.py
console_scripts)in the package: initially I attempted to generate them
dynamically at build time, but I switched to using a custom target as
recommended in [2]. As a side effect of 1, I was able to include a
documentation package (rendered from sphinx sources) - I'm unsure if
rendering the full documentation as a manpage would be preferred over
having individual help2man-generated entries.

Any help and further review is more than welcome - the package is
maintained at salsa [3].

It builds those binary packages:

python3-pylatexenc - Simple LaTeX parser providing conversion to/from
unicode
python-pylatexenc-doc - Simple LaTeX parser providing conversion
to/from unicode (Documentation)

To access further information about this package, please visit the
following URL:

https://mentors.debian.net/package/python-pylatexenc/

Alternatively, one can download the package with dget using this command:

dget -x
https://mentors.debian.net/debian/pool/main/p/python-pylatexenc/python-pylatexenc_2.10-1.dsc

Changes for the initial release:

python-pylatexenc (2.10-1) UNRELEASED; urgency=medium
.
[ Diego M. Rodriguez ]
* Initial release (Closes: #950664)
.
[ Ondřej Nový ]
* d/control: Update Maintainer field with new Debian Python Team
contact address
* d/control: Update Vcs-* fields with new Debian Python Team Salsa
layout

Regards,

[1] https://lists.debian.org/debian-legal/2021/06/msg00006.html
[2] https://wiki.debian.org/ManualPage/help2man
[3] https://salsa.debian.org/python-team/packages/python-pylatexenc
--
Diego M. Rodriguez

[Jeroen Ploemen]

Control: tags -1 moreinfo

On Wed, 23 Jun 2021 18:05:05 +0200
"Diego M. Rodriguez" <di...@moreda.io> wrote:

> Package: sponsorship-requests
> Severity: wishlist
>
> Dear mentors,
>
> I am looking for a sponsor for my package "python-pylatexenc":

Hi Diego,

this package looks quite nice overall, and I like that you've put the
salsa CI features to good use too. Couple of questions and (mostly easily
fixable) issues though:

* The lintian hits on the binary pkg deserve an override:
X: python3-pylatexenc: application-in-library-section python usr/bin/latexwalker usr/bin/latexencode usr/bin/latex2text
X: python3-pylatexenc: library-package-name-for-application usr/bin/latexwalker usr/bin/latexencode usr/bin/latex2text

* Changelog: just the 'Initial release' line closing the ITP bug will do
for a new package. That will probably also stop mentors from
complaining about "Package closes bugs in a wrong way".

* Control: why the old compat level 12?

* Copyright: I did initially have my doubts about _uni2latexmap_xml.py
being subject to both Expat and W3C, but looking at -legal you did your
homework there and came to a reasonable conclusion.
* Copyright: there's no mention of any copyright later than 2019 held by
Philippe Faist, yet grepping the upstream sources shows entries as
recent as 2021 for that person.

* Rules: what is the override of dh_auto_clean trying to achieve?
* Rules: the help2man target seems to require an installed package in
order to succeed. Any way to make this work with just the extracted
source package? If not, a comment documenting the requirement would be
useful.

* Tests: please add non-trivial autopkgtests, based on the upstream
testsuite. Be sure to copy the tests out of the source dir and to loop
over all supported python3 versions; there's plenty of packages on the
python team repo that can serve as examples, including [1].


Please remove the moreinfo tag (and CC me directly) once you have an
updated package ready.


[1] https://salsa.debian.org/python-team/packages/puremagic/-/tree/master/debian/tests

[Diego M. Rodriguez]

Control: tags 990235 - moreinfo

Hello Jeroen,

thanks for the review and detailed reply:

On Fri, Aug 27, 2021, at 12:59, Jeroen Ploemen wrote:
> * The lintian hits on the binary pkg deserve an override:

Added two overrides - they are more vague than I would have liked, as it seems that the order in which the offending files are displayed in the warnings is not deterministic. The other alternative seemed to be adding 3x2 individual ones, but resulted in "mismatched-override" warnings.

> * Changelog: just the 'Initial release' line closing the ITP bug will do
> for a new package.

Fixed the changelog, leaving the "Initial release" line.

> * Control: why the old compat level 12?

Likely it was the one I added when starting packaging a long time ago - bumped to 13.

> * Copyright: there's no mention of any copyright later than 2019 held by
> Philippe Faist, yet grepping the upstream sources shows entries as
> recent as 2021 for that person.

Thanks for catching these as well. I added explicit lines to d/copyright for the files that declare a copyright year different than the one declared in LICENSE.txt.

> * Rules: what is the override of dh_auto_clean trying to achieve?

Helping me clean up the package locally in previous iterations :) Removed, as indeed it was a leftover.

> * Rules: the help2man target seems to require an installed package in
> order to succeed. Any way to make this work with just the extracted
> source package? If not, a comment documenting the requirement would be
> useful.

I could not find a sensible way to make it work - updated the comment in d/rules in the hopes of making it more explicit.

> * Tests: please add non-trivial autopkgtests, based on the upstream
> testsuite.

Added, thanks again for the example.

> Please remove the moreinfo tag (and CC me directly) once you have an
> updated package ready.

Ditto - hopefully the latest version in salsa is ready for a new review.

Best,
---
Diego M. Rodriguez