[Docutils-develop] [docutils:patches] Re: #186 Modernise packaging

[Günter M. <mi...@us...>]

On 2022-01-04, Adam Turner via Docutils-develop wrote:

> Most usage of Docutils today is programmatic, and not via the command
> line tools ...

It should not come as a surprise that projects on PyPi prefer
programmatic use over command line tools.
OTOH, we will not easily find out how many end-users and non-Python
projects use the front-end tools in a Makefile or custom script to
generate documentation in HTML, PDF, or trof (man page) formats
and will be affected by a name change.

As a recent addition, `docutils-cli.py` may less used
and hence a change there may cause less disruption.
Maybe adding a `docutils-cli` or `docutils` "entry point"
for the benefit of Windows users could become a separate feature request.


---

** [patches:#186] Modernise packaging**

**Status:** open
**Group:** None
**Created:** Fri Dec 31, 2021 03:16 AM UTC by Adam  Turner
**Last Updated:** Tue Jan 04, 2022 03:12 AM UTC
**Owner:** nobody
**Attachments:**

- [0001-Use-flit-and-pyproject.toml.patch](https://sourceforge.net/p/docutils/patches/186/attachment/0001-Use-flit-and-pyproject.toml.patch) (12.2 kB; application/octet-stream)
- [0002-Use-entry-points.patch](https://sourceforge.net/p/docutils/patches/186/attachment/0002-Use-entry-points.patch) (20.7 kB; application/octet-stream)
- [0003-update-docs-etc-after-packaging-changes.patch](https://sourceforge.net/p/docutils/patches/186/attachment/0003-update-docs-etc-after-packaging-changes.patch) (49.3 kB; application/octet-stream)


Hi,

I had a go at modernising the packaging stack. `setup.py` based invocations have been deprecated (https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html), and setuptools may remove them in the future. 

This takes the opportunity to move to a PEP 621 based declarative config, and also fixes a longstanding TODO item about providing script wappers for the frontend tools on windows, by migrating them to entry points.

I've updated install and development docs with the new guidance, and updated references to the frontend tools to remove `.py`, given they are now installed as proper scripts.

Hope this is appreciated -- happy to make revisions etc to help getting this merged.

A


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.