plugsync-cli 0.1.0__py3-none-any.whl

plugsync_cli/serializer.py

@@ -0,0 +1,205 @@
+"""Read and write local connector directory format.
+
+Directory structure:
+    connector-name/
+    ├── plugsync.yaml
+    ├── entities/
+    │   ├── contacts.yaml
+    │   └── orders.yaml
+    └── handlers/
+        ├── order_created.py
+        └── contact_updated.py
+"""
+import io
+import re
+import zipfile
+from pathlib import Path
+
+import yaml
+
+
+def _event_type_to_filename(event_type: str) -> str:
+    """Convert event_type like 'order.created' to filename 'order_created.py'."""
+    return re.sub(r"[^a-zA-Z0-9]", "_", event_type) + ".py"
+
+
+def _filename_to_event_type(filename: str) -> str:
+    """Convert filename like 'order_created.py' to 'order.created'."""
+    stem = Path(filename).stem
+    return stem.replace("_", ".")
+
+
+def _build_entity_yaml(name: str, config: dict) -> dict:
+    """Flatten entity config to top-level for readable YAML."""
+    result = {"name": name}
+    for key in (
+        "entity_type",
+        "hubspot_object_type",
+        "identity",
+        "field_mappings",
+        "associations",
+        "scope_overrides",
+    ):
+        if key in config:
+            value = config[key]
+            if key in ("associations", "scope_overrides") and not value:
+                continue
+            result[key] = value
+    return result
+
+
+def _parse_entity_yaml(data: dict) -> dict:
+    """Reconstruct entity dict from flattened YAML."""
+    name = data.get("name", "unknown")
+    config = {}
+    for key in (
+        "entity_type",
+        "hubspot_object_type",
+        "identity",
+        "field_mappings",
+        "associations",
+        "scope_overrides",
+    ):
+        if key in data:
+            config[key] = data[key]
+    return {"name": name, "config": config}
+
+
+def _extract_function_name(code: str) -> str:
+    """Extract the first function name from Python code."""
+    for line in code.split("\n"):
+        stripped = line.strip()
+        if stripped.startswith("async def "):
+            return stripped.split("(")[0].replace("async def ", "").strip()
+        if stripped.startswith("def "):
+            return stripped.split("(")[0].replace("def ", "").strip()
+    return "handler"
+
+
+def _parse_handler_file(content: str) -> tuple[str | None, str]:
+    """Parse handler file, extracting event_type from header comment."""
+    lines = content.split("\n")
+    if lines and lines[0].startswith("# event_type:"):
+        event_type = lines[0].split(":", 1)[1].strip()
+        code = "\n".join(lines[1:])
+        if code.startswith("\n"):
+            code = code[1:]
+        return event_type, code
+    return None, content
+
+
+def write_directory(
+    output_dir: Path,
+    manifest: dict,
+    entities: list[dict],
+    handlers: list[dict],
+) -> None:
+    """Write connector state as a local directory.
+
+    Args:
+        output_dir: Path to the connector directory (will be created).
+        manifest: {"name": ..., "settings": {...}}
+        entities: [{"name": ..., "config": {...}}]
+        handlers: [{"event_type": ..., "function_name": ..., "code": ...}]
+    """
+    output_dir.mkdir(parents=True, exist_ok=True)
+
+    # plugsync.yaml
+    with open(output_dir / "plugsync.yaml", "w") as f:
+        yaml.dump(manifest, f, default_flow_style=False, sort_keys=False)
+
+    # entities/
+    if entities:
+        entities_dir = output_dir / "entities"
+        entities_dir.mkdir(exist_ok=True)
+        for entity in entities:
+            entity_data = _build_entity_yaml(entity["name"], entity["config"])
+            with open(entities_dir / f"{entity['name']}.yaml", "w") as f:
+                yaml.dump(entity_data, f, default_flow_style=False, sort_keys=False)
+
+    # handlers/
+    if handlers:
+        handlers_dir = output_dir / "handlers"
+        handlers_dir.mkdir(exist_ok=True)
+        for handler in handlers:
+            filename = _event_type_to_filename(handler["event_type"])
+            code = handler["code"]
+            header = f"# event_type: {handler['event_type']}\n"
+            if not code.startswith("# event_type:"):
+                code = header + code
+            with open(handlers_dir / filename, "w") as f:
+                f.write(code)
+
+
+def read_directory(connector_dir: Path) -> tuple[dict, list[dict], list[dict]]:
+    """Read a local connector directory into (manifest, entities, handlers).
+
+    Returns:
+        manifest: dict from plugsync.yaml
+        entities: list of {"name": ..., "config": {...}}
+        handlers: list of {"event_type": ..., "function_name": ..., "code": ...}
+    """
+    manifest_path = connector_dir / "plugsync.yaml"
+    if not manifest_path.exists():
+        raise FileNotFoundError(f"No plugsync.yaml found in {connector_dir}")
+
+    with open(manifest_path) as f:
+        manifest = yaml.safe_load(f)
+
+    entities = []
+    entities_dir = connector_dir / "entities"
+    if entities_dir.exists():
+        for yaml_file in sorted(entities_dir.glob("*.yaml")):
+            with open(yaml_file) as f:
+                data = yaml.safe_load(f)
+            entities.append(_parse_entity_yaml(data))
+
+    handlers = []
+    handlers_dir = connector_dir / "handlers"
+    if handlers_dir.exists():
+        for py_file in sorted(handlers_dir.glob("*.py")):
+            content = py_file.read_text()
+            event_type_from_header, code = _parse_handler_file(content)
+            event_type = event_type_from_header or _filename_to_event_type(py_file.name)
+            function_name = _extract_function_name(code)
+            handlers.append({
+                "event_type": event_type,
+                "function_name": function_name,
+                "code": code,
+            })
+
+    return manifest, entities, handlers
+
+
+def read_directory_to_zip(connector_dir: Path) -> bytes:
+    """Read a local directory and pack it into a ZIP for API upload."""
+    manifest, entities, handlers = read_directory(connector_dir)
+    connector_name = manifest.get("name", connector_dir.name)
+    prefix = connector_name
+
+    buf = io.BytesIO()
+    with zipfile.ZipFile(buf, "w", zipfile.ZIP_DEFLATED) as zf:
+        # plugsync.yaml
+        zf.writestr(
+            f"{prefix}/plugsync.yaml",
+            yaml.dump(manifest, default_flow_style=False, sort_keys=False),
+        )
+
+        # entities
+        for entity in entities:
+            entity_data = _build_entity_yaml(entity["name"], entity["config"])
+            zf.writestr(
+                f"{prefix}/entities/{entity['name']}.yaml",
+                yaml.dump(entity_data, default_flow_style=False, sort_keys=False),
+            )
+
+        # handlers
+        for handler in handlers:
+            filename = _event_type_to_filename(handler["event_type"])
+            code = handler["code"]
+            header = f"# event_type: {handler['event_type']}\n"
+            if not code.startswith("# event_type:"):
+                code = header + code
+            zf.writestr(f"{prefix}/handlers/{filename}", code)
+
+    return buf.getvalue()

