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

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

My suggested timeline regarding the front-end tools is:

- Get a clear picture of intended changes and their consequences (good and bad).
- Wait for developer consensus.
- Implement non intrusive, backwards compatible changes.
- Announce upcoming changes. 
- release  0.19
- Add entrypoint for `docutils-cli` (maybe called `docutils`).
- Retain `*.py` files in tools/ and keep providing them under the established name in the PATH (either copying or via entry-points).
- Add deprecation notice in RELEASE-NOTES and docs/usr/tools. Change usage examples in the documentation.
- release 1.0
-  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 more specific helpers from a new "docutils-cli" package). The replacement invocation must be fixed and implementd at the time we start to nag users.
- release 1.1
- Cease installing rst2*.py tools in the PATH
- 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 1.2


---

** [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 11:34 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.