Merge pull request #383 from twisted/382-async-await-readme

Use async/await in the readme example
twisted · May 1, 2024 · eb301b5 · eb301b5
2 parents ebe8f37 + 27bd085
commit eb301b5
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 26 deletions.
diff --git a/README.rst b/README.rst
@@ -1,10 +1,26 @@
 treq: High-level Twisted HTTP Client API
 ========================================
 
-|pypi|_
-|calver|_
-|coverage|_
-|documentation|_
+.. |pypi| image:: https://img.shields.io/pypi/v/treq.svg
+    :alt: PyPI
+    :target: https://pypi.org/project/treq/
+
+.. |calver| image:: https://img.shields.io/badge/calver-YY.MM.MICRO-22bfda.svg
+    :alt: calver: YY.MM.MICRO
+    :target: https://calver.org/
+
+.. |coverage| image:: https://coveralls.io/repos/github/twisted/treq/badge.svg
+    :alt: Coverage
+    :target: https://coveralls.io/github/twisted/treq
+
+.. |documentation| image:: https://readthedocs.org/projects/treq/badge/
+    :alt: Documentation
+    :target: https://treq.readthedocs.org
+
+|pypi|
+|calver|
+|coverage|
+|documentation|
 
 ``treq`` is an HTTP library inspired by
 `requests <https://requests.readthedocs.io/>`_ but written on top of
@@ -18,15 +34,16 @@ using Twisted.
 
     >>> import treq
 
-    >>> def done(response):
+    >>> async def main(reactor):
+    ...     response = await treq.get("https://github.com")
     ...     print(response.code)
-    ...     reactor.stop()
+    ...     body = await response.text()
+    ...     print("<!DOCTYPE html>" in body)
 
-    >>> treq.get("https://github.com").addCallback(done)
-
-    >>> from twisted.internet import reactor
-    >>> reactor.run()
+    >>> from twisted.internet.task import react
+    >>> react(main)
     200
+    True
 
 For more info `read the docs <https://treq.readthedocs.org>`_.
 
@@ -35,7 +52,7 @@ Contributing
 
 ``treq`` development is hosted on `GitHub <https://github.com/twisted/treq>`_.
 
-We welcome contributions: feel to fork and send contributions over.
+We welcome contributions: feel free to fork and send contributions over.
 See `CONTRIBUTING.rst <https://github.com/twisted/treq/blob/master/CONTRIBUTING.rst>`_ for more info.
 
 Code of Conduct
@@ -50,18 +67,3 @@ Copyright and License
 See `LICENSE <./LICENSE>`_ for legal details and copyright notices.
 
 
-.. _pypi: https://pypi.org/project/treq/
-.. |pypi| image:: https://img.shields.io/pypi/v/treq.svg
-    :alt: PyPI
-
-.. _calver: https://calver.org/
-.. |calver| image:: https://img.shields.io/badge/calver-YY.MM.MICRO-22bfda.svg
-    :alt: calver: YY.MM.MICRO
-
-.. _coverage: https://coveralls.io/github/twisted/treq
-.. |coverage| image:: https://coveralls.io/repos/github/twisted/treq/badge.svg
-    :alt: Coverage
-
-.. _documentation: https://treq.readthedocs.org
-.. |documentation| image:: https://readthedocs.org/projects/treq/badge/
-    :alt: Documentation
diff --git a/changelog.d/382.misc.rst b/changelog.d/382.misc.rst