plugsync_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: plugsync-cli
+Version: 0.1.0
+Summary: Command-line client for plugsync HubSpot connectors -- manage connectors and plugins like code, no repo checkout required
+Author-email: Exelab <hello@plugsync.com>
+License: Proprietary
+Project-URL: Homepage, https://plugsync.com
+Project-URL: Documentation, https://github.com/exelab/plugsync/blob/main/docs/content/reference/plugins/dev-loop.md
+Project-URL: Repository, https://github.com/exelab/plugsync
+Project-URL: Issues, https://github.com/exelab/plugsync/issues
+Keywords: plugsync,hubspot,cli,connectors,integration
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.1
+Requires-Dist: httpx>=0.27
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: respx>=0.21; extra == "dev"
+
+# plugsync-cli
+
+Command-line client for [plugsync](https://plugsync.com), managing HubSpot
+connectors like code: pull a connector's config to a local directory, edit
+it, push it back, diff against the remote, validate, preview a publish, and
+manage plugins -- all without cloning the plugsync backend repo.
+
+## Install
+
+```bash
+pip install plugsync-cli
+```
+
+Requires Python 3.12+.
+
+## Quickstart
+
+```bash
+plugsync config set api_url https://your-plugsync-instance.example.com
+plugsync auth login -e you@example.com
+plugsync pull my-connector
+```
+
+`plugsync auth login` saves a bearer credential to `~/.plugsync/config.yaml`
+that every subsequent command reuses. `PLUGSYNC_API_URL` / `PLUGSYNC_API_KEY`
+environment variables override the config file, handy for CI.
+
+## Commands
+
+| Command | Purpose |
+|---|---|
+| `plugsync auth login` / `logout` | Authenticate (email/password JWT, or a long-lived org API key with `--token`) |
+| `plugsync config set/get/show` | Manage `~/.plugsync/config.yaml` |
+| `plugsync pull <name>` | Download a connector as a local directory |
+| `plugsync push <name>` | Upload a local connector directory |
+| `plugsync diff <name>` | Diff local vs. remote working state |
+| `plugsync validate <name>` | Validate a local connector config |
+| `plugsync preview <name>` | Preview a publish's effects |
+| `plugsync log <name>` | Show a connector's revision history |
+| `plugsync rollback <name>` | Restore a previous revision |
+| `plugsync plugin init/push/list/status/logs/invoke` | Author and manage plugins (Enterprise tier) |
+
+Run `plugsync --help` or `plugsync <command> --help` for the full option list.
+
+## Compatibility
+
+This CLI ships on its own release cadence, independent of the plugsync
+backend. It declares the minimum API version it expects and checks it
+against the API at the start of any command that talks to it, warning
+(never failing outright) if the API is older than expected.
+
+## Documentation
+
+Full reference docs, including the plugin authoring dev-loop, live at
+[docs.plugsync.com](https://plugsync.com) and in the
+[plugsync repository](https://github.com/exelab/plugsync/tree/main/docs).
+
+## License
+
+Proprietary. This CLI talks to the plugsync SaaS API; see
+[plugsync.com/terms](https://plugsync.com/terms) for the terms governing use
+of the plugsync service.

plugsync_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+plugsync_cli/__init__.py,sha256=KNokQtEIi9Xm18J2kpSGo7zpzEiESULyERWUNoWy4AI,75
+plugsync_cli/bundler.py,sha256=nCskRqAILHe3LLMZSyS4klBbM879yBvVJODpZvEEm38,2219
+plugsync_cli/client.py,sha256=HNOjHoIGRkMd5V9gCEiVRhdFoUjJqK7qJJt6ppVsqT8,7620
+plugsync_cli/compat.py,sha256=J0kswv2hTv_SoD9ibKb-fVvN0fHzdWwuJYUCA8553IQ,2841
+plugsync_cli/config.py,sha256=WX4Db5K39oWePiWxwnhtEfSDkF2_QqJZ4IL-Su0lxJU,1517
+plugsync_cli/main.py,sha256=O5oMHFQAeKwmFqc4fwWhTYa7p005eC2O6u4IEa-ss5c,2209
+plugsync_cli/serializer.py,sha256=OjatMuD1nkg6oomBWXB8599dqpgaj4zboh1t8hiLqTU,6912
+plugsync_cli/commands/__init__.py,sha256=wgYTWnZKXF-4M9ITNDhZMTUJH6_FthcUt_5zGj9NS8I,20
+plugsync_cli/commands/auth.py,sha256=8M2N1E6KEBdNjcARDFWSzk4QCimOyeozam8gdfsxCw4,5435
+plugsync_cli/commands/diff.py,sha256=ubbyKBdFMlf0iue3WjlS2spS36EHyVPK7bWXVhLy7jQ,6621
+plugsync_cli/commands/log.py,sha256=49GBgAvvs07d-OwMEgKKc7WalCKH2xmr5l7Ov6N13jM,3376
+plugsync_cli/commands/plugin.py,sha256=ZNku_q4kQ_Aefz1EKysTeglJi74cAtX53FfB7VWUWuw,15715
+plugsync_cli/commands/preview.py,sha256=J7dMryWH0lzGgXPfUW6fVTMQWFqv9QPQv7Rz2Z0A6JI,3122
+plugsync_cli/commands/pull.py,sha256=R-Lu-M__M3DpKyS7Cn3Jzvg7HSE9cJ2ZRXmD9qxqj2Q,4568
+plugsync_cli/commands/push.py,sha256=zwh_dj6xwGNItDKN0VWVR8slMhCjCMnagsavDLcjPzM,3545
+plugsync_cli/commands/rollback.py,sha256=3KM3WnPAx7fVnQOgaLlUQu5A3lXuYAxP1tvL44lQTsA,2354
+plugsync_cli/commands/validate.py,sha256=5pCdXXeiFbNw8IyeGYnAN0EJIQx0wzNuDt1wCc3i-kE,1977
+plugsync_cli-0.1.0.dist-info/METADATA,sha256=U6wJg7GBWdnDG2j3sPp10q9uc3ydPzNvUYbazC1MXS8,3667
+plugsync_cli-0.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+plugsync_cli-0.1.0.dist-info/entry_points.txt,sha256=qWyWFQxY9W7L0hEwoDFjQjgs7TxJMsETk2nIe8jCA9E,51
+plugsync_cli-0.1.0.dist-info/top_level.txt,sha256=tShdp15OlzUttfE_QlFMLIfwQfImdp4YVhmB5rXZCgA,13
+plugsync_cli-0.1.0.dist-info/RECORD,,

plugsync_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

plugsync_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+plugsync = plugsync_cli.main:cli

plugsync_cli-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+plugsync_cli