Skip to content

Commit 6948c9b

Browse files
Add user-facing messages on startup (guards, docs url)
1 parent c9e9da7 commit 6948c9b

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

guardrails_api/app.py

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
from guardrails_api.clients.postgres_client import postgres_is_enabled
1111
from guardrails_api.otel import otel_is_disabled, initialize
1212
from guardrails_api.clients.cache_client import CacheClient
13-
13+
from rich.console import Console
14+
from rich.rule import Rule
1415

1516
# TODO: Move this to a separate file
1617
class OverrideJsonProvider(DefaultJSONProvider):
@@ -50,6 +51,9 @@ def register_config(config: Optional[str] = None):
5051
def create_app(
5152
env: Optional[str] = None, config: Optional[str] = None, port: Optional[int] = None
5253
):
54+
# used to print user-facing messages during server startup
55+
console = Console()
56+
5357
if os.environ.get("APP_ENVIRONMENT") != "production":
5458
from dotenv import load_dotenv
5559

@@ -96,9 +100,23 @@ def create_app(
96100
cache_client.initialize(app)
97101

98102
from guardrails_api.blueprints.root import root_bp
99-
from guardrails_api.blueprints.guards import guards_bp
103+
from guardrails_api.blueprints.guards import guards_bp, guard_client
100104

101105
app.register_blueprint(root_bp)
102106
app.register_blueprint(guards_bp)
103107

108+
console.print(
109+
f"\n:rocket: Guardrails API is available at {self_endpoint}"
110+
)
111+
console.print(f":book: Visit {self_endpoint}/docs to see available API endpoints.\n")
112+
113+
console.print(":green_circle: Active guards and OpenAI compatible endpoints:")
114+
115+
for g in guard_client.get_guards():
116+
g = g.to_dict()
117+
console.print(f"- Guard: [bold white]{g.get('name')}[/bold white] {self_endpoint}/guards/{g.get('name')}/openai/v1")
118+
119+
console.print("")
120+
console.print(Rule("[bold grey]Server Logs[/bold grey]", characters="=", style="white"))
121+
104122
return app

0 commit comments

Comments
 (0)