github/sim
1
1
Fork 0
mirror of https://github.com/simstudioai/sim.git synced 2026-04-06 03:00:16 -04:00
Code Issues Packages Projects Releases Wiki Activity

feat(domain): drop the 'studio' (#818)

Browse Source 
* feat(domain): drop the

* change all references for Sim Studio to Sim

* change back license and notice

* lint

---------

Co-authored-by: waleedlatif <waleedlatif@waleedlatifs-MacBook-Pro.local>
This commit is contained in:
Waleed Latif
2025-07-29 12:51:43 -07:00
committed by GitHub
parent 13608a8bbc
commit ae43381d84
235 changed files with 809 additions and 646 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
packages/python-sdk/README.md
View File

@@ -1,6 +1,6 @@
# Sim Studio Python SDK
# Sim Python SDK
The official Python SDK for [Sim Studio](https://simstudio.ai), allowing you to execute workflows programmatically from your Python applications.
The official Python SDK for [Sim](https://sim.ai), allowing you to execute workflows programmatically from your Python applications.
## Installation
@@ -17,7 +17,7 @@ from simstudio import SimStudioClient
# Initialize the client
client = SimStudioClient(
api_key=os.getenv("SIMSTUDIO_API_KEY", "your-api-key-here"),
base_url="https://simstudio.ai" # optional, defaults to https://simstudio.ai
base_url="https://sim.ai" # optional, defaults to https://sim.ai
)
# Execute a workflow
@@ -35,11 +35,11 @@ except Exception as error:
#### Constructor
```python
SimStudioClient(api_key: str, base_url: str = "https://simstudio.ai")
SimStudioClient(api_key: str, base_url: str = "https://sim.ai")
```
- `api_key` (str): Your Sim Studio API key
- `base_url` (str, optional): Base URL for the Sim Studio API (defaults to `https://simstudio.ai`)
- `api_key` (str): Your Sim API key
- `base_url` (str, optional): Base URL for the Sim API (defaults to `https://sim.ai`)
#### Methods
@@ -261,7 +261,7 @@ from simstudio import SimStudioClient
# Using environment variables
client = SimStudioClient(
api_key=os.getenv("SIMSTUDIO_API_KEY"),
base_url=os.getenv("SIMSTUDIO_BASE_URL", "https://simstudio.ai")
base_url=os.getenv("SIMSTUDIO_BASE_URL", "https://sim.ai")
)
```
@@ -314,7 +314,7 @@ for result in results:
## Getting Your API Key
1. Log in to your [Sim Studio](https://simstudio.ai) account
1. Log in to your [Sim](https://sim.ai) account
2. Navigate to your workflow
3. Click on "Deploy" to deploy your workflow
4. Select or create an API key during the deployment process

4
packages/python-sdk/examples/basic_usage.py
View File

@@ -1,6 +1,6 @@
#!/usr/bin/env python3
"""
Basic usage examples for the Sim Studio Python SDK
Basic usage examples for the Sim Python SDK
"""
import os
@@ -191,7 +191,7 @@ def error_handling_example():
if __name__ == "__main__":
print("🚀 Running Sim Studio Python SDK Examples\n")
print("🚀 Running Sim Python SDK Examples\n")
# Check if API key is set
if not os.getenv("SIMSTUDIO_API_KEY"):

8
packages/python-sdk/pyproject.toml
View File

@@ -6,9 +6,9 @@ build-backend = "setuptools.build_meta"
name = "simstudio-sdk"
version = "0.1.0"
authors = [
{name = "Sim Studio", email = "support@simstudio.ai"},
{name = "Sim", email = "support@sim.ai"},
]
description = "Sim Studio SDK - Execute workflows programmatically"
description = "Sim SDK - Execute workflows programmatically"
readme = "README.md"
license = {text = "Apache-2.0"}
requires-python = ">=3.8"
@@ -45,8 +45,8 @@ dev = [
]
[project.urls]
Homepage = "https://simstudio.ai"
Documentation = "https://docs.simstudio.ai"
Homepage = "https://sim.ai"
Documentation = "https://docs.sim.ai"
Repository = "https://github.com/simstudioai/sim"
"Bug Reports" = "https://github.com/simstudioai/sim/issues"

8
packages/python-sdk/setup.py
View File

@@ -6,9 +6,9 @@ with open("README.md", "r", encoding="utf-8") as fh:
setup(
name="simstudio-sdk",
version="0.1.0",
author="Sim Studio",
author_email="support@simstudio.ai",
description="Sim Studio SDK - Execute workflows programmatically",
author="Sim",
author_email="support@sim.ai",
description="Sim SDK - Execute workflows programmatically",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/simstudioai/sim",
@@ -46,6 +46,6 @@ setup(
project_urls={
"Bug Reports": "https://github.com/simstudioai/sim/issues",
"Source": "https://github.com/simstudioai/sim",
"Documentation": "https://docs.simstudio.ai",
"Documentation": "https://docs.sim.ai",
},
)

14
packages/python-sdk/simstudio/__init__.py
View File

@@ -1,7 +1,7 @@
"""
Sim Studio SDK for Python
Sim SDK for Python
Official Python SDK for Sim Studio, allowing you to execute workflows programmatically.
Official Python SDK for Sim, allowing you to execute workflows programmatically.
"""
from typing import Any, Dict, Optional
@@ -36,7 +36,7 @@ class WorkflowStatus:
class SimStudioError(Exception):
"""Exception raised for Sim Studio API errors."""
"""Exception raised for Sim API errors."""
def __init__(self, message: str, code: Optional[str] = None, status: Optional[int] = None):
super().__init__(message)
@@ -46,14 +46,14 @@ class SimStudioError(Exception):
class SimStudioClient:
"""
Sim Studio API client for executing workflows programmatically.
Sim API client for executing workflows programmatically.
Args:
api_key: Your Sim Studio API key
base_url: Base URL for the Sim Studio API (defaults to https://simstudio.ai)
api_key: Your Sim API key
base_url: Base URL for the Sim API (defaults to https://sim.ai)
"""
def __init__(self, api_key: str, base_url: str = "https://simstudio.ai"):
def __init__(self, api_key: str, base_url: str = "https://sim.ai"):
self.api_key = api_key
self.base_url = base_url.rstrip('/')
self._session = requests.Session()

18
packages/python-sdk/tests/test_client.py
View File

@@ -1,5 +1,5 @@
"""
Tests for the Sim Studio Python SDK
Tests for the Sim Python SDK
"""
import pytest
@@ -9,16 +9,16 @@ from simstudio import SimStudioClient, SimStudioError, WorkflowExecutionResult,
def test_simstudio_client_initialization():
"""Test SimStudioClient initialization."""
client = SimStudioClient(api_key="test-api-key", base_url="https://test.simstudio.ai")
client = SimStudioClient(api_key="test-api-key", base_url="https://test.sim.ai")
assert client.api_key == "test-api-key"
assert client.base_url == "https://test.simstudio.ai"
assert client.base_url == "https://test.sim.ai"
def test_simstudio_client_default_base_url():
"""Test SimStudioClient with default base URL."""
client = SimStudioClient(api_key="test-api-key")
assert client.api_key == "test-api-key"
assert client.base_url == "https://simstudio.ai"
assert client.base_url == "https://sim.ai"
def test_set_api_key():
@@ -31,15 +31,15 @@ def test_set_api_key():
def test_set_base_url():
"""Test setting a new base URL."""
client = SimStudioClient(api_key="test-api-key")
client.set_base_url("https://new.simstudio.ai/")
assert client.base_url == "https://new.simstudio.ai"
client.set_base_url("https://new.sim.ai/")
assert client.base_url == "https://new.sim.ai"
def test_set_base_url_strips_trailing_slash():
"""Test that base URL strips trailing slash."""
client = SimStudioClient(api_key="test-api-key")
client.set_base_url("https://test.simstudio.ai/")
assert client.base_url == "https://test.simstudio.ai"
client.set_base_url("https://test.sim.ai/")
assert client.base_url == "https://test.sim.ai"
@patch('simstudio.requests.Session.get')
@@ -51,7 +51,7 @@ def test_validate_workflow_returns_false_on_error(mock_get):
result = client.validate_workflow("test-workflow-id")
assert result is False
mock_get.assert_called_once_with("https://simstudio.ai/api/workflows/test-workflow-id/status")
mock_get.assert_called_once_with("https://sim.ai/api/workflows/test-workflow-id/status")
def test_simstudio_error():