refactor: nest-asyncio2 and Markdown

Author: Chaoses-Ib

.github/FUNDING.yml

@@ -0,0 +1,43 @@
+# nest-asyncio2
+[![Build](https://github.com/Chaoses-Ib/nest-asyncio2/actions/workflows/test.yml/badge.svg?branche=master)](https://github.com/Chaoses-Ib/nest-asyncio2/actions)
+[![status](https://img.shields.io/badge/status-stable-green.svg)]()
+[![PyPi](https://img.shields.io/pypi/v/nest-asyncio2.svg)](https://pypi.python.org/pypi/nest-asyncio2)
+[![License](https://img.shields.io/badge/license-BSD-blue.svg)](LICENSE)
+[![Downloads](https://static.pepy.tech/badge/nest-asyncio2/month)](https://pepy.tech/project/nest-asyncio2)
+
+## Introduction
+
+By design asyncio [does not allow](https://github.com/python/cpython/issues/66435)
+its event loop to be nested. This presents a practical problem:
+When in an environment where the event loop is
+already running it's impossible to run tasks and wait
+for the result. Trying to do so will give the error
+"`RuntimeError: This event loop is already running`".
+
+The issue pops up in various environments, such as web servers,
+GUI applications and in Jupyter notebooks.
+
+This module patches asyncio to allow nested use of `asyncio.run` and
+`loop.run_until_complete`.
+
+## Installation
+
+```sh
+pip3 install nest-asyncio2
+```
+
+Python 3.5 or higher is required.
+
+## Usage
+
+```python
+import nest_asyncio2
+nest_asyncio2.apply()
+```
+
+Optionally the specific loop that needs patching can be given
+as argument to `apply`, otherwise the current event loop is used.
+An event loop can be patched whether it is already running
+or not. Only event loops from asyncio can be patched;
+Loops from other projects, such as uvloop or quamash,
+generally can't be patched.

README.md

@@ -1,15 +1,15 @@
 [metadata]
-name = nest_asyncio
+name = nest-asyncio2
 version = 1.6.0
 author = Ewald R. de Wit
 author_email = [email protected]
 license = BSD
 license_files = LICENSE
 description = Patch asyncio to allow nested event loops
 keywords = asyncio, nested, eventloop
-url = https://github.com/erdewit/nest_asyncio
-long_description = file: README.rst
-long_description_content_type = text/x-rst
+url = https://github.com/Chaoses-Ib/nest-asyncio2
+long_description = file: README.md
+long_description_content_type = text/markdown
 classifiers =
     Development Status :: 5 - Production/Stable
     Intended Audience :: Developers
@@ -26,7 +26,7 @@ classifiers =
     Framework :: AsyncIO
 
 [options]
-py_modules = nest_asyncio
+py_modules = nest_asyncio2
 python_requires = >=3.5
 
 [flake8]

README.rst

@@ -1,16 +1,16 @@
 # /// script
 # requires-python = ">=3.14"
 # dependencies = [
-#     "nest-asyncio",
+#     "nest-asyncio2",
 # ]
 #
 # [tool.uv.sources]
-# nest-asyncio = { path = "../", editable = true }
+# nest-asyncio2 = { path = "../", editable = true }
 # ///
 import asyncio
-import nest_asyncio
+import nest_asyncio2
 
-nest_asyncio.apply()
+nest_asyncio2.apply()
 
 async def f():
     print(asyncio.get_running_loop())

nest_asyncio.py nest_asyncio2.pynest_asyncio.py renamed to nest_asyncio2.py

@@ -1,17 +1,17 @@
 # /// script
 # requires-python = ">=3.14"
 # dependencies = [
-#     "nest-asyncio",
+#     "nest-asyncio2",
 # ]
 #
 # [tool.uv.sources]
-# nest-asyncio = { path = "../", editable = true }
+# nest-asyncio2 = { path = "../", editable = true }
 # ///
 import asyncio
-import nest_asyncio
+import nest_asyncio2
 
 async def f():
-    nest_asyncio.apply()
+    nest_asyncio2.apply()
 
     print(asyncio.get_running_loop())
     assert asyncio.get_running_loop() is not None

setup.cfg

@@ -1,17 +1,17 @@
 # /// script
 # requires-python = ">=3.5"
 # dependencies = [
-#     "nest-asyncio",
+#     "nest-asyncio2",
 # ]
 #
 # [tool.uv.sources]
-# nest-asyncio = { path = "../", editable = true }
+# nest-asyncio2 = { path = "../", editable = true }
 # ///
 import asyncio
 import sys
 import unittest
 
-import nest_asyncio
+import nest_asyncio2
 
 
 def exception_handler(loop, context):
@@ -21,7 +21,7 @@ def exception_handler(loop, context):
 class NestTest(unittest.TestCase):
     def setUp(self):
         self.loop = asyncio.new_event_loop()
-        nest_asyncio.apply(self.loop)
+        nest_asyncio2.apply(self.loop)
         asyncio.set_event_loop(self.loop)
         self.loop.set_debug(True)
         self.loop.set_exception_handler(exception_handler)