deepflow-opendesk-cli 0.1.0__tar.gz

deepflow_opendesk_cli-0.1.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: deepflow-opendesk-cli
+Version: 0.1.0
+Summary: Command-line client for OpenDesk admin configuration APIs.
+Author: DeepFlow AI
+Project-URL: Repository, https://github.com/DeepFlowAI/opendesk-dev
+Keywords: deepflow,opendesk,cli,openapi,admin,configuration
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: requires-python
+
+# deepflow-opendesk-cli
+
+Python command-line client for OpenDesk admin configuration APIs.
+
+The CLI is designed for implementation engineers, operators, and AI agents that need to configure OpenDesk through the same APIs used by the admin console.
+
+## Scope
+
+This package intentionally exposes only admin configuration APIs. Runtime workspace data, public visitor APIs, reports, and call-center agent actions are excluded by a schema whitelist.
+
+Included examples:
+
+- System settings
+- Roles, employees, employee groups
+- Service hours
+- Channels
+- Field definitions, form layouts, interaction rules
+- User, ticket, and organization view configuration
+- Satisfaction and welcome-message settings
+- Voice flows, ticket workflows, inbound/session routing rules
+- Queue policies
+- Optional tenant, SIP trunk, and phone-number configuration endpoints when extensions are loaded
+
+## Install For Development
+
+```bash
+cd packages/deepflow-opendesk-cli
+pip install -e ".[dev]"
+```
+
+## Configure Host And Token
+
+```bash
+export OPENDESK_HOST="http://localhost:5001"
+export OPENDESK_TOKEN="..."
+```
+
+Or log in and save a local profile:
+
+```bash
+deepflow_opendesk_cli auth login \
+  --tenant 12058577c8114513 \
+  --username test \
+  --save-token
+```
+
+Profile files are stored under `~/.opendesk/cli/{profile}/` with owner-only permissions where supported.
+
+## Common Commands
+
+```bash
+deepflow_opendesk_cli schema fetch
+deepflow_opendesk_cli docs list --tag FieldDefinitions
+deepflow_opendesk_cli docs show fields.create --json
+
+deepflow_opendesk_cli request GET /api/v1/system/info
+deepflow_opendesk_cli call fields.list --query domain=ticket
+deepflow_opendesk_cli call fields.create --json-file field.json
+
+deepflow_opendesk_cli system settings
+deepflow_opendesk_cli roles permission-tree
+deepflow_opendesk_cli employees list
+deepflow_opendesk_cli channels list
+deepflow_opendesk_cli routing session list
+deepflow_opendesk_cli queue policies
+```
+
+Equivalent module invocation:
+
+```bash
+python -m deepflow_opendesk_cli docs list
+```
+
+## AI Agent Flow
+
+Recommended execution loop:
+
+```text
+1. schema fetch or docs list
+2. docs show <endpoint-key>
+3. request/call --dry-run
+4. present plan to a human
+5. batch run / workflow run --yes
+6. verify with config list/get commands
+```
+
+## Batch
+
+`batch run` accepts JSONL. Each line is a config operation:
+
+```jsonl
+{"key":"auth.me"}
+{"key":"fields.create","body":{"domain":"ticket","name":"Customer Tier","field_type":"select"}}
+{"method":"PUT","path":"/api/v1/system-settings","body":{"default_language":"zh","default_timezone":"Asia/Shanghai"}}
+```
+
+Run:
+
+```bash
+deepflow_opendesk_cli batch run ops.jsonl --dry-run
+deepflow_opendesk_cli batch run ops.jsonl --continue-on-error --output results.jsonl
+```
+
+## Development
+
+```bash
+cd packages/deepflow-opendesk-cli
+PYTHONPATH=src python -m pytest tests -q
+python -m build
+```
+
+## Distribution
+
+Releases are automated. Pushing a `v*` git tag (e.g. `v0.1.1`) triggers
+`.github/workflows/release.yml`, which runs the tests, builds the sdist + wheel,
+publishes `deepflow-opendesk-cli` to PyPI, and cuts a GitHub Release.
+
+```bash
+pip install deepflow-opendesk-cli
+```
+
+To cut a patch release, run the helper script (bumps the version across
+`pyproject.toml`, `setup.py`, and `__init__.py`, then tags and pushes):
+
+```bash
+bash .claude/skills/release-publish/scripts/release-tag.sh --dry-run
+bash .claude/skills/release-publish/scripts/release-tag.sh
+```
+
+To build locally without publishing: `python -m build`.

