From 439c5630ba3f3b084445dd7a1be06bc04d9f9f3b Mon Sep 17 00:00:00 2001 From: Thomas Grainger Date: Sun, 5 Nov 2023 09:51:28 +0000 Subject: [PATCH] use the regular readme for the long description --- LONG_DESCRIPTION.rst | 65 ------------------------------------- MANIFEST.in | 1 - newsfragments/2866.misc.rst | 1 + pyproject.toml | 2 +- 4 files changed, 2 insertions(+), 67 deletions(-) delete mode 100644 LONG_DESCRIPTION.rst create mode 100644 newsfragments/2866.misc.rst diff --git a/LONG_DESCRIPTION.rst b/LONG_DESCRIPTION.rst deleted file mode 100644 index b0cfb99fbc..0000000000 --- a/LONG_DESCRIPTION.rst +++ /dev/null @@ -1,65 +0,0 @@ -.. image:: https://raw.githubusercontent.com/python-trio/trio/9b0bec646a31e0d0f67b8b6ecc6939726faf3e17/logo/logo-with-background.svg - :width: 200px - :align: right - -The Trio project's goal is to produce a production-quality, `permissively -licensed `__, -async/await-native I/O library for Python. Like all async libraries, -its main purpose is to help you write programs that do **multiple -things at the same time** with **parallelized I/O**. A web spider that -wants to fetch lots of pages in parallel, a web server that needs to -juggle lots of downloads and websocket connections at the same time, a -process supervisor monitoring multiple subprocesses... that sort of -thing. Compared to other libraries, Trio attempts to distinguish -itself with an obsessive focus on **usability** and -**correctness**. Concurrency is complicated; we try to make it *easy* -to get things *right*. - -Trio was built from the ground up to take advantage of the `latest -Python features `__, and -draws inspiration from `many sources -`__, in -particular Dave Beazley's `Curio `__. -The resulting design is radically simpler than older competitors like -`asyncio `__ and -`Twisted `__, yet just as capable. Trio is -the Python I/O library I always wanted; I find it makes building -I/O-oriented programs easier, less error-prone, and just plain more -fun. `Perhaps you'll find the same -`__. - -This project is young and still somewhat experimental: the overall -design is solid and the existing features are fully tested and -documented, but you may encounter missing functionality or rough -edges. We *do* encourage you do use it, but you should `read and -subscribe to issue #1 -`__ to get warning and a -chance to give feedback about any compatibility-breaking changes. - -Vital statistics: - -* Supported environments: Linux, macOS, or Windows running some kind of Python - 3.8-or-better (either CPython or PyPy3 is fine). \*BSD and illumos likely - work too, but are not tested. - -* Install: ``python3 -m pip install -U trio`` (or on Windows, maybe - ``py -3 -m pip install -U trio``). No compiler needed. - -* Tutorial and reference manual: https://trio.readthedocs.io - -* Changelog: https://trio.readthedocs.io/en/latest/history.html - -* Bug tracker and source code: https://github.com/python-trio/trio - -* Real-time chat: https://gitter.im/python-trio/general - -* Discussion forum: https://trio.discourse.group - -* License: MIT or Apache 2, your choice - -* Contributor guide: https://trio.readthedocs.io/en/latest/contributing.html - -* Code of conduct: Contributors are requested to follow our `code of - conduct - `_ - in all project spaces. diff --git a/MANIFEST.in b/MANIFEST.in index 79e7891339..eb9c0173da 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,5 @@ include LICENSE LICENSE.MIT LICENSE.APACHE2 include README.rst -include LONG_DESCRIPTION.rst include CODE_OF_CONDUCT.md CONTRIBUTING.md include test-requirements.txt include trio/py.typed diff --git a/newsfragments/2866.misc.rst b/newsfragments/2866.misc.rst new file mode 100644 index 0000000000..606f9ad15e --- /dev/null +++ b/newsfragments/2866.misc.rst @@ -0,0 +1 @@ +use the regular readme for the PyPI long_description diff --git a/pyproject.toml b/pyproject.toml index 5aee42b68a..ad60fc1350 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -52,7 +52,7 @@ dependencies = [ dynamic = ["version"] [project.readme] -file = "LONG_DESCRIPTION.rst" +file = "README.rst" content-type = "text/x-rst" [project.urls]