synfire 0.0.1__py3-none-any.whl

synfire/__init__.py

@@ -0,0 +1,84 @@
+"""
+Synfire SDK - Python client for the Synfire NIR Model Registry.
+
+Synfire is a public registry for hosting and sharing neuromorphic models
+in the Neuromorphic Intermediate Representation (NIR) format. This SDK
+provides programmatic access to search, download, and publish models.
+
+Quick Start:
+    from synfire import Client
+
+    # Create a client (uses stored credentials from 'synfire login')
+    client = Client()
+
+    # Search for models targeting T1 hardware
+    results = client.search("gesture", platforms=["T1"])
+
+    # Download a model
+    release = client.pull("nrg-lab/gesture-recognition", version="1.0.0")
+
+    # Load the NIR graph (requires: pip install synfire[nir])
+    graph = release.load()
+
+Authentication:
+    The SDK resolves credentials in this order:
+    1. Token passed to Client(token="...")
+    2. SYNFIRE_TOKEN environment variable
+    3. Stored credentials from 'synfire login' (OS keyring)
+
+    For CI/CD pipelines, use the environment variable:
+        export SYNFIRE_TOKEN="synfire_your_token_here"
+
+For more information:
+    - Documentation: https://docs.synfire.dev/sdk
+    - CLI Reference: https://docs.synfire.dev/cli
+    - Web Interface: https://synfire.dev
+"""
+
+from synfire._version import __version__
+from synfire.client import Client
+from synfire.auth import CredentialStore
+from synfire.constants import HardwareTarget
+from synfire.exceptions import (
+    SynfireError,
+    AuthenticationError,
+    ValidationError,
+    NotFoundError,
+    ConflictError,
+    TombstonedError,
+    NetworkError,
+    ChecksumMismatchError,
+)
+from synfire.models import (
+    Release,
+    Repository,
+    Organization,
+    FileInfo,
+    User,
+)
+
+__all__ = [
+    # Version
+    "__version__",
+    # Main client
+    "Client",
+    # Credential management
+    "CredentialStore",
+    # Enums
+    "HardwareTarget",
+    # Models
+    "Release",
+    "Repository",
+    "Organization",
+    "FileInfo",
+    "User",
+    # Exceptions
+    "SynfireError",
+    "AuthenticationError",
+    "ValidationError",
+    "NotFoundError",
+    "ConflictError",
+    "TombstonedError",
+    "NetworkError",
+    "ChecksumMismatchError",
+]

synfire/__main__.py

@@ -0,0 +1,13 @@
+"""
+Allow running the CLI as: python -m synfire
+
+This module serves as the entry point when the package is executed
+as a module, enabling usage like:
+    python -m synfire login
+    python -m synfire search gesture
+"""
+
+from synfire.cli import app
+
+if __name__ == "__main__":
+    app()

synfire/_version.py

@@ -0,0 +1,7 @@
+"""
+Version information for the Synfire SDK.
+
+This module is auto-generated and should not be edited manually.
+"""
+
+__version__ = "0.0.1"