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

[Adam T. <aa-...@us...>]

(I can't find any way to update my patches/edit the message above similar to how one would on a pull request in GitHub or similar, so apologies for posting an entirely new message.)

I've updated the patch into what I think is a cleaner implementation, somewhat segregated into three parts.

Patches 1 and 2 now set up the minimum for a standards compliant packaging solution, and solve the issue of automatically creating executables on both unix and windows through `entry points`.

Patches 3 and 4 move the `rst*` frontends into the new `entry points` based setup (in the new `_cli` module, and update documentation to reflect both that the frontends should no longer be called with `.py`, and that the commands for building/installing Docutils have changed.

Patches 5 and 6 subsequentley deprecate the `rst*` based frontends (printing a message to the console on invocation noting what the user should run instead) and update documentation to prefer `docutils-cli` throughout as the canonical front-end tool. 

I have intentionally kept 3/4 and 5/6 distinct, as I am not sure of your opinions on deprecating the other front-end tools.

As before, all tests pass & all commands etc are usable.

(Please let me know if there's anything else that would be useful to help on -- I proposed a patch for FR#61, but I don't know what your priorities are as maintainers. Thanks!)

A


Attachments:

- [0001-Use-flit-and-pyproject.toml.patch](https://sourceforge.net/p/docutils/patches/_discuss/thread/e3c9702768/5b45/attachment/0001-Use-flit-and-pyproject.toml.patch) (11.7 kB; application/octet-stream)
- [0002-Add-docutils-cli-entry-point.patch](https://sourceforge.net/p/docutils/patches/_discuss/thread/e3c9702768/5b45/attachment/0002-Add-docutils-cli-entry-point.patch) (6.8 kB; application/octet-stream)
- [0003-Use-entry-points-for-rst-tools.patch](https://sourceforge.net/p/docutils/patches/_discuss/thread/e3c9702768/5b45/attachment/0003-Use-entry-points-for-rst-tools.patch) (24.2 kB; application/octet-stream)
- [0004-Update-docs-for-packaging-changes.patch](https://sourceforge.net/p/docutils/patches/_discuss/thread/e3c9702768/5b45/attachment/0004-Update-docs-for-packaging-changes.patch) (53.1 kB; application/octet-stream)
- [0005-Deprecate-rst-entry-points-in-favour-of-docutils-cli.patch](https://sourceforge.net/p/docutils/patches/_discuss/thread/e3c9702768/5b45/attachment/0005-Deprecate-rst-entry-points-in-favour-of-docutils-cli.patch) (4.2 kB; application/octet-stream)
- [0006-Update-documentation-to-focus-on-docutils-cli.patch](https://sourceforge.net/p/docutils/patches/_discuss/thread/e3c9702768/5b45/attachment/0006-Update-documentation-to-focus-on-docutils-cli.patch) (26.1 kB; application/octet-stream)


---

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

**Status:** open
**Group:** None
**Created:** Fri Dec 31, 2021 03:16 AM UTC by Adam  Turner
**Last Updated:** Sat Jan 01, 2022 03:45 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.