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

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

> possible/feasible to name the entry points "docutils-cli.py", "rst2html.py", ...?

Yes, just tested that on linux (Ubuntu) and windows and it works.

> ready for the move to a pyproject.toml?

I certainly think `pyproject.toml` is better if possible -- it is a much nicer format than `.cfg` files! And of course being standards based, it is much easier to change the build backend at a later date (though hopefully that won't be needed!)

https://github.com/AA-Turner/docutils/pull/6 is the flit based version of the tool that doesn't deprecate anything, and uses entrypoints of `rst*.py`.  I also kept the commits much more seperate, so that it is easy to e.g. not include the change that rewrites the tools/ files in terms of `docutils-cli`. 

> too much work

Sunk cost fallacy strikes again :P

> tooling supports both setuptools and flit 

Amazing!

> we should open a new ticket for the command line tool review 

I'll do this later -- the patch above, and the setuptools based patch at https://github.com/AA-Turner/docutils/pull/1 are both now fully backwards compatible in terms of the command-line tools -- the difference is just in build backend. 

A



---

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

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