config docs

docs/config.md

@@ -0,0 +1,37 @@
+## Configuration
+
+Banks can smoothly run with defaults, but you can configure the library by changing the `config` object or by
+setting the correspondent environment variables.
+
+Example usage:
+
+```python
+from banks import config
+
+
+config.ASYNC_ENABLED = True
+```
+
+
+### ASYNC_ENABLED
+
+|                |                         |
+| -------------- | ----------------------- |
+| Type:          | `bool` or truthy string |
+| Default value: | `False`                 |
+| Env var:       | `BANKS_ASYNC_ENABLED`   |
+
+Whether or not to use `asyncio` for template rendering and LLM generation. This setting won't speed up your
+application, only set it to `True` if you need to integrate Banks into an async codebase.
+
+
+### USER_DATA_PATH
+
+|                |                        |
+| -------------- | ---------------------- |
+| Type:          | `Path` or path string  |
+| Default value: | depending on OS        |
+| Env var:       | `BANKS_USER_DATA_PATH` |
+
+A user-writable folder where Banks will store its data. Banks uses a meaningful default for your operating system, so
+change it only if you have to.

docs/index.md

@@ -14,6 +14,7 @@ are replaced by actual data provided by the user.
 * [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.
+* [Configuration](config.md): how to configure the library.
 
 ## Installation
 

src/banks/config.py

@@ -1,13 +1,14 @@
 import os
+from pathlib import Path
 
 from platformdirs import user_data_path
 
 from .utils import strtobool
 
 
 class BanksConfig:
-    ASYNC_ENABLED = strtobool(os.environ.get("BANKS_ASYNC_ENABLED", "false"))
-    USER_DATA_PATH = user_data_path(os.environ.get("BANKS_USER_DATA_PATH", "banks"))
+    ASYNC_ENABLED: bool = strtobool(os.environ.get("BANKS_ASYNC_ENABLED", "false"))
+    USER_DATA_PATH: Path = Path(os.environ.get("BANKS_USER_DATA_PATH", "")) or user_data_path("banks")
 
 
 config = BanksConfig()