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

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

> who might get in trouble if setup.py and install.py is missing

`install.py` is noted in the docs as just a hack for windows -- I'm writing this on a windows PC & have done all my testing on one, so no issues there!

As noted in Paul Ganssle's blog[1], `python -m build` is the recommended method for the future. Distribution packagers are working to these standards now -- for example `typing_extensions`has had ~100mm downloads in the last month, and uses `flit`, as I'm proposing here. (`python-rsa` is another such example also at around 100mm per month).

The maintainers of `setuptools` (see the blog post) have indicated that they want to (intend to) deprecate usage of `setup.py install`, `setup.py build`, et cetera. I updated all the user documentation to make it clear how to build and install Docutils in the proposed build system, which hopefully eases the transition.

A

[1] https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html#summary 


---

** [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 12:30 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.