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

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

The generic front end is available via `python -m docutils` and `docutils` CLI commands since [r9061].

Updated timeline  suggestion:

- release  0.19
- Decide, which `rst2*` entry points we want to keep (all, the most used, ...). 
- Provide "entry points" for them in `setup.py` (-> command line commands without `.py` extension in Unix, Mac, and Windows).
- Add deprecation notice in RELEASE-NOTES and docs/usr/tools. Change usage examples in the documentation.
-  Announce deprecation of rst2*.py commands at runtime (the deprecation message contains the replacement invocation needed. This may be  a `docutils` command with options or  one of the abovementioned new entry points). The replacement must be implementd at the time we start to nag users.
- release 1.1
- In the 2.0 development branch: Cease installing rst2*.py tools in the PATH, allows switch to `flit` and `*.toml` config file.
- Eventually provide a separate "docutils-cli" package which may include moving the generic `docutils` front-end tool there and/or providing the special tools as `rst2*` or`rst2*.py`.
- release 2.0 with modern packaging.


---

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

**Status:** open
**Group:** None
**Created:** Fri Dec 31, 2021 03:16 AM UTC by Adam  Turner
**Last Updated:** Mon May 30, 2022 02:25 PM 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.