Metadata-Version: 2.4
Name: open-agent-docs-server
Version: 0.3.1
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: 3
Requires-Dist: pytest>=8 ; extra == 'test'
Requires-Dist: httpx>=0.27 ; extra == 'test'
Provides-Extra: test
Summary: Open Agent Docs server (Rust, PyO3) that runs inside a Python process. Normally installed via pip install "open-agent-docs[server]" and used through open_agent_docs.start()
License: MIT OR Apache-2.0
Requires-Python: >=3.9
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Homepage, https://github.com/kadaliao/open-agent-docs
Project-URL: Source, https://github.com/kadaliao/open-agent-docs/tree/main/crates/oad-py
Project-URL: 简体中文 (Chinese), https://github.com/kadaliao/open-agent-docs/blob/main/crates/oad-py/README.zh-CN.md

# open-agent-docs-server

English | [简体中文](https://github.com/kadaliao/open-agent-docs/blob/main/crates/oad-py/README.zh-CN.md)

The [Open Agent Docs](https://github.com/kadaliao/open-agent-docs) server (Rust, PyO3) as a Python extension module: it runs inside your Python process, on its own threads, without holding the GIL.

You normally don't use this package directly. Install the SDK with the `server` extra, and `oad.start()` finds it and runs the server in-process instead of downloading a binary:

```sh
pip install "open-agent-docs[server]"
```

```python
import open_agent_docs as oad

with oad.start(data_dir="./data", auth="none") as server:
    client = oad.Client(base_url=server.url)
    ...
```

Using it directly takes the same arguments:

```python
import open_agent_docs_server

with open_agent_docs_server.start(data_dir="./data", auth="none") as server:
    print(server.url)   # http://127.0.0.1:<port>
```

Wheels are built for macOS 11+ (arm64, x86_64) and Linux (x86_64, aarch64, glibc 2.34+: Ubuntu 22.04+, Debian 12+, RHEL 9+). On older systems and on Windows, run the server with Docker instead;
see the [system requirements](https://github.com/kadaliao/open-agent-docs/blob/main/docs/en/quickstart.md#system-requirements).

- [Python SDK](https://pypi.org/project/open-agent-docs/) ([简体中文](https://github.com/kadaliao/open-agent-docs/blob/main/sdks/python/README.zh-CN.md))
- [Configuration](https://github.com/kadaliao/open-agent-docs/blob/main/docs/en/configuration.md) ([简体中文](https://github.com/kadaliao/open-agent-docs/blob/main/docs/zh/configuration.md))

