PyPI package.

Author: excitoon

.gitignore

@@ -1 +1,3 @@
+/dist/
+/django_threaded_sync_to_async.egg-info/
 __pycache__/

README.md

@@ -1,12 +1,16 @@
 ## `django_threaded_sync_to_async`
 
-FIXME add description
+Tools for replacing `sync_to_async` calls to `sync_to_async(thread_sensitive=None, executor=...)`, effectively allowing Django to make calls to database concurrently.
 
-### `Executor`
+```
+pip3 install django_threaded_sync_to_async
+```
 
-Under executor context, `Executor` replaces `sync_to_async` calls to `sync_to_async(thread_sensitive=None, executor=...)`, effectively allowing Django to make calls to database concurrently:
+### `Executor`
 
 ```python3
+import django_threaded_sync_to_async
+
 async with django_threaded_sync_to_async.Executor(thread_name_prefix="thread", max_workers=3) as executor:
     a = asgiref.sync.sync_to_async(long_call)(1)
     b = asgiref.sync.sync_to_async(long_call)(2)
@@ -20,6 +24,8 @@ async with django_threaded_sync_to_async.Executor(thread_name_prefix="thread", m
 Maintains global dictionary of executors (`concurrent.futures.ThreadPoolExecutor`) accessed by name and allows to limit utilization of executor for a single context.
 
 ```python3
+import django_threaded_sync_to_async
+
 @django_threaded_sync_to_async.SharedExecutor("common", max_workers=3, max_tasks=2)
 def operations():
     a = asgiref.sync.sync_to_async(long_call)(1)