snowglobe 0.0.7__tar.gz → 0.4.0__tar.gz

snowglobe-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Guardrails AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

snowglobe-0.4.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: snowglobe
+Version: 0.4.0
+Summary: client server for usage with snowglobe experiments
+Author-email: Guardrails AI <contact@guardrailsai.com>
+License: MIT License
+        
+        Copyright (c) 2024 Guardrails AI
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.9.0
+Requires-Dist: fastapi>=0.115.6
+Requires-Dist: uvicorn[standard]>=0.23.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: pydantic>=2.11.5
+Requires-Dist: APScheduler==4.0.0a6
+Requires-Dist: httpx==0.28.1
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: ruff<0.2.0,>=0.1.0; extra == "dev"
+Requires-Dist: mypy<2.0.0,>=1.5.0; extra == "dev"
+Requires-Dist: pre-commit>=4.1.0; extra == "dev"
+Requires-Dist: coverage>=7.6.12; extra == "dev"
+Dynamic: license-file
+
+# Snowlgobe Connect SDK
+
+The Snowglobe Connect SDK helps you connect your AI agents to Snowglobe. It sends simulated user messages to your LLM-based application during experiments. Your application should process these messages and return a response, enabling simulated conversations and custom code based risk assessment.
+
+## Installation
+
+```bash
+# Paste Guardrails Client or extract from guardrailsrc
+export GUARDRAILS_TOKEN=$(cat ~/.guardrailsrc| awk -F 'token=' '{print $2}' | awk '{print $1}' | tr -d '\n')
+```
+
+```
+# Install client
+pip install -U --index-url="https://__token__:$GUARDRAILS_TOKEN@pypi.guardrailsai.com/simple" \
+    --extra-index-url="https://pypi.org/simple" snowglobe-connect
+```
+
+If using uv, set the `--prerelease=allow` flag
+```
+pip install -U --index-url="https://__token__:$GUARDRAILS_TOKEN@pypi.guardrailsai.com/simple" \
+    --extra-index-url="https://pypi.org/simple" --prerelease=allow snowglobe-connect
+```
+
+
+## `snowglobe-connect` commands
+
+```bash
+snowglobe-connect auth  # Sets up your API key
+snowglobe-connect init  # Initializes a new agent connection and creates an agent wrapper file
+snowglobe-connect test  # Tests your agent connection
+snowglobe-connect start  # Starts the process of processing simulated user messages
+snowglobe-connect --help
+```
+
+When using one of our specific preview environments in .snowgloberc one can override our server's URL with:
+
+```bash
+CONTROL_PLANE_URL=
+```
+
+## Sample custom llm usage in agent wrapper file
+
+Each agent wrapper file resides in the root directory of your project, and is named after the agent (e.g. `My Agent Name` becomes `my_agent_name.py`).
+
+```python
+from snowglobe.client import CompletionRequest, CompletionFunctionOutputs
+from openai import OpenAI
+import os
+
+client = OpenAI(api_key=os.getenv("SNOWGLOBE_API_KEY"))
+
+def process_scenario(request: CompletionRequest) -> CompletionFunctionOutputs:
+    """
+    Process a scenario request from Snowglobe.
+    
+    This function is called by the Snowglobe client to process requests. It should return a
+    CompletionFunctionOutputs object with the response content.
+
+    Example CompletionRequest:
+    CompletionRequest(
+        messages=[
+            SnowglobeMessage(role="user", content="Hello, how are you?", snowglobe_data=None),
+        ]
+    )
+
+    Example CompletionFunctionOutputs:
+    CompletionFunctionOutputs(response="This is a string response from your application")
+    
+    Args:
+        request (CompletionRequest): The request object containing the messages.
+
+    Returns:
+        CompletionFunctionOutputs: The response object with the generated content.
+    """
+
+    # Process the request using the messages. Example:
+    messages = request.to_openai_messages()
+    response = client.chat.completions.create(
+        model="gpt-4o-mini",
+        messages=messages
+    )
+    return CompletionFunctionOutputs(response=response.choices[0].message.content)
+```

snowglobe-0.4.0/README.md

