Skip to content

Commit 3d18d4f

Browse files
committed
Add prominent mention of greenback, README / index.rst
Fixes: #4 Change-Id: Ief6f9bbf5c87947ae645988165ad5dc86d223dbb
1 parent 29803dc commit 3d18d4f

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ directly::
2323

2424
print(asyncio.run(awaitlet.async_def(asyncio_sleep)))
2525

26+
awaitlet is spun out from SQLAlchemy's own `asyncio mediation layer
27+
<https://docs.sqlalchemy.org/en/latest/orm/extensions/asyncio.html>`_, with no
28+
dependencies on SQLAlchemy itself. awaitlet may be compared with another
29+
equivalent library `greenback <https://pypi.org/project/greenback/>`_ which was
30+
released at roughly the same time as SQLAlchemy's asyncio API.
31+
2632
awaitlet is intentionally fully compatible with SQLAlchemy's asyncio mediation
2733
layer, and includes API patterns for:
2834

docs/build/index.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@ Awaitlet is a direct extract of SQLAlchemy's own `asyncio mediation layer
1717
dependencies on SQLAlchemy (but is also fully cross-compatible with
1818
SQLAlchemy's mediation layer). This code has been in widespread production
1919
use in thousands of environments for several years, starting in 2020 with
20-
SQLAlchemy 1.4's first release.
20+
SQLAlchemy 1.4's first release. The library provides for the identical use
21+
case as another library that was first released around the same time as
22+
SQLAlchemy 1.4 called `greenback <https://pypi.org/project/greenback/>`_, but
23+
as part of the SQLAlchemy project is guaranteed to remain cross-compatible with
24+
non-blocking SQLAlchemy code.
2125

2226
awaitlet without any dependency or use of SQLAlchemy includes API patterns for:
2327

0 commit comments

Comments
 (0)