Skip to content

Commit 0ce8e18

Browse files
authored
doc: move async guidance for ToolboxClient higher up in README (#139)
1 parent 839ed94 commit 0ce8e18

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

packages/toolbox-core/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,16 @@ involving Large Language Models (LLMs).
5151
pip install toolbox-core
5252
```
5353

54+
> [!NOTE]
55+
> * The primary `ToolboxClient` is asynchronous and requires using `await` for
56+
> loading and invoking tools, as shown in most examples.
57+
> * Asynchronous code needs to run within an event loop (e.g., using
58+
> `asyncio.run()` or in an async framework). See the [Python `asyncio`
59+
> documentation](https://docs.python.org/3/library/asyncio-task.html) for more
60+
> details.
61+
> * If you prefer synchronous execution, refer to the [Synchronous
62+
> Usage](#synchronous-usage) section below.
63+
5464
## Quickstart
5565

5666
Here's a minimal example to get you started. Ensure your Toolbox service is
@@ -84,16 +94,6 @@ toolbox = ToolboxClient("http://127.0.0.1:5000")
8494

8595
All interactions for loading and invoking tools happen through this client.
8696

87-
> [!NOTE]
88-
> * The primary `ToolboxClient` is asynchronous and requires using `await` for
89-
> loading and invoking tools, as shown in most examples.
90-
> * Asynchronous code needs to run within an event loop (e.g., using
91-
> `asyncio.run()` or in an async framework). See the [Python `asyncio`
92-
> documentation](https://docs.python.org/3/library/asyncio-task.html) for more
93-
> details.
94-
> * If you prefer synchronous execution, refer to the [Synchronous
95-
> Usage](#synchronous-usage) section below.
96-
9797
## Loading Tools
9898

9999
You can load tools individually or in groups (toolsets) as defined in your

0 commit comments

Comments
 (0)