workato-platform-cli 1.0.3__tar.gz

workato_platform_cli-1.0.3/.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: Lint
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run ruff check
+        run: uv run ruff check src/ tests/
+
+      - name: Run ruff format check
+        run: uv run ruff format --check src/ tests/
+
+      - name: Run mypy
+        run: uv run mypy src/ tests/

workato_platform_cli-1.0.3/.github/workflows/pypi.yml

@@ -0,0 +1,180 @@
+name: Build and Publish to PyPI
+
+on:
+  push:
+    branches:
+      - test
+      - release
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+      - '[0-9]+.[0-9]+.[0-9]+-*'
+  workflow_dispatch:
+    inputs:
+      environment:
+        description: 'Deployment environment'
+        required: true
+        type: choice
+        options:
+          - test
+          - release
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+      environment: ${{ steps.determine-env.outputs.environment }}
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required for hatch-vcs versioning
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+      
+      - name: Install build dependencies
+        run: |
+          uv pip install --system build hatch hatch-vcs twine
+      
+      - name: Determine environment
+        id: determine-env
+        run: |
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
+            echo "environment=${{ inputs.environment }}" >> $GITHUB_OUTPUT
+          elif [[ "${{ github.ref }}" == "refs/heads/test" ]]; then
+            echo "environment=test" >> $GITHUB_OUTPUT
+          elif [[ "${{ github.ref }}" == "refs/heads/release" ]] || [[ "${{ github.ref }}" == refs/tags/* ]]; then
+            echo "environment=release" >> $GITHUB_OUTPUT
+          fi
+      
+      - name: Get version and configure for environment
+        id: version
+        run: |
+          if [[ "${{ steps.determine-env.outputs.environment }}" == "test" ]]; then
+            # Test environment: use hatch to get automatic dev versioning
+            VERSION=$(hatch version)
+            echo "Development version: $VERSION"
+          else
+            # Production environment: get clean version from tags
+            VERSION=$(git describe --tags --exact-match 2>/dev/null | sed 's/^v//')
+            if [[ -z "$VERSION" ]]; then
+              echo "Error: Production releases require an exact git tag"
+              exit 1
+            fi
+            echo "Production version: $VERSION"
+          fi
+          
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+      
+      - name: Build package
+        run: python -m build
+      
+      - name: Check package
+        run: |
+          twine check dist/*
+          ls -lh dist/
+          echo "Package version: ${{ steps.version.outputs.version }}"
+      
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ steps.determine-env.outputs.environment }}
+          path: dist/
+
+  publish-test:
+    needs: build
+    if: needs.build.outputs.environment == 'test'
+    runs-on: ubuntu-latest
+    environment:
+      name: test
+      url: https://test.pypi.org/project/workato-platform-cli/
+    
+    permissions:
+      id-token: write  # Required for trusted publishing
+    
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist-test
+          path: dist/
+      
+      - name: Publish to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+          print-hash: true
+      
+      - name: Set up Python for testing
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+      
+      - name: Test installation
+        run: |
+          echo "Waiting for Test PyPI to process the package..."
+          sleep 30
+          
+          echo "Attempting to install latest workato-platform-cli from TestPyPI"
+          uv pip install --system \
+            --index-url https://test.pypi.org/simple/ \
+            --extra-index-url https://pypi.org/simple/ \
+            workato-platform-cli || echo "Package not yet available on Test PyPI"
+          
+          # Verify CLI if installation succeeded
+          workato --version || echo "CLI check skipped"
+
+  publish-release:
+    needs: build
+    if: needs.build.outputs.environment == 'release'
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://pypi.org/project/workato-platform-cli/
+    
+    permissions:
+      id-token: write  # Required for trusted publishing
+      contents: write  # For creating GitHub releases
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist-release
+          path: dist/
+      
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          print-hash: true
+      
+      - name: Create GitHub Release
+        if: startsWith(github.ref, 'refs/tags/')
+        uses: softprops/action-gh-release@v1
+        with:
+          files: dist/*
+          generate_release_notes: true
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

workato_platform_cli-1.0.3/.github/workflows/test.yml

@@ -0,0 +1,49 @@
+name: Tests
+
+on:
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Set up Python
+      run: uv python install 3.11
+
+    - name: Install dependencies
+      run: uv sync --group dev
+
+    - name: Run tests with coverage
+      run: uv run coverage run -m pytest tests/ -v
+
+    - name: Generate coverage report
+      run: |
+        uv run coverage report --format=markdown > coverage.md
+        uv run coverage report --fail-under=85
+        uv run coverage xml
+
+    - name: Add coverage comment to PR
+      uses: MishaKav/pytest-coverage-comment@main
+      if: github.event_name == 'pull_request'
+      with:
+        pytest-xml-coverage-path: ./coverage.xml
+        coverage-path-prefix: src/
+        title: Coverage Report
+        badge-title: Coverage
+        hide-badge: false
+        hide-report: false
+        create-new-comment: false
+        hide-comment: false
+        report-only-changed-files: false
+        remove-link-from-badge: false

workato_platform_cli-1.0.3/.gitignore

@@ -0,0 +1,77 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+venv/
+.venv/
+.python-version
+.pytest_cache
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints
+
+.DS_Store
+.claude/
+.workatoenv
+.vscode/
+.mypy_cache
+.ruff_cache
+
+
+src/workato_platform_cli/_version.py
+.workato-ignore

workato_platform_cli-1.0.3/.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: ^(client/|src/workato_platform_cli/client/)
+      - id: end-of-file-fixer
+        exclude: ^(client/|src/workato_platform_cli/client/)
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: debug-statements
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.13.0
+    hooks:
+      - id: ruff
+        exclude: ^(client/|src/workato_platform_cli/client/)
+      - id: ruff-format
+        exclude: ^(client/|src/workato_platform_cli/client/)
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.18.1
+    hooks:
+      - id: mypy
+        args: [--explicit-package-bases]
+        additional_dependencies:
+          [
+            types-requests,
+            types-click,
+            packaging,
+            asyncclick>=8.0.0,
+            pydantic>=2.11.7,
+            dependency-injector>=4.41.0,
+            inquirer>=3.1.0,
+            aiohttp>=3.8.0,
+            aiohttp-retry>=2.8.0,
+            python-dateutil>=2.8.0,
+            typing-extensions>=4.0.0,
+            pytest>=7.0.0,
+            pytest-asyncio>=0.21.0,
+            pytest-mock>=3.10.0,
+            prompt-toolkit>=3.0.0,
+          ]
+        exclude: ^(client/|src/workato_platform_cli/client/)
+
+  # pip-audit for dependency security auditing
+  - repo: https://github.com/pypa/pip-audit
+    rev: v2.9.0
+    hooks:
+      - id: pip-audit
+        # Temporary workaround: ignoring pip vulnerability GHSA-4xh5-x5gv-qwph (pip 25.2).
+        # Remove this ignore once a patched version of pip is available.
+        args: [--format=json, --ignore-vuln=GHSA-4xh5-x5gv-qwph]
+
+  # Local hooks for project-specific tasks
+  - repo: local
+    hooks:
+      - id: generate-client
+        name: Generate OpenAPI client
+        entry: make generate-client
+        language: system
+        always_run: true
+        pass_filenames: false

workato_platform_cli-1.0.3/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Workato
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

workato_platform_cli-1.0.3/Makefile

@@ -0,0 +1,99 @@
+.PHONY: help install install-dev test lint format clean build upload docs check generate-client
+
+help:
+	@echo "Available commands:"
+	@echo "  install      Install package"
+	@echo "  install-dev  Install package with development dependencies"
+	@echo "  test         Run all tests"
+	@echo "  test-unit    Run unit tests only"
+	@echo "  test-integration Run integration tests only"
+	@echo "  test-client  Run generated client tests only"
+	@echo "  test-cov     Run tests with coverage report"
+	@echo "  test-watch   Run tests in watch mode"
+	@echo "  lint         Run linting checks"
+	@echo "  format       Format code with ruff"
+	@echo "  check        Run all checks (lint + format check + type check)"
+	@echo "  clean        Clean build artifacts"
+	@echo "  build        Build distribution packages"
+	@echo "  upload       Upload to PyPI (requires credentials)"
+	@echo "  docs         Generate documentation"
+	@echo "  generate-client  Generate API client from OpenAPI spec"
+
+install:
+	@if [ ! -d ".venv" ]; then \
+		echo "🔄 Creating virtual environment..."; \
+		uv venv; \
+	fi
+	uv sync
+	uv pip install -e .
+	@echo "✅ Installation complete!"
+	@echo "💡 To activate the virtual environment, run: source .venv/bin/activate"
+	@echo "   Or use 'uv run workato' to run commands without activation"
+
+install-dev:
+	@if [ ! -d ".venv" ]; then \
+		echo "🔄 Creating virtual environment..."; \
+		uv venv; \
+	fi
+	uv sync --group dev
+	uv run pre-commit install
+
+test:
+	uv run pytest tests/ -v
+
+test-unit:
+	uv run pytest tests/unit/ -v
+
+test-integration:
+	uv run pytest tests/integration/ -v
+
+test-client:
+	uv run pytest src/workato_platform_cli/client/workato_api/test/ -v
+
+test-cov:
+	uv run pytest tests/ --cov=src/workato_platform_cli --cov-report=html --cov-report=term --cov-report=xml
+
+test-watch:
+	uv run pytest tests/ -v --tb=short -x --lf
+
+lint:
+	uv run ruff check src/ tests/
+
+format:
+	uv run ruff format src/ tests/
+
+check:
+	uv run ruff check src/ tests/
+	uv run ruff format --check src/ tests/
+	uv run mypy --explicit-package-bases src/ tests/
+
+clean:
+	rm -rf build/
+	rm -rf dist/
+	rm -rf *.egg-info/
+	rm -rf .coverage
+	rm -rf htmlcov/
+	find . -type d -name __pycache__ -delete
+	find . -type f -name "*.pyc" -delete
+
+build: clean
+	python -m build
+
+upload: build
+	twine check dist/*
+	twine upload dist/*
+
+docs:
+	@echo "Documentation generation not yet implemented"
+	@echo "Consider using sphinx-quickstart to set up docs/"
+
+generate-client:
+	@echo "🔄 Generating API client from OpenAPI spec..."
+	openapi-generator-cli generate -i workato-api-spec.yaml -g python -c openapi-config.yaml -o ./src/
+	@echo "✅ API client generated successfully"
+
+# Development shortcuts
+dev: install-dev format check test
+
+# CI/CD command
+ci: check test

workato_platform_cli-1.0.3/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: workato-platform-cli
+Version: 1.0.3
+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
+Project-URL: Issues, https://github.com/workato-devs/workato-platform-cli/issues
+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: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: aiohttp-retry>=2.8.0
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: asyncclick>=8.3.0
+Requires-Dist: cbor2>=5.7.0
+Requires-Dist: certifi>=2025.8.3
+Requires-Dist: dependency-injector>=4.41.0
+Requires-Dist: inquirer>=3.1.0
+Requires-Dist: keyring>=25.6.0
+Requires-Dist: packaging>=21.0
+Requires-Dist: prompt-toolkit>=3.0.0
+Requires-Dist: pydantic-settings>=2.11.0
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: ruff==0.13.0
+Requires-Dist: typing-extensions>=4.0.0
+Requires-Dist: urllib3>=2.5.0
+Provides-Extra: dev
+Requires-Dist: coverage[toml]>=7.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.10.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: coverage>=7.0.0; extra == 'test'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'test'
+Requires-Dist: pytest-mock>=3.10.0; extra == 'test'
+Requires-Dist: pytest>=7.0.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Workato Platform CLI
+
+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/)
+[![Type Checked](https://img.shields.io/badge/type--checked-mypy-blue.svg)](https://mypy.readthedocs.io/)
+[![Code Style](https://img.shields.io/badge/code%20style-ruff-black.svg)](https://docs.astral.sh/ruff/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- **Project Management**: Create, push, pull, and manage Workato projects
+- **Recipe Operations**: Validate, start, stop, and manage recipes
+- **Connection Management**: Create and manage OAuth connections
+- **API Integration**: Manage API clients, collections, and endpoints
+- **AI Agent Support**: Built-in documentation and guide system
+
+# Quick Start Guide
+
+Get the Workato CLI running in 5 minutes.
+
+## Prerequisites
+
+- Python 3.11+
+- Workato account with API token
+
+### Getting Your API Token
+
+1. Log into your Workato account
+1. Navigate to **Workspace Admin** → **API clients**
+1. Click **Create API client**
+1. Fill out information about the client, click **Create client**
+1. Copy the generated token (starts with `wrkatrial-` for trial accounts or `wrkprod-` for production)
+
+## Installation
+
+### From PyPI (Coming Soon)
+
+```bash
+pip install workato-platform-cli
+```
+
+### From Source
+
+```bash
+git clone https://github.com/workato-devs/workato-platform-cli.git
+cd workato-platform-cli
+make install
+```
+
+Having issues? See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/DEVELOPER_GUIDE.md) for troubleshooting.
+
+## Setup
+
+```bash
+# Initialize CLI (will prompt for API token and region)
+workato init
+
+# Verify your workspace
+workato workspace
+```
+
+## First Commands
+
+```bash
+# List available commands
+workato --help
+
+# List your recipes
+workato recipes list
+
+# List your connections
+workato connections list
+
+# Check project status
+workato workspace
+```
+
+## Next Steps
+
+- **Need detailed commands?** → See [COMMAND_REFERENCE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/COMMAND_REFERENCE.md)
+- **Want real-world examples?** → See [USE_CASES.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/USE_CASES.md)
+- **Looking for sample recipes?** → See [examples/](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/examples/)
+- **Installation issues?** → See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/DEVELOPER_GUIDE.md)
+- **Looking for all documentation?** → See [INDEX.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/INDEX.md)
+
+## Quick Recipe Workflow
+
+```bash
+# 1. Validate a recipe file
+workato recipes validate --path ./my-recipe.json
+
+# 2. Push changes to Workato
+workato push
+
+# 3. Pull latest from remote
+workato pull
+```
+
+You're ready to go!
+
+## Contributing to the CLI
+
+These commands are for CLI maintainers and contributors, not for developers using the CLI to build Workato integrations.
+
+### For Development
+
+```bash
+# Setup (with uv - recommended)
+make install-dev
+
+# Run all checks
+make check          # linting, formatting, type checking
+make test          # run tests
+make test-cov      # run tests with coverage
+
+# Development workflow
+make format        # auto-format code
+make lint         # check code quality
+make build        # build distribution packages
+```
+
+### Tech Stack
+
+- **🐍 Python 3.11+** with full type annotations
+- **⚡ uv** for fast dependency management
+- **🔍 mypy** for static type checking
+- **🧹 ruff** for linting and formatting
+- **✅ pytest** for testing
+- **🔧 pre-commit** for git hooks
+
+## License
+
+MIT License