deepflow_opendesk_cli-0.1.0/README.md

@@ -0,0 +1,130 @@
+# deepflow-opendesk-cli
+
+Python command-line client for OpenDesk admin configuration APIs.
+
+The CLI is designed for implementation engineers, operators, and AI agents that need to configure OpenDesk through the same APIs used by the admin console.
+
+## Scope
+
+This package intentionally exposes only admin configuration APIs. Runtime workspace data, public visitor APIs, reports, and call-center agent actions are excluded by a schema whitelist.
+
+Included examples:
+
+- System settings
+- Roles, employees, employee groups
+- Service hours
+- Channels
+- Field definitions, form layouts, interaction rules
+- User, ticket, and organization view configuration
+- Satisfaction and welcome-message settings
+- Voice flows, ticket workflows, inbound/session routing rules
+- Queue policies
+- Optional tenant, SIP trunk, and phone-number configuration endpoints when extensions are loaded
+
+## Install For Development
+
+```bash
+cd packages/deepflow-opendesk-cli
+pip install -e ".[dev]"
+```
+
+## Configure Host And Token
+
+```bash
+export OPENDESK_HOST="http://localhost:5001"
+export OPENDESK_TOKEN="..."
+```
+
+Or log in and save a local profile:
+
+```bash
+deepflow_opendesk_cli auth login \
+  --tenant 12058577c8114513 \
+  --username test \
+  --save-token
+```
+
+Profile files are stored under `~/.opendesk/cli/{profile}/` with owner-only permissions where supported.
+
+## Common Commands
+
+```bash
+deepflow_opendesk_cli schema fetch
+deepflow_opendesk_cli docs list --tag FieldDefinitions
+deepflow_opendesk_cli docs show fields.create --json
+
+deepflow_opendesk_cli request GET /api/v1/system/info
+deepflow_opendesk_cli call fields.list --query domain=ticket
+deepflow_opendesk_cli call fields.create --json-file field.json
+
+deepflow_opendesk_cli system settings
+deepflow_opendesk_cli roles permission-tree
+deepflow_opendesk_cli employees list
+deepflow_opendesk_cli channels list
+deepflow_opendesk_cli routing session list
+deepflow_opendesk_cli queue policies
+```
+
+Equivalent module invocation:
+
+```bash
+python -m deepflow_opendesk_cli docs list
+```
+
+## AI Agent Flow
+
+Recommended execution loop:
+
+```text
+1. schema fetch or docs list
+2. docs show <endpoint-key>
+3. request/call --dry-run
+4. present plan to a human
+5. batch run / workflow run --yes
+6. verify with config list/get commands
+```
+
+## Batch
+
+`batch run` accepts JSONL. Each line is a config operation:
+
+```jsonl
+{"key":"auth.me"}
+{"key":"fields.create","body":{"domain":"ticket","name":"Customer Tier","field_type":"select"}}
+{"method":"PUT","path":"/api/v1/system-settings","body":{"default_language":"zh","default_timezone":"Asia/Shanghai"}}
+```
+
+Run:
+
+```bash
+deepflow_opendesk_cli batch run ops.jsonl --dry-run
+deepflow_opendesk_cli batch run ops.jsonl --continue-on-error --output results.jsonl
+```
+
+## Development
+
+```bash
+cd packages/deepflow-opendesk-cli
+PYTHONPATH=src python -m pytest tests -q
+python -m build
+```
+
+## Distribution
+
+Releases are automated. Pushing a `v*` git tag (e.g. `v0.1.1`) triggers
+`.github/workflows/release.yml`, which runs the tests, builds the sdist + wheel,
+publishes `deepflow-opendesk-cli` to PyPI, and cuts a GitHub Release.
+
+```bash
+pip install deepflow-opendesk-cli
+```
+
+To cut a patch release, run the helper script (bumps the version across
+`pyproject.toml`, `setup.py`, and `__init__.py`, then tags and pushes):
+
+```bash
+bash .claude/skills/release-publish/scripts/release-tag.sh --dry-run
+bash .claude/skills/release-publish/scripts/release-tag.sh
+```
+
+To build locally without publishing: `python -m build`.

