Metadata-Version: 2.4
Name: gaard-api
Version: 0.1.2
Summary: GAARD backend web services providing admin interface
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: gaard-core==0.1.0
Requires-Dist: gaard-connectors==0.1.1
Requires-Dist: gaard-llm==0.1.0
Requires-Dist: gaard-plugin-api<0.2.0,>=0.1.0
Requires-Dist: fastapi>=0.111.0
Requires-Dist: uvicorn[standard]>=0.30.0
Requires-Dist: pydantic>=2.7.0
Requires-Dist: sqlalchemy>=2.0.0
Requires-Dist: httpx>=0.27.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0.0; extra == "dev"
Requires-Dist: ruff>=0.5.0; extra == "dev"
Requires-Dist: mypy>=1.10.0; extra == "dev"
Requires-Dist: psycopg[binary]>=3.2.0; extra == "dev"
Requires-Dist: pymysql>=1.2.0; extra == "dev"

# GAARD - Governed AI Access to Relational Data

GAARD is a self-hosted AI SQL Gateway for governed natural-language access to relational data.

GAARD allows applications and users to ask questions about relational databases using natural language while keeping SQL generation, validation, execution, prompts, connectors, and auditability under control.

For more informacion see https://github.com/pkroliszewski/gaard

# This package

`gaard-api` provides the GAARD FastAPI backend and bundled admin application.

After installation, start it with:

```bash
gaard-core install-example-database
gaard-core start
```

`gaard-core install-example-database` creates the bundled Medical POC SQLite
database at `examples/medical-poc/demo.db` in the current working directory,
registers it as the active `default` datasource in `metadata.db`, and matches
the default datasource URL. Use
`gaard-core install-example-database --output /path/to/demo.db` to place it
elsewhere; the command prints the SQLite datasource URL saved in metadata.

`gaard-core start` accepts `--host`, `--port`, and `--reload`. By default the
API is available at `http://localhost:8000` and the admin application at
`http://localhost:8000/admin`.

`gaard-api start` is an alias. `gaard admin` remains available for compatibility.
