workato-platform-cli 1.0.5__tar.gz → 1.0.7__tar.gz

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: workato-platform-cli
-Version: 1.0.5
+Version: 1.0.7
 Summary: CLI tool for the Workato Platform
 Project-URL: Homepage, https://github.com/workato-devs/workato-platform-cli
 Project-URL: Repository, https://github.com/workato-devs/workato-platform-cli.git
@@ -9,7 +9,7 @@ Author-email: Workato CLI Team <workato-devs@workato.com>
 License: MIT
 License-File: LICENSE
 Keywords: api,automation,cli,workato
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 7 - Inactive
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -54,6 +54,14 @@ Description-Content-Type: text/markdown
 
 # Workato Platform CLI
 
+> [!WARNING]
+> **This package is deprecated and no longer maintained.**
+>
+> `workato-platform-cli` has been replaced by a new, faster Go-based CLI.
+> No further updates, bug fixes, or security patches will be released for this package.
+>
+> **➡️ Install the new CLI: https://workato-devs.github.io/labs/**
+
 A modern, type-safe command-line interface for the Workato API, designed for automation and AI agent interaction. **Perfect for AI agents helping developers build, validate, and manage Workato recipes, connections, and projects.**
 
 [![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/README.md

@@ -1,5 +1,13 @@
 # Workato Platform CLI
 
+> [!WARNING]
+> **This package is deprecated and no longer maintained.**
+>
+> `workato-platform-cli` has been replaced by a new, faster Go-based CLI.
+> No further updates, bug fixes, or security patches will be released for this package.
+>
+> **➡️ Install the new CLI: https://workato-devs.github.io/labs/**
+
 A modern, type-safe command-line interface for the Workato API, designed for automation and AI agent interaction. **Perfect for AI agents helping developers build, validate, and manage Workato recipes, connections, and projects.**
 
 [![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/pyproject.toml

@@ -14,7 +14,7 @@ authors = [
 ]
 keywords = ["workato", "cli", "automation", "api"]
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 7 - Inactive",
     "Environment :: Console",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",

workato_platform_cli-1.0.7/src/workato_platform_cli/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '1.0.7'
+__version_tuple__ = version_tuple = (1, 0, 7)
+
+__commit_id__ = commit_id = None

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/src/workato_platform_cli/cli/__init__.py

@@ -10,6 +10,7 @@ from workato_platform_cli.cli.commands import (
     assets,
     connections,
     data_tables,
+    deprecation_warning,
     guide,
     init,
     profiles,
@@ -107,6 +108,7 @@ cli.add_command(init.init)
 cli.add_command_with_alias(projects.projects, alias="project")
 cli.add_command(profiles.profiles)
 cli.add_command_with_alias(properties.properties, alias="property")
+cli.add_command(deprecation_warning.deprecation_warning)
 
 # Development commands
 cli.add_command(guide.guide)

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/src/workato_platform_cli/cli/commands/api_clients.py

@@ -576,8 +576,9 @@ def display_client_summary(client: ApiClient) -> None:
     click.echo(f"    🔐 Auth Type: {client.auth_type}")
 
     # Show API collections if available
-    for collection in client.api_collections:
-        click.echo(f"    📚 {collection.name} (ID: {collection.id})")
+    if client.api_collections:
+        for collection in client.api_collections:
+            click.echo(f"    📚 {collection.name} (ID: {collection.id})")
 
     # Show email if available (API portal integration)
     if client.email:

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/src/workato_platform_cli/cli/commands/connections.py

@@ -939,7 +939,9 @@ def pick_lists(adapter: str | None = None) -> None:
     """List available pick lists by adapter"""
 
     # Load the bundled picklist data
-    data_file = Path(__file__).parent.parent / "data" / "picklist-data.json"
+    data_file = (
+        Path(__file__).parent.parent / "resources" / "data" / "picklist-data.json"
+    )
 
     if not data_file.exists():
         click.echo(

workato_platform_cli-1.0.7/src/workato_platform_cli/cli/commands/deprecation_warning.py

@@ -0,0 +1,106 @@
+"""Manage the deprecation warning for the retired Python CLI."""
+
+import asyncclick as click
+
+from workato_platform_cli.cli.utils.version_checker import (
+    DEPRECATION_DISABLE_FLAG,
+    NEW_CLI_URL,
+    DeprecationNotifier,
+)
+
+
+@click.group(name="deprecation-warning")
+def deprecation_warning() -> None:
+    """Manage the deprecation warning for this CLI.
+
+    workato-platform-cli is deprecated and has been replaced by a new
+    Go-based CLI. Use the subcommands below to control whether the
+    deprecation warning is shown after each command.
+    """
+    pass
+
+
+@deprecation_warning.command()
+def disable() -> None:
+    """Suppress the deprecation warning on future runs.
+
+    Creates a flag file at ~/.cache/workato-platform-cli/deprecation_warning_disabled.
+    You can also set WORKATO_DISABLE_DEPRECATION_WARNING=1 to suppress the warning
+    without touching the filesystem (useful for CI/CD pipelines).
+    """
+    notifier = DeprecationNotifier()
+
+    if notifier.is_disabled():
+        click.echo("ℹ️  Deprecation warning is already disabled.")
+        return
+
+    notifier.disable()
+    click.echo("✅ Deprecation warning disabled.")
+    click.echo(
+        f"   Flag file: ~/.cache/workato-platform-cli/{DEPRECATION_DISABLE_FLAG}"
+    )
+    click.echo()
+    click.echo(
+        "   You can re-enable it at any time with:  workato deprecation-warning enable"
+    )
+
+
+@deprecation_warning.command()
+def enable() -> None:
+    """Re-enable the deprecation warning after it has been disabled.
+
+    Removes the flag file created by 'workato deprecation-warning disable'.
+    Has no effect if the warning is suppressed via the
+    WORKATO_DISABLE_DEPRECATION_WARNING environment variable.
+    """
+    notifier = DeprecationNotifier()
+
+    if notifier.disable_flag_file.exists():
+        notifier.enable()
+        click.echo("✅ Deprecation warning re-enabled.")
+    else:
+        click.echo("ℹ️  Deprecation warning is not currently disabled by a flag file.")
+
+    if notifier.is_disabled():
+        click.echo()
+        click.echo(
+            "⚠️  Warning: WORKATO_DISABLE_DEPRECATION_WARNING is set in your"
+            " environment."
+        )
+        click.echo(
+            "   The warning will remain suppressed until that variable is unset."
+        )
+
+
+@deprecation_warning.command()
+def status() -> None:
+    """Show whether the deprecation warning is enabled or disabled."""
+    notifier = DeprecationNotifier()
+
+    click.echo("📋 Deprecation Warning Status")
+    click.echo()
+
+    flag_file_exists = notifier.disable_flag_file.exists()
+    env_var_set = __import__("os").getenv(
+        "WORKATO_DISABLE_DEPRECATION_WARNING", ""
+    ).lower() in ("1", "true", "yes")
+
+    if notifier.is_disabled():
+        click.echo("   Status:  ⚠️  DISABLED — warning will not be shown")
+    else:
+        click.echo("   Status:  ✅ ENABLED — warning shown after each command")
+
+    click.echo()
+    click.echo("   Disable mechanisms:")
+    flag_indicator = "✅ active" if flag_file_exists else "○  not set"
+    click.echo(
+        f"   • Flag file (~/.cache/workato-platform-cli/"
+        f"{DEPRECATION_DISABLE_FLAG}):  {flag_indicator}"
+    )
+    env_indicator = "✅ active" if env_var_set else "○  not set"
+    click.echo(
+        f"   • Env var (WORKATO_DISABLE_DEPRECATION_WARNING):  {env_indicator}"
+    )
+
+    click.echo()
+    click.echo(f"   New CLI:  {NEW_CLI_URL}")

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/src/workato_platform_cli/cli/commands/projects/project_manager.py

@@ -238,7 +238,7 @@ class ProjectManager:
             with open(zip_path, "wb") as f:
                 f.write(download_response)
 
-            with zipfile.ZipFile(zip_path, "r") as zip_ref:
+            with zipfile.ZipFile(zip_path, "r", metadata_encoding="utf-8") as zip_ref:
                 zip_ref.extractall(project_dir)
 
             os.remove(zip_path)

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/src/workato_platform_cli/cli/commands/recipes/validator.py

@@ -110,7 +110,7 @@ class RecipeLine(BaseModel):
     clear_scope: bool | None = Field(None, alias="clear_scope")
     repeat_mode: str | None = Field(None, alias="repeat_mode")
     source: str | None = None
-    format_version: str | None = Field(None, alias="format_version")
+    format_version: int | None = Field(None, alias="format_version")
     job_report_config: dict[str, Any] | None = None
     job_report_schema: list[dict[str, Any]] | None = None
     param: dict[str, Any] | None = None

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/src/workato_platform_cli/cli/utils/version_checker.py

@@ -1,5 +1,6 @@
-"""Version checking utilities for the Workato CLI."""
+"""Version checking and deprecation notice utilities for the Workato CLI."""
 
+import asyncio
 import contextlib
 import json
 import os
@@ -39,6 +40,9 @@ PYPI_API_URL = f"https://pypi.org/pypi/{PACKAGE_NAME}/json"
 CHECK_INTERVAL = 86400  # 24 hours in seconds
 REQUEST_TIMEOUT = 2  # seconds
 
+NEW_CLI_URL = "https://workato-devs.github.io/labs/"
+DEPRECATION_DISABLE_FLAG = "deprecation_warning_disabled"
+
 
 class VersionChecker:
     """Handles version checking and update notifications."""
@@ -169,8 +173,77 @@ class VersionChecker:
             click.echo("Failed to check for updates")
 
 
+class DeprecationNotifier:
+    """Handles deprecation warnings for the retired Python CLI."""
+
+    def __init__(self) -> None:
+        """Initialize the deprecation notifier."""
+        self.cache_dir = Path.home() / ".cache" / "workato-platform-cli"
+        self.disable_flag_file = self.cache_dir / DEPRECATION_DISABLE_FLAG
+        self._ensure_cache_dir()
+
+    def _ensure_cache_dir(self) -> None:
+        """Ensure cache directory exists."""
+        self.cache_dir.mkdir(parents=True, exist_ok=True, mode=0o755)
+
+    def is_disabled(self) -> bool:
+        """Return True if the deprecation warning has been suppressed.
+
+        Checks both the environment variable and the persistent disable flag file.
+        """
+        if os.getenv("WORKATO_DISABLE_DEPRECATION_WARNING", "").lower() in (
+            "1",
+            "true",
+            "yes",
+        ):
+            return True
+        return self.disable_flag_file.exists()
+
+    def disable(self) -> None:
+        """Persist the disable flag so the warning is suppressed on future runs."""
+        with contextlib.suppress(OSError):
+            self.disable_flag_file.touch()
+
+    def enable(self) -> None:
+        """Remove the disable flag so the warning is shown again."""
+        with contextlib.suppress(OSError):
+            if self.disable_flag_file.exists():
+                self.disable_flag_file.unlink()
+
+    def show(self) -> None:
+        """Print the deprecation warning to stderr."""
+        click.echo(file=None, err=False)  # blank line separator
+        click.echo(
+            "⚠️  DEPRECATION NOTICE: workato-platform-cli is no longer supported.",
+            err=True,
+        )
+        click.echo(
+            "   This Python CLI has been replaced by a new, faster Go-based CLI.",
+            err=True,
+        )
+        click.echo(
+            f"   Install the new CLI: {NEW_CLI_URL}",
+            err=True,
+        )
+        click.echo(
+            "   To silence this warning, run:  workato deprecation-warning disable",
+            err=True,
+        )
+        click.echo(
+            "   Or set:  export WORKATO_DISABLE_DEPRECATION_WARNING=1",
+            err=True,
+        )
+
+    def run(self) -> None:
+        """Show the deprecation warning unless it has been disabled."""
+        if self.is_disabled():
+            return
+        with contextlib.suppress(Exception):
+            self.show()
+
+
 def check_updates_async(func: Callable) -> Callable:
-    """Decorator to add background update checking to CLI commands."""
+    """Decorator: show deprecation notice and update check after each command."""
 
     @wraps(func)
     async def async_wrapper(*args: Any, **kwargs: Any) -> Any:
@@ -181,6 +254,11 @@ def check_updates_async(func: Callable) -> Callable:
             # Run main command first
             result = await func(*args, **kwargs)
 
+            # Show deprecation warning (always, unless disabled — no rate limit needed
+            # for an EOL notice)
+            deprecation_notifier = DeprecationNotifier()
+            deprecation_notifier.run()
+
             # Check updates in background (non-blocking)
             config_manager = Container.config_manager()
             version_checker = VersionChecker(config_manager)
@@ -209,6 +287,11 @@ def check_updates_async(func: Callable) -> Callable:
             # Run main command first
             result = func(*args, **kwargs)
 
+            # Show deprecation warning (always, unless disabled — no rate limit needed
+            # for an EOL notice)
+            deprecation_notifier = DeprecationNotifier()
+            deprecation_notifier.run()
+
             # Check updates in background (non-blocking)
             config_manager = Container.config_manager()
             version_checker = VersionChecker(config_manager)
@@ -228,9 +311,6 @@ def check_updates_async(func: Callable) -> Callable:
             # If anything goes wrong with update checking, just run the main command
             return func(*args, **kwargs)
 
-    # Return appropriate wrapper based on whether function is async
-    import asyncio
-
     if asyncio.iscoroutinefunction(func):
         return async_wrapper
     else:

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/src/workato_platform_cli/client/workato_api/models/api_client.py

@@ -45,8 +45,8 @@ class ApiClient(BaseModel):
     mtls_enabled: Optional[StrictBool] = None
     validation_formula: Optional[StrictStr] = None
     cert_bundle_ids: Optional[List[StrictInt]] = None
-    api_policies: List[ApiClientApiPoliciesInner] = Field(description="List of API policies associated with the client")
-    api_collections: List[ApiClientApiCollectionsInner] = Field(description="List of API collections associated with the client")
+    api_policies: Optional[List[ApiClientApiPoliciesInner]] = Field(default=None, description="List of API policies associated with the client")
+    api_collections: Optional[List[ApiClientApiCollectionsInner]] = Field(default=None, description="List of API collections associated with the client")
     __properties: ClassVar[List[str]] = ["id", "name", "description", "active_api_keys_count", "total_api_keys_count", "created_at", "updated_at", "logo", "logo_2x", "is_legacy", "email", "auth_type", "api_token", "mtls_enabled", "validation_formula", "cert_bundle_ids", "api_policies", "api_collections"]
 
     @field_validator('auth_type')

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/src/workato_platform_cli/client/workato_api/models/api_collection.py

@@ -18,8 +18,8 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
 from workato_platform_cli.client.workato_api.models.import_results import ImportResults
 from typing import Optional, Set
 from typing_extensions import Self
@@ -30,7 +30,7 @@ class ApiCollection(BaseModel):
     """ # noqa: E501
     id: StrictInt
     name: StrictStr
-    project_id: StrictStr
+    project_id: Optional[Union[StrictStr, StrictInt]] = None
     url: StrictStr
     api_spec_url: StrictStr
     version: StrictStr
@@ -40,6 +40,14 @@ class ApiCollection(BaseModel):
     import_results: Optional[ImportResults] = None
     __properties: ClassVar[List[str]] = ["id", "name", "project_id", "url", "api_spec_url", "version", "created_at", "updated_at", "message", "import_results"]
 
+    @field_validator('project_id', mode='before')
+    @classmethod
+    def coerce_project_id_to_string(cls, v):
+        """Coerce project_id to string since API may return int or string"""
+        if v is not None:
+            return str(v)
+        return v
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/tests/unit/commands/connections/test_helpers.py

@@ -269,7 +269,7 @@ def test_pick_lists(
     expected: str,
 ) -> None:
     module_root = tmp_path / "cli" / "commands"
-    data_dir = module_root.parent / "data"
+    data_dir = module_root.parent / "resources" / "data"
     data_dir.mkdir(parents=True)
 
     picklist_file = data_dir / "picklist-data.json"
@@ -320,7 +320,7 @@ def test_pick_lists_invalid_json(
     monkeypatch: pytest.MonkeyPatch, capture_echo: list[str], tmp_path: Path
 ) -> None:
     module_root = tmp_path / "cli" / "commands"
-    data_dir = module_root.parent / "data"
+    data_dir = module_root.parent / "resources" / "data"
     data_dir.mkdir(parents=True)
     invalid_file = data_dir / "picklist-data.json"
     invalid_file.write_text("not-json")

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/tests/unit/commands/projects/test_project_manager.py

@@ -269,6 +269,51 @@ async def test_download_and_extract_package_success(
         assert (target_dir / "file.txt").exists()
 
 
+@pytest.mark.asyncio
+async def test_download_and_extract_package_preserves_non_ascii_filenames(
+    tmp_path: Path, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    """ZIP files with non-ASCII filenames (e.g. Japanese) should be extracted correctly.
+
+    Python's zipfile defaults to CP437 for metadata decoding, which garbles
+    UTF-8 encoded filenames. metadata_encoding="utf-8" must be passed explicitly.
+    """
+    client = Mock()
+    client.packages_api = Mock()
+    client.packages_api.get_package = AsyncMock(return_value=Mock(status="completed"))
+
+    manager = ProjectManager(client)
+
+    monkeypatch.setattr("time.time", Mock(side_effect=[0, 10, 20]))
+    monkeypatch.setattr("time.sleep", lambda *_args, **_kwargs: None)
+
+    target_dir = tmp_path / "project"
+    monkeypatch.chdir(tmp_path)
+
+    # Build a ZIP whose filename is stored as raw UTF-8 bytes (no UTF-8 flag),
+    # matching what the Workato API returns.
+    japanese_filename = "日本語レシピ_japanese.recipe.json"
+    zip_path = tmp_path / "dummy.zip"
+    with zipfile.ZipFile(zip_path, "w") as zf:
+        zip_info = zipfile.ZipInfo(japanese_filename)
+        zip_info.date_time = (2024, 1, 1, 0, 0, 0)
+        zip_info.flag_bits &= ~0x800  # Clear UTF-8 flag to simulate Workato API ZIP
+        zf.writestr(zip_info, "{}")
+    data = zip_path.read_bytes()
+
+    with patch.object(
+        manager.client.packages_api, "download_package", AsyncMock(return_value=data)
+    ):
+        result = await manager.download_and_extract_package(
+            12, target_dir=str(target_dir)
+        )
+
+    extracted_files = [f.name for f in target_dir.iterdir()]
+    assert japanese_filename in extracted_files, (
+        f"Expected '{japanese_filename}' but got: {extracted_files}"
+    )
+
+
 @pytest.mark.asyncio
 async def test_download_and_extract_package_handles_failure(
     tmp_path: Path,

{workato_platform_cli-1.0.5 → workato_platform_cli-1.0.7}/tests/unit/commands/recipes/test_validator.py

@@ -119,6 +119,17 @@ def test_recipe_line_limits_job_report_entries() -> None:
         )
 
 
+def test_recipe_line_accepts_format_version_as_int() -> None:
+    """format_version is exported as integer by Workato API."""
+    line = RecipeLine(
+        number=0,
+        keyword=Keyword.TRIGGER,
+        uuid="test-uuid",
+        format_version=2,
+    )
+    assert line.format_version == 2
+
+
 def test_is_expression_detects_formulas_jinja_and_data_pills(
     validator: RecipeValidator,
 ) -> None: