initial cli plus some cleanup

Author: CalebCourier

MANIFEST.in

@@ -0,0 +1,2 @@
+include guardrails_api/*
+exclude */__pycache__/*

Makefile

@@ -1,11 +1,6 @@
 # Installs production dependencies
 install:
 	pip install -r requirements.txt;
-	# This is a workaround because of this issue: https://github.com/open-telemetry/opentelemetry-python-contrib/issues/2053
-	pip uninstall aiohttp -y
-	pip install opentelemetry-distro
-	opentelemetry-bootstrap -a install
-	pip install aiohttp
 
 # Installs development dependencies
 install-dev:
@@ -18,8 +13,13 @@ lock:
 install-lock:
 	pip install -r requirements-lock.txt
 
+.PHONY: build
+build:
+	curl https://raw.githubusercontent.com/guardrails-ai/guardrails-api-client/main/service-specs/guardrails-service-spec.yml -o ./open-api-spec.yml
+	npx @redocly/cli bundle --dereferenced --output ./guardrails_api/open-api-spec.json --ext json ./open-api-spec.yml
+
 start:
-	bash start.sh
+	bash ./guardrails_api/start.sh
 
 infra:
 	docker compose --profile infra up --build
@@ -37,15 +37,16 @@ refresh:
 
 
 format:
-	ruff check app.py src/ tests/ --fix
-	ruff format app.py src/ tests/
+	ruff check guardrails_api/ tests/ --fix
+	ruff format guardrails_api/ tests/
 
 
 lint:
-	ruff check app.py src/ tests/
-	ruff format app.py src/ tests/
+	ruff check guardrails_api/ tests/
+	ruff format guardrails_api/ tests/
 
 qa:
+	make build
 	make lint
 	make test-cov
 
@@ -57,10 +58,10 @@ test:
 	pytest ./tests
 
 test-cov:
-	coverage run --source=./src -m pytest ./tests
-	coverage report --fail-under=50
+	coverage run --source=./guardrails_api -m pytest ./tests
+	coverage report --fail-under=45
 
 view-test-cov:
-	coverage run --source=./src -m pytest ./tests
+	coverage run --source=./guardrails_api -m pytest ./tests
 	coverage html
 	open htmlcov/index.html

default.env

@@ -1 +1 @@
-__version__ = "0.0.0"
+__version__ = "0.0.0"

guardrails_api/__init__.py

@@ -1,4 +1,5 @@
 import os
+from typing import Optional
 from flask import Flask
 from flask_cors import CORS
 from werkzeug.middleware.proxy_fix import ProxyFix
@@ -20,12 +21,30 @@ def __call__(self, environ, start_response):
         return self.app(environ, start_response)
 
 
-def create_app():
+def register_config(config: Optional[str] = None):
+    default_config_file = os.path.join(os.path.dirname(__file__), "default_config.py")
+
+    config_file = config or default_config_file
+    config_file_path = os.path.abspath(config_file)
+    if os.path.isfile(config_file_path):
+        from importlib.machinery import SourceFileLoader
+
+        # This creates a module named "validators" with the contents of the init file
+        # This allow statements like `from validators import StartsWith`
+        # But more importantly, it registers all of the validators imported in the init
+        SourceFileLoader("config", config_file_path).load_module()
+
+
+def create_app(env: Optional[str] = None, config: Optional[str] = None):
     if os.environ.get("APP_ENVIRONMENT") != "production":
         from dotenv import load_dotenv
 
-        # TODO: Accept this as an env var
-        load_dotenv()
+        default_env_file = os.path.join(os.path.dirname(__file__), "default.env")
+        env_file = env or default_env_file
+        env_file_path = os.path.abspath(env_file)
+        load_dotenv(env_file_path)
+
+    register_config(config)
 
     app = Flask(__name__)
 

guardrails_api/app.py

@@ -16,7 +16,6 @@
 from guardrails_api.clients.postgres_client import postgres_is_enabled
 from guardrails_api.utils.handle_error import handle_error
 from guardrails_api.utils.get_llm_callable import get_llm_callable
-from guardrails_api.utils.prep_environment import cleanup_environment, prep_environment
 
 
 guards_bp = Blueprint("guards", __name__, url_prefix="/guards")
@@ -27,9 +26,8 @@
     guard_client = PGGuardClient()
 else:
     guard_client = MemoryGuardClient()
-    # TODO: Accept file path as env var and dynamically import
-    # read in guards from file
-    import config
+    # Will be defined at runtime
+    import config  # noqa
 
     exports = config.__dir__()
     for export_name in exports:
@@ -180,9 +178,6 @@ def validate(guard_name: str):
     )
     decoded_guard_name = unquote_plus(guard_name)
     guard_struct = guard_client.get_guard(decoded_guard_name)
-    if isinstance(guard_struct, GuardStruct):
-        # TODO: is there a way to do this with Guard?
-        prep_environment(guard_struct)
 
     llm_output = payload.pop("llmOutput", None)
     num_reasks = payload.pop("numReasks", guard_struct.num_reasks)
@@ -327,6 +322,4 @@ def validate_streamer(guard_iter):
     #     prompt_params=prompt_params,
     #     result=result
     # )
-    if isinstance(guard_struct, GuardStruct):
-        cleanup_environment(guard_struct)
     return validation_output.to_response()

guardrails_api/blueprints/guards.py

@@ -3,6 +3,7 @@
 import flask
 from string import Template
 from flask import Blueprint
+from guardrails_api.open_api_spec import get_open_api_spec
 from sqlalchemy import text
 from guardrails_api.classes.health_check import HealthCheck
 from guardrails_api.clients.postgres_client import PostgresClient, postgres_is_enabled
@@ -11,7 +12,6 @@
 
 
 root_bp = Blueprint("root", __name__, url_prefix="/")
-cached_api_spec = None
 
 
 @root_bp.route("/")
@@ -42,11 +42,8 @@ def health_check():
 @root_bp.route("/api-docs")
 @handle_error
 def api_docs():
-    global cached_api_spec
-    if not cached_api_spec:
-        with open("./open-api-spec.json") as api_spec_file:
-            cached_api_spec = json.loads(api_spec_file.read())
-    return json.dumps(cached_api_spec)
+    api_spec = get_open_api_spec()
+    return json.dumps(api_spec)
 
 
 @root_bp.route("/docs")

guardrails_api/blueprints/root.py

@@ -0,0 +1,24 @@
+import typer
+import guardrails_api.cli.start  # noqa
+from typing import Optional
+from guardrails_api import __version__
+from guardrails_api.cli.cli import cli
+
+
+def version_callback(value: bool):
+    if value:
+        print(f"guardrails-api CLI Version: {__version__}")
+        raise typer.Exit()
+
+
+@cli.callback()
+def main(
+    version: Optional[bool] = typer.Option(
+        None, "--version", callback=version_callback, is_eager=True
+    ),
+):
+    pass
+
+
+if __name__ == "__main__":
+    cli()

guardrails_api/cli/__init__.py

@@ -0,0 +1,4 @@
+import typer
+
+
+cli = typer.Typer()

guardrails_api/cli/cli.py

@@ -0,0 +1,50 @@
+import typer
+from typing import Optional
+from gunicorn.app.base import BaseApplication
+from guardrails_api.cli.cli import cli
+from guardrails_api.app import create_app
+
+
+class StandaloneApplication(BaseApplication):
+    def __init__(self, app, options=None):
+        self.options = options or {}
+        self.application = app
+        super().__init__()
+
+    def load_config(self):
+        config = {
+            key: value
+            for key, value in self.options.items()
+            if key in self.cfg.settings and value is not None
+        }
+        for key, value in config.items():
+            self.cfg.set(key.lower(), value)
+
+    def load(self):
+        return self.application
+
+
+@cli.command("start")
+def start(
+    env: Optional[str] = typer.Option(
+        default="",
+        help="An env file to load environment variables from.",
+        prompt=".env file (optional)",
+    ),
+    config: Optional[str] = typer.Option(
+        default="",
+        help="A config file to load Guards from.",
+        prompt="config file (optional)",
+    ),
+):
+    # TODO: If these are empty,
+    #   look for them in a .guardrailsrc in the current directory.
+    env = env or None
+    config = config or None
+
+    options = {
+        "bind": "0.0.0.0:8000",
+        "timeout": 5,
+        "threads": 10,
+    }
+    StandaloneApplication(create_app(env, config), options).run()

guardrails_api/cli/start.py

@@ -1,11 +1,11 @@
-'''
+"""
 All guards defined here will be initialized, if and only if
 the application is using in memory guards.
 
 The application will use in memory guards if pg_host is left
-undefined. Otherwise, a postgres instance will be started 
+undefined. Otherwise, a postgres instance will be started
 and guards will be persisted into postgres. In that case,
 these guards will not be initialized.
-'''
+"""
 
-from guardrails import Guard
+from guardrails import Guard  # noqa

config.py renamed to guardrails_api/default_config.py

@@ -0,0 +1,17 @@
+import json
+import os
+
+open_api_spec = None
+
+
+def get_open_api_spec():
+    global open_api_spec
+    if not open_api_spec:
+        api_spec_file_path = os.path.abspath(
+            os.path.join(os.path.dirname(__file__), "open-api-spec.json")
+        )
+
+        with open(api_spec_file_path) as api_spec_file:
+            open_api_spec = json.loads(api_spec_file.read())
+
+    return open_api_spec

guardrails_api/models/__init__.py

@@ -10,4 +10,4 @@ export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES
 curl https://raw.githubusercontent.com/guardrails-ai/guardrails-api-client/main/service-specs/guardrails-service-spec.yml -o ./open-api-spec.yml
 npx @redocly/cli bundle --dereferenced --output ./open-api-spec.json --ext json ./open-api-spec.yml
 
-gunicorn --bind 0.0.0.0:8000 --timeout=5 --threads=10 "app:create_app()"
+gunicorn --bind 0.0.0.0:8000 --timeout=5 --threads=10 "guardrails_api.app:create_app()"

guardrails_api/open_api_spec.py

@@ -1,12 +1,10 @@
-import json
 from jsonschema import Draft202012Validator, ValidationError
 from referencing import Registry, jsonschema as jsonschema_ref
+from guardrails_api.open_api_spec import get_open_api_spec
 from guardrails_api.classes.http_error import HttpError
 from guardrails_api.utils.remove_nones import remove_nones
 
-with open("./open-api-spec.json") as api_spec_file:
-    api_spec = json.loads(api_spec_file.read())
-
+api_spec = get_open_api_spec()
 registry = Registry().with_resources(
     [
         (