add async docs

README.md

@@ -31,6 +31,7 @@ Docs are available [here](https://masci.github.io/banks/).
     - [Go meta: create a prompt and `generate` its response](#go-meta-create-a-prompt-and-generate-its-response)
     - [Go meta(meta): process a LLM response](#go-metameta-process-a-llm-response)
     - [Reuse templates from files](#reuse-templates-from-files)
+    - [Async support](#async-support)
   - [License](#license)
 
 ## Installation
@@ -276,6 +277,24 @@ topic = "retrogame computing"
 print(p.text({"topic": topic}))
 ```
 
+### Async support
+
+To run banks within an `asyncio` loop you have to do two things:
+1. set the environment variable `BANKS_ASYNC_ENABLED=true`.
+2. use the `AsyncPrompt` class that has an awaitable `run` method.
+
+Example:
+```python
+from banks import AsyncPrompt
+
+async def main():
+    p = AsyncPrompt.from_template("blog.jinja")
+    result = await p.text({"topic": "AI frameworks"})
+    print(result)
+
+asyncio.run(main())
+```
+
 ## License
 
 `banks` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

docs/async.md

@@ -0,0 +1,17 @@
+## Async support
+
+To run banks within an `asyncio` loop you have to do two things:
+1. set the environment variable `BANKS_ASYNC_ENABLED=true`.
+2. use the `AsyncPrompt` class that has an awaitable `run` method.
+
+Example:
+```python
+from banks import AsyncPrompt
+
+async def main():
+    p = AsyncPrompt.from_template("blog.jinja")
+    result = await p.text({"topic": "AI frameworks"})
+    print(result)
+
+asyncio.run(main())
+```

docs/index.md

@@ -11,9 +11,9 @@ are replaced by actual data provided by the user.
 ## Features
 
 * Banks currently supports all the features from Jinja2, see [Template Designer Documentation](https://jinja.palletsprojects.com/en/3.1.x/templates/#jinja-filters.truncate).
-* [Filters](filters.md): useful to manipulate the text during template rendering.
-* [Extensions](extensions.md): useful to support custom functions (e.g. text generation via OpenAI).
-* [Macros](macros.md): useful to implement complex logic in the template itself instead of Python code.
+* [Filters](prompt.md#filters): useful to manipulate the text during template rendering.
+* [Extensions](prompt.md#extensions): useful to support custom functions (e.g. text generation via OpenAI).
+* [Macros](prompt.md#macros): useful to implement complex logic in the template itself instead of Python code.
 
 ## Installation
 

mkdocs.yml

@@ -10,6 +10,7 @@ nav:
   - Home: 'index.md'
   - Python API: 'python.md'
   - Prompt API: 'prompt.md'
+  - asyncio support: 'async.md'
 
 plugins:
   - search