syfthub-sdk 0.1.0__tar.gz

syfthub_sdk-0.1.0/.gitignore

@@ -0,0 +1,197 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+# Python lib directories (but not frontend/src/lib/)
+/lib/
+lib64/
+!frontend/src/lib/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+.idea/
+
+# VS Code
+.vscode/
+
+# macOS
+.DS_Store
+
+# Windows
+Thumbs.db
+ehthumbs.db
+
+# uv
+backend/uv.lock
+
+# ruff
+.ruff_cache/
+
+# Local data directory
+data/
+backend/data/
+
+# RSA keys (auto-generated for multi-worker support)
+# These should NEVER be committed to version control
+**/rsa_keys/
+*.pem
+
+# Backend-specific ignores
+backend/.coverage
+backend/coverage.xml
+backend/htmlcov/
+backend/.pytest_cache/
+backend/.mypy_cache/
+backend/.ruff_cache/
+backend/.venv/
+backend/.env
+backend/*.db
+backend/syfthub.db
+
+# Frontend
+frontend/node_modules/
+frontend/dist/
+frontend/build/
+frontend/.env*.local
+frontend/.vite/
+frontend/playwright-report/
+frontend/test-results/
+frontend/coverage/
+frontend/.nyc_output/
+frontend/.eslintcache
+frontend/.next/
+frontend/.nuxt/
+frontend/out/
+frontend/storybook-static/
+frontend/tsconfig.tsbuildinfo

syfthub_sdk-0.1.0/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+All notable changes to the SyftHub Python SDK will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - Unreleased
+
+### Added
+
+- Initial release of the SyftHub Python SDK
+- `SyftHubClient` class for API interactions
+- Authentication via API key
+- Resource APIs:
+  - `auth` - Authentication and token management
+  - `users` - User management and profiles
+  - `hub` - Endpoint discovery and search
+  - `chat` - Chat completions API
+  - `accounting` - Usage tracking and billing information
+  - `my_endpoints` - Manage user's own endpoints
+  - `syftai` - SyftAI-specific features
+- Automatic pagination handling with async iterator support
+- Comprehensive error handling with typed exceptions:
+  - `SyftHubError` - Base exception class
+  - `AuthenticationError` - Authentication failures
+  - `RateLimitError` - Rate limit exceeded
+  - `NotFoundError` - Resource not found
+  - `ValidationError` - Request validation failures
+- Full type hints for IDE support and type checking
+- Async HTTP client built on `httpx`
+- Pydantic models for request/response validation
+
+### Dependencies
+
+- Python 3.10+
+- httpx >= 0.27
+- pydantic >= 2.0
+
+[Unreleased]: https://github.com/OpenMined/syfthub/compare/python-sdk/v0.1.0...HEAD
+[0.1.0]: https://github.com/OpenMined/syfthub/releases/tag/python-sdk/v0.1.0

syfthub_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: syfthub-sdk
+Version: 0.1.0
+Summary: Python SDK for interacting with SyftHub API
+Author: SyftHub Team
+License: Apache-2.0
+Keywords: api,client,sdk,syfthub
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.0
+Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.13; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# SyftHub SDK
+
+Python SDK for interacting with the SyftHub API programmatically.
+
+## Installation
+
+```bash
+# Using pip
+pip install syfthub-sdk
+
+# Using uv
+uv add syfthub-sdk
+
+# From source
+cd sdk
+uv sync
+```
+
+## Quick Start
+
+```python
+from syfthub_sdk import SyftHubClient
+
+# Initialize client
+client = SyftHubClient(base_url="https://hub.syft.com")
+
+# Register a new user
+user = client.auth.register(
+    username="john",
+    email="john@example.com",
+    password="secret123",
+    full_name="John Doe"
+)
+
+# Login
+user = client.auth.login(username="john", password="secret123")
+print(f"Logged in as {user.username}")
+
+# Get current user
+me = client.auth.me()
+```
+
+## Managing Your Endpoints
+
+```python
+# List your endpoints (with lazy pagination)
+for endpoint in client.my_endpoints.list():
+    print(f"{endpoint.name} ({endpoint.visibility})")
+
+# Get just the first page
+first_page = client.my_endpoints.list().first_page()
+
+# Create an endpoint
+endpoint = client.my_endpoints.create(
+    name="My Cool API",
+    visibility="public",
+    description="A really cool API",
+    readme="# My API\n\nThis is my API documentation."
+)
+print(f"Created: {endpoint.slug}")
+
+# Update an endpoint
+endpoint = client.my_endpoints.update(
+    endpoint_id=endpoint.id,
+    description="Updated description"
+)
+
+# Delete an endpoint
+client.my_endpoints.delete(endpoint_id=endpoint.id)
+```
+
+## Browsing the Hub
+
+```python
+# Browse public endpoints
+for endpoint in client.hub.browse():
+    print(f"{endpoint.path}: {endpoint.name}")
+
+# Get trending endpoints
+for endpoint in client.hub.trending(min_stars=10):
+    print(f"{endpoint.name} - {endpoint.stars_count} stars")
+
+# Get a specific endpoint by path
+endpoint = client.hub.get("alice/cool-api")
+print(endpoint.readme)
+
+# Star/unstar endpoints (requires auth)
+client.hub.star("alice/cool-api")
+client.hub.unstar("alice/cool-api")
+
+# Check if you've starred an endpoint
+if client.hub.is_starred("alice/cool-api"):
+    print("You've starred this!")
+```
+
+## User Profile
+
+```python
+# Update profile
+user = client.users.update(
+    full_name="John D.",
+    avatar_url="https://example.com/avatar.png"
+)
+
+# Check username availability
+if client.users.check_username("newusername"):
+    print("Username is available!")
+
+# Change password
+client.auth.change_password(
+    current_password="old123",
+    new_password="new456"
+)
+```
+
+## Accounting
+
+```python
+# Get account balance
+balance = client.accounting.balance()
+print(f"Credits: {balance.credits} {balance.currency}")
+
+# List transactions
+for tx in client.accounting.transactions():
+    print(f"{tx.created_at}: {tx.amount} - {tx.description}")
+```
+
+## Token Persistence
+
+```python
+# Get tokens for saving
+tokens = client.get_tokens()
+if tokens:
+    # Save to file, database, etc.
+    save_tokens(tokens.access_token, tokens.refresh_token)
+
+# Later, restore session
+from syfthub_sdk import AuthTokens
+
+tokens = AuthTokens(
+    access_token=load_access_token(),
+    refresh_token=load_refresh_token()
+)
+client.set_tokens(tokens)
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `SYFTHUB_URL` | SyftHub API base URL |
+| `SYFTHUB_ACCOUNTING_URL` | Accounting service URL |
+| `SYFTHUB_ACCOUNTING_EMAIL` | Accounting auth email |
+| `SYFTHUB_ACCOUNTING_PASSWORD` | Accounting auth password |
+
+## Error Handling
+
+```python
+from syfthub_sdk import (
+    SyftHubError,
+    AuthenticationError,
+    AuthorizationError,
+    NotFoundError,
+    ValidationError,
+    ConfigurationError,
+)
+
+try:
+    client.auth.login(username="john", password="wrong")
+except AuthenticationError as e:
+    print(f"Login failed: {e}")
+except SyftHubError as e:
+    print(f"API error [{e.status_code}]: {e.message}")
+```
+
+## Context Manager
+
+```python
+with SyftHubClient(base_url="https://hub.syft.com") as client:
+    client.auth.login(username="john", password="secret123")
+    # ... do work ...
+# Client is automatically closed
+```
+
+## Pagination
+
+All list methods return a `PageIterator` for lazy pagination:
+
+```python
+# Iterate through all items (fetches pages as needed)
+for endpoint in client.my_endpoints.list():
+    print(endpoint.name)
+
+# Get just the first page
+first_page = client.my_endpoints.list().first_page()
+
+# Get all items as a list
+all_items = client.my_endpoints.list().all()
+
+# Get first N items
+top_10 = client.my_endpoints.list().take(10)
+```
+
+## License
+
+MIT

syfthub_sdk-0.1.0/README.md

@@ -0,0 +1,206 @@
+# SyftHub SDK
+
+Python SDK for interacting with the SyftHub API programmatically.
+
+## Installation
+
+```bash
+# Using pip
+pip install syfthub-sdk
+
+# Using uv
+uv add syfthub-sdk
+
+# From source
+cd sdk
+uv sync
+```
+
+## Quick Start
+
+```python
+from syfthub_sdk import SyftHubClient
+
+# Initialize client
+client = SyftHubClient(base_url="https://hub.syft.com")
+
+# Register a new user
+user = client.auth.register(
+    username="john",
+    email="john@example.com",
+    password="secret123",
+    full_name="John Doe"
+)
+
+# Login
+user = client.auth.login(username="john", password="secret123")
+print(f"Logged in as {user.username}")
+
+# Get current user
+me = client.auth.me()
+```
+
+## Managing Your Endpoints
+
+```python
+# List your endpoints (with lazy pagination)
+for endpoint in client.my_endpoints.list():
+    print(f"{endpoint.name} ({endpoint.visibility})")
+
+# Get just the first page
+first_page = client.my_endpoints.list().first_page()
+
+# Create an endpoint
+endpoint = client.my_endpoints.create(
+    name="My Cool API",
+    visibility="public",
+    description="A really cool API",
+    readme="# My API\n\nThis is my API documentation."
+)
+print(f"Created: {endpoint.slug}")
+
+# Update an endpoint
+endpoint = client.my_endpoints.update(
+    endpoint_id=endpoint.id,
+    description="Updated description"
+)
+
+# Delete an endpoint
+client.my_endpoints.delete(endpoint_id=endpoint.id)
+```
+
+## Browsing the Hub
+
+```python
+# Browse public endpoints
+for endpoint in client.hub.browse():
+    print(f"{endpoint.path}: {endpoint.name}")
+
+# Get trending endpoints
+for endpoint in client.hub.trending(min_stars=10):
+    print(f"{endpoint.name} - {endpoint.stars_count} stars")
+
+# Get a specific endpoint by path
+endpoint = client.hub.get("alice/cool-api")
+print(endpoint.readme)
+
+# Star/unstar endpoints (requires auth)
+client.hub.star("alice/cool-api")
+client.hub.unstar("alice/cool-api")
+
+# Check if you've starred an endpoint
+if client.hub.is_starred("alice/cool-api"):
+    print("You've starred this!")
+```
+
+## User Profile
+
+```python
+# Update profile
+user = client.users.update(
+    full_name="John D.",
+    avatar_url="https://example.com/avatar.png"
+)
+
+# Check username availability
+if client.users.check_username("newusername"):
+    print("Username is available!")
+
+# Change password
+client.auth.change_password(
+    current_password="old123",
+    new_password="new456"
+)
+```
+
+## Accounting
+
+```python
+# Get account balance
+balance = client.accounting.balance()
+print(f"Credits: {balance.credits} {balance.currency}")
+
+# List transactions
+for tx in client.accounting.transactions():
+    print(f"{tx.created_at}: {tx.amount} - {tx.description}")
+```
+
+## Token Persistence
+
+```python
+# Get tokens for saving
+tokens = client.get_tokens()
+if tokens:
+    # Save to file, database, etc.
+    save_tokens(tokens.access_token, tokens.refresh_token)
+
+# Later, restore session
+from syfthub_sdk import AuthTokens
+
+tokens = AuthTokens(
+    access_token=load_access_token(),
+    refresh_token=load_refresh_token()
+)
+client.set_tokens(tokens)
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `SYFTHUB_URL` | SyftHub API base URL |
+| `SYFTHUB_ACCOUNTING_URL` | Accounting service URL |
+| `SYFTHUB_ACCOUNTING_EMAIL` | Accounting auth email |
+| `SYFTHUB_ACCOUNTING_PASSWORD` | Accounting auth password |
+
+## Error Handling
+
+```python
+from syfthub_sdk import (
+    SyftHubError,
+    AuthenticationError,
+    AuthorizationError,
+    NotFoundError,
+    ValidationError,
+    ConfigurationError,
+)
+
+try:
+    client.auth.login(username="john", password="wrong")
+except AuthenticationError as e:
+    print(f"Login failed: {e}")
+except SyftHubError as e:
+    print(f"API error [{e.status_code}]: {e.message}")
+```
+
+## Context Manager
+
+```python
+with SyftHubClient(base_url="https://hub.syft.com") as client:
+    client.auth.login(username="john", password="secret123")
+    # ... do work ...
+# Client is automatically closed
+```
+
+## Pagination
+
+All list methods return a `PageIterator` for lazy pagination:
+
+```python
+# Iterate through all items (fetches pages as needed)
+for endpoint in client.my_endpoints.list():
+    print(endpoint.name)
+
+# Get just the first page
+first_page = client.my_endpoints.list().first_page()
+
+# Get all items as a list
+all_items = client.my_endpoints.list().all()
+
+# Get first N items
+top_10 = client.my_endpoints.list().take(10)
+```
+
+## License
+
+MIT