gaard-client 0.1.0__tar.gz

gaard_client-0.1.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: gaard-client
+Version: 0.1.0
+Summary: GAARD frontend web services providing client interface
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi>=0.111.0
+Requires-Dist: uvicorn[standard]>=0.30.0
+Requires-Dist: pydantic>=2.7.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"
+
+# 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-client` provides the community web client for `gaard-api`.
+
+After installation, start it with:
+
+```bash
+gaard-client start
+```
+
+The command accepts `--host`, `--port`, and `--reload`. By default the client is
+available at `http://localhost:8001?backendUrl=http://localhost:8000`.
+
+The older `gaard client` command remains available for compatibility.

gaard_client-0.1.0/README.md

@@ -0,0 +1,22 @@
+# 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-client` provides the community web client for `gaard-api`.
+
+After installation, start it with:
+
+```bash
+gaard-client start
+```
+
+The command accepts `--host`, `--port`, and `--reload`. By default the client is
+available at `http://localhost:8001?backendUrl=http://localhost:8000`.
+
+The older `gaard client` command remains available for compatibility.

gaard_client-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gaard-client"
+version = "0.1.0"
+description = "GAARD frontend web services providing client interface"
+readme = "README.md"
+requires-python = ">=3.11"
+
+dependencies = [
+    "fastapi>=0.111.0",
+    "uvicorn[standard]>=0.30.0",
+    "pydantic>=2.7.0",
+    "httpx>=0.27.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "ruff>=0.5.0",
+    "mypy>=1.10.0",
+]
+
+[project.scripts]
+gaard-client = "gaard_client.cli:main"
+
+[project.entry-points."gaard.commands"]
+client = "gaard_client.cli_commands:register"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+gaard_client = [
+    "client-web/**/*",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

gaard_client-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

gaard_client-0.1.0/src/gaard_client/__init__.py

@@ -0,0 +1 @@
+

gaard_client-0.1.0/src/gaard_client/cli.py

@@ -0,0 +1,25 @@
+import argparse
+from collections.abc import Sequence
+
+from gaard_client.cli_commands import run_client
+
+
+def create_parser(prog: str = "gaard-client") -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog=prog,
+        description="Run the GAARD community client.",
+    )
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    start_parser = subparsers.add_parser("start", help="Start the client server.")
+    start_parser.add_argument("--host", default="127.0.0.1")
+    start_parser.add_argument("--port", type=int, default=8001)
+    start_parser.add_argument("--reload", action="store_true")
+    start_parser.set_defaults(func=run_client)
+
+    return parser
+
+
+def main(argv: Sequence[str] | None = None) -> None:
+    args = create_parser().parse_args(argv)
+    args.func(args)

gaard_client-0.1.0/src/gaard_client/cli_commands.py

@@ -0,0 +1,18 @@
+import uvicorn
+
+
+def register(subparsers):
+    parser = subparsers.add_parser("client")
+    parser.add_argument("--host", default="127.0.0.1")
+    parser.add_argument("--port", type=int, default=8001)
+    parser.add_argument("--reload", action="store_true")
+    parser.set_defaults(func=run_client)
+
+
+def run_client(args):
+    uvicorn.run(
+        "gaard_client.main:app",
+        host=args.host,
+        port=args.port,
+        reload=args.reload,
+    )