syncforge 1.0.0__tar.gz → 1.0.2__tar.gz

{syncforge-1.0.0/syncforge.egg-info → syncforge-1.0.2}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: syncforge
-Version: 1.0.0
+Version: 1.0.2
 Summary: Official Python SDK for SyncForge — control exactly when data syncs between your database and clients.
 Author-email: SyncForge <sureshdulupolai@gmail.com>
-License: MIT
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/sureshdulupolai/syncforge
 Project-URL: Documentation, https://syncforge.dev/docs/
 Project-URL: Repository, https://github.com/sureshdulupolai/syncforge
@@ -11,7 +11,6 @@ Project-URL: Bug Tracker, https://github.com/sureshdulupolai/syncforge/issues
 Keywords: syncforge,sync,database,cache,invalidation,django,fastapi
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9

{syncforge-1.0.0 → syncforge-1.0.2}/pyproject.toml

@@ -4,10 +4,11 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "syncforge"
-version = "1.0.0"
+version = "1.0.2"
 description = "Official Python SDK for SyncForge — control exactly when data syncs between your database and clients."
 readme = "README.md"
-license = { text = "MIT" }
+license = "MIT"
+license-files = ["LICENSE"]
 authors = [
     { name = "SyncForge", email = "sureshdulupolai@gmail.com" }
 ]
@@ -15,7 +16,6 @@ keywords = ["syncforge", "sync", "database", "cache", "invalidation", "django",
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",

{syncforge-1.0.0 → syncforge-1.0.2}/syncforge/client.py

@@ -157,6 +157,58 @@ class SyncForge:
         data = self._request("GET", url)
         return data.get("tables", [])
 
+    def create_table(self, table_name: str, sync_mode: str = "event") -> bool:
+        """
+        Register a new table programmatically.
+        
+        Args:
+            table_name: The name of the table to register.
+            sync_mode: The sync mode (e.g. 'event', 'manual', 'schedule_5m').
+            
+        Returns:
+            bool: True if created, False if it already existed.
+        """
+        table_name = table_name.strip().lower()
+        if not table_name:
+            raise ValueError("Table name cannot be empty.")
+            
+        url = f"{self._base_url}/v1/tables/"
+        try:
+            res = self._request("POST", url, json_data={"table_name": table_name, "sync_mode": sync_mode})
+            return res.get("created", False)
+        except SyncForgeError as exc:
+            if self._silent:
+                import warnings
+                warnings.warn(f"[SyncForge] create_table failed: {exc}", stacklevel=2)
+                return False
+            raise
+
+    def delete_table(self, table_name: str) -> bool:
+        """
+        Delete a registered table from the SyncForge dashboard programmatically.
+        
+        Args:
+            table_name: The name of the table to delete.
+            
+        Returns:
+            bool: True if it was deleted, False otherwise.
+        """
+        table_name = table_name.strip().lower()
+        if not table_name:
+            raise ValueError("Table name cannot be empty.")
+            
+        import urllib.parse
+        url = f"{self._base_url}/v1/tables/?table_name={urllib.parse.quote(table_name)}"
+        try:
+            res = self._request("DELETE", url)
+            return res.get("deleted", False)
+        except SyncForgeError as exc:
+            if self._silent:
+                import warnings
+                warnings.warn(f"[SyncForge] delete_table failed: {exc}", stacklevel=2)
+                return False
+            raise
+
     # ── Internal ──────────────────────────────────────────────────────────────
 
     def _refresh_all(self, tables: tuple) -> List[SyncResult]:
@@ -196,14 +248,16 @@ class SyncForge:
             status_code = 200,
         )
 
-    def _request(self, method: str, url: str) -> dict:
+    def _request(self, method: str, url: str, json_data: dict = None) -> dict:
         headers = {
             "X-API-Key":    self._api_key,
             "Content-Type": "application/json",
             "Accept":       "application/json",
-            "User-Agent":   "syncforge-python/1.0.0",
+            "User-Agent":   "syncforge-python/1.0.1",
         }
         body = b"" if method == "GET" else b"{}"
+        if json_data is not None:
+            body = json.dumps(json_data).encode("utf-8")
         req  = urllib.request.Request(url, data=body, headers=headers, method=method)
 
         try:

syncforge-1.0.2/syncforge/django.py

@@ -0,0 +1,78 @@
+"""
+Django integration for SyncForge.
+Provides the @sync_model decorator to auto-sync Django models.
+"""
+import logging
+
+try:
+    from django.db.models.signals import post_save, post_delete
+    from django.apps import apps
+    HAS_DJANGO = True
+except ImportError:
+    HAS_DJANGO = False
+
+logger = logging.getLogger("syncforge")
+
+_registered_tables = set()
+
+def sync_model(sf_client, sync_mode='event'):
+    """
+    Class decorator for Django models to automatically sync with SyncForge.
+    
+    Example:
+        from syncforge import sf
+        from syncforge.django import sync_model
+        
+        @sync_model(sf)
+        class Product(models.Model):
+            name = models.CharField(max_length=100)
+    """
+    def decorator(cls):
+        if not HAS_DJANGO:
+            raise ImportError("Django is not installed. Cannot use @sync_model.")
+            
+        table_name = cls._meta.db_table
+        
+        # 1. Register table on SyncForge dashboard
+        try:
+            sf_client.create_table(table_name, sync_mode=sync_mode)
+        except Exception as e:
+            logger.warning(f"[SyncForge] Failed to register table {table_name}: {e}")
+            
+        _registered_tables.add(table_name)
+            
+        # 2. Hook into ORM signals to trigger syncs automatically
+        def _trigger_sync(sender, **kwargs):
+            try:
+                sf_client.refresh(table_name)
+            except Exception as e:
+                logger.error(f"[SyncForge] Failed to trigger sync for {table_name}: {e}")
+                
+        # Connect signals
+        post_save.connect(_trigger_sync, sender=cls, weak=False, dispatch_uid=f"sf_save_{table_name}")
+        post_delete.connect(_trigger_sync, sender=cls, weak=False, dispatch_uid=f"sf_delete_{table_name}")
+        
+        return cls
+    return decorator
+
+
+def sync_migrations(sf_client):
+    """
+    Removes tables from the SyncForge dashboard that no longer exist in your Django project.
+    Call this inside an AppConfig.ready() or after your migrations run.
+    """
+    if not HAS_DJANGO:
+        return
+        
+    try:
+        active_tables = {model._meta.db_table for model in apps.get_models()}
+        
+        # Fetch current registered tables from SyncForge
+        sf_tables = sf_client.list_tables()
+        for t in sf_tables:
+            t_name = t.get('table_name')
+            if t_name and t_name not in active_tables:
+                sf_client.delete_table(t_name)
+                logger.info(f"[SyncForge] Cleaned up deleted table: {t_name}")
+    except Exception as e:
+        logger.warning(f"[SyncForge] sync_migrations cleanup failed: {e}")

{syncforge-1.0.0 → syncforge-1.0.2/syncforge.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: syncforge
-Version: 1.0.0
+Version: 1.0.2
 Summary: Official Python SDK for SyncForge — control exactly when data syncs between your database and clients.
 Author-email: SyncForge <sureshdulupolai@gmail.com>
-License: MIT
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/sureshdulupolai/syncforge
 Project-URL: Documentation, https://syncforge.dev/docs/
 Project-URL: Repository, https://github.com/sureshdulupolai/syncforge
@@ -11,7 +11,6 @@ Project-URL: Bug Tracker, https://github.com/sureshdulupolai/syncforge/issues
 Keywords: syncforge,sync,database,cache,invalidation,django,fastapi
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9

{syncforge-1.0.0 → syncforge-1.0.2}/syncforge.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 pyproject.toml
 syncforge/__init__.py
 syncforge/client.py
+syncforge/django.py
 syncforge/exceptions.py
 syncforge/result.py
 syncforge.egg-info/PKG-INFO