@@ -0,0 +1,83 @@
+# Snowlgobe Connect SDK
+
+The Snowglobe Connect SDK helps you connect your AI agents to Snowglobe. It sends simulated user messages to your LLM-based application during experiments. Your application should process these messages and return a response, enabling simulated conversations and custom code based risk assessment.
+
+## Installation
+
+```bash
+# Paste Guardrails Client or extract from guardrailsrc
+export GUARDRAILS_TOKEN=$(cat ~/.guardrailsrc| awk -F 'token=' '{print $2}' | awk '{print $1}' | tr -d '\n')
+```
+
+```
+# Install client
+pip install -U --index-url="https://__token__:$GUARDRAILS_TOKEN@pypi.guardrailsai.com/simple" \
+    --extra-index-url="https://pypi.org/simple" snowglobe-connect
+```
+
+If using uv, set the `--prerelease=allow` flag
+```
+pip install -U --index-url="https://__token__:$GUARDRAILS_TOKEN@pypi.guardrailsai.com/simple" \
+    --extra-index-url="https://pypi.org/simple" --prerelease=allow snowglobe-connect
+```
+
+
+## `snowglobe-connect` commands
+
+```bash
+snowglobe-connect auth  # Sets up your API key
+snowglobe-connect init  # Initializes a new agent connection and creates an agent wrapper file
+snowglobe-connect test  # Tests your agent connection
+snowglobe-connect start  # Starts the process of processing simulated user messages
+snowglobe-connect --help
+```
+
+When using one of our specific preview environments in .snowgloberc one can override our server's URL with:
+
+```bash
+CONTROL_PLANE_URL=
+```
+
+## Sample custom llm usage in agent wrapper file
+
+Each agent wrapper file resides in the root directory of your project, and is named after the agent (e.g. `My Agent Name` becomes `my_agent_name.py`).
+
+```python
+from snowglobe.client import CompletionRequest, CompletionFunctionOutputs
+from openai import OpenAI
+import os
+
+client = OpenAI(api_key=os.getenv("SNOWGLOBE_API_KEY"))
+
+def process_scenario(request: CompletionRequest) -> CompletionFunctionOutputs:
+    """
+    Process a scenario request from Snowglobe.
+    
+    This function is called by the Snowglobe client to process requests. It should return a
+    CompletionFunctionOutputs object with the response content.
+
+    Example CompletionRequest:
+    CompletionRequest(
+        messages=[
+            SnowglobeMessage(role="user", content="Hello, how are you?", snowglobe_data=None),
+        ]
+    )
+
+    Example CompletionFunctionOutputs:
+    CompletionFunctionOutputs(response="This is a string response from your application")
+    
+    Args:
+        request (CompletionRequest): The request object containing the messages.
+
+    Returns:
+        CompletionFunctionOutputs: The response object with the generated content.
+    """
+
+    # Process the request using the messages. Example:
+    messages = request.to_openai_messages()
+    response = client.chat.completions.create(
+        model="gpt-4o-mini",
+        messages=messages
+    )
+    return CompletionFunctionOutputs(response=response.choices[0].message.content)
+```

snowglobe-0.4.0/pyproject.toml

@@ -0,0 +1,139 @@
+[project]
+name = "snowglobe"
+version = "0.4.0"
+authors = [
+    {name = "Guardrails AI", email = "contact@guardrailsai.com"}
+]
+license = {file = "LICENSE"}
+
+description = "client server for usage with snowglobe experiments"
+readme = "README.md"
+requires-python = ">= 3.9"
+
+dependencies = [
+    "typer>=0.9.0",
+    "fastapi>=0.115.6",
+    "uvicorn[standard]>=0.23.0",
+    "requests>=2.31.0",
+    "pydantic>=2.11.5",
+    "APScheduler==4.0.0a6",
+    "httpx==0.28.1",
+    "rich>=13.0.0"
+]
+
+[project.optional-dependencies]
+dev = [
+
+    "ruff>=0.1.0,<0.2.0", 
+    "mypy>=1.5.0,<2.0.0",
+    "pre-commit>=4.1.0",
+    "coverage>=7.6.12"
+]
+
+[project.scripts]
+snowglobe-connect = "snowglobe.client.src.cli:cli_app"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+target-version = "py39"
+
+
+[tool.ruff.lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+select = ["E4", "E7", "E9", "F"]
+ignore = []
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[tool.coverage.run]
+omit = [
+    "tests/*",
+    "/tmp/*",
+    "*/tmp*",
+    "/private/var/folders/*"
+]
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true

snowglobe-0.4.0/src/snowglobe/client/__init__.py

@@ -0,0 +1,17 @@
+from .src.models import (
+    SnowglobeData,
+    SnowglobeMessage,
+    CompletionFunctionOutputs,
+    CompletionRequest,
+    RiskEvaluationRequest,
+    RiskEvaluationOutputs,
+)
+
+__all__ = [
+    "SnowglobeData",
+    "SnowglobeMessage",
+    "CompletionFunctionOutputs",
+    "CompletionRequest",
+    "RiskEvaluationRequest",
+    "RiskEvaluationOutputs",
+]