deepflow_opendesk_cli-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "deepflow-opendesk-cli"
+version = "0.1.0"
+description = "Command-line client for OpenDesk admin configuration APIs."
+readme = "README.md"
+requires-python = ">=3.11"
+authors = [{ name = "DeepFlow AI" }]
+keywords = ["deepflow", "opendesk", "cli", "openapi", "admin", "configuration"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+]
+dependencies = []
+
+[project.optional-dependencies]
+dev = ["build>=1.0", "pytest>=8.0", "twine>=5.0"]
+
+[project.urls]
+Repository = "https://github.com/DeepFlowAI/opendesk-dev"
+
+[project.scripts]
+deepflow_opendesk_cli = "deepflow_opendesk_cli.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]

deepflow_opendesk_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

deepflow_opendesk_cli-0.1.0/setup.py

@@ -0,0 +1,18 @@
+"""Setuptools compatibility entrypoint for older editable-install tooling."""
+
+from pathlib import Path
+
+from setuptools import find_packages, setup
+
+
+setup(
+    name="deepflow-opendesk-cli",
+    version="0.1.0",
+    description="Command-line client for OpenDesk admin configuration APIs.",
+    long_description=Path("README.md").read_text(encoding="utf-8"),
+    long_description_content_type="text/markdown",
+    python_requires=">=3.11",
+    package_dir={"": "src"},
+    packages=find_packages(where="src"),
+    entry_points={"console_scripts": ["deepflow_opendesk_cli=deepflow_opendesk_cli.cli:main"]},
+)

deepflow_opendesk_cli-0.1.0/src/deepflow_opendesk_cli/__init__.py

@@ -0,0 +1,3 @@
+"""OpenDesk admin configuration API CLI."""
+
+__version__ = "0.1.0"

deepflow_opendesk_cli-0.1.0/src/deepflow_opendesk_cli/__main__.py

@@ -0,0 +1,7 @@
+"""Module entrypoint for ``python -m deepflow_opendesk_cli``."""
+
+from .cli import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

deepflow_opendesk_cli-0.1.0/src/deepflow_opendesk_cli/batch.py

@@ -0,0 +1,53 @@
+"""JSONL batch helpers for OpenDesk CLI."""
+
+from __future__ import annotations
+
+import json
+from collections.abc import Callable
+from pathlib import Path
+from typing import Any
+
+from .client import CliError, HttpResult
+
+OperationRunner = Callable[[dict[str, Any]], HttpResult]
+
+
+def load_jsonl(path: str | Path) -> list[dict[str, Any]]:
+    """Load batch operations from a JSONL file."""
+    operations: list[dict[str, Any]] = []
+    for lineno, raw in enumerate(Path(path).read_text(encoding="utf-8").splitlines(), start=1):
+        line = raw.strip()
+        if not line or line.startswith("#"):
+            continue
+        try:
+            payload = json.loads(line)
+        except json.JSONDecodeError as exc:
+            raise CliError(f"Invalid JSONL at line {lineno}: {exc.msg}") from exc
+        if not isinstance(payload, dict):
+            raise CliError(f"Batch line {lineno} must be a JSON object")
+        operations.append(payload)
+    return operations
+
+
+def run_batch(
+    operations: list[dict[str, Any]],
+    runner: OperationRunner,
+    *,
+    continue_on_error: bool = False,
+) -> list[dict[str, Any]]:
+    """Run operations through a callback and return structured line results."""
+    results: list[dict[str, Any]] = []
+    for index, operation in enumerate(operations, start=1):
+        try:
+            result = runner(operation)
+            item = {"index": index, **result.to_dict()}
+        except Exception as exc:  # noqa: BLE001 - batch output should capture user-facing failures.
+            item = {"index": index, "ok": False, "error": str(exc), "operation": operation}
+            results.append(item)
+            if not continue_on_error:
+                break
+            continue
+        results.append(item)
+        if not result.ok and not continue_on_error:
+            break
+    return results