hop3-cli 0.4.0__tar.gz

hop3_cli-0.4.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: hop3-cli
+Version: 0.4.0
+Summary: 
+Author: Stefane Fermigier
+Author-email: Stefane Fermigier <sf@abilian.com>
+License-Expression: Apache-2.0
+Requires-Dist: toml>=0.10.2,<1.0.0
+Requires-Dist: jsonrpcclient>=4.0.3,<5.0.0
+Requires-Dist: requests>=2.32.3,<3.0.0
+Requires-Dist: tabulate>=0.9.0,<1.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: sshtunnel>=0.4.0
+Requires-Dist: paramiko>=2.11.0,<3.0.0
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: pathspec>=0.12.1
+Requires-Dist: platformdirs>=4.3.8
+Requires-Python: >=3.10, <4.0
+Description-Content-Type: text/markdown
+
+# hop3-cli
+
+Command-line interface for interacting with Hop3 servers.
+
+## Overview
+
+hop3-cli is a thin client that communicates with hop3-server via JSON-RPC over HTTP or SSH tunneling. It provides a familiar Heroku-like CLI experience for deploying and managing applications.
+
+## Features
+
+- **Application management**: Deploy, start, stop, restart, and scale applications
+- **Environment variables**: Securely manage app configuration
+- **Log streaming**: View real-time application logs
+- **Addon management**: Provision and manage backing services (PostgreSQL, Redis, MySQL)
+- **SSH tunneling**: Secure communication with remote servers
+- **Multiple output formats**: Human-readable, JSON, or quiet mode
+
+## Installation
+
+```bash
+pip install hop3-cli
+```
+
+## Quick Start
+
+```bash
+# Initialize connection to a Hop3 server
+hop3 init user@hop3.example.com
+
+# Or configure via environment
+export HOP3_API_URL="ssh://user@hop3.example.com"
+
+# List applications
+hop3 apps
+
+# View application logs
+hop3 app:logs myapp
+
+# Set environment variables
+hop3 config:set myapp KEY=value
+```
+
+## Configuration
+
+Configuration can be set via environment variables or config file (`~/.config/hop3-cli/config.toml`).
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `HOP3_API_URL` | Server URL (HTTP or SSH) | - |
+| `HOP3_API_TOKEN` | Authentication token | - |
+| `HOP3_DEV_MODE` | Enable development mode | `false` |
+
+## Architecture
+
+```
+hop3-cli/
+├── src/hop3_cli/
+│   ├── main.py           # Entry point, argument parsing
+│   ├── config.py         # Configuration management
+│   ├── rpc/
+│   │   └── client.py     # JSON-RPC client with SSH tunnel
+│   ├── commands/
+│   │   ├── local.py      # Local commands (init, login, settings)
+│   │   ├── flags.py      # CLI flag parsing
+│   │   └── destructive.py # Confirmation prompts
+│   └── ui/
+│       └── rich_printer.py # Output formatting
+└── tests/
+```
+
+## Development
+
+```bash
+# Run tests
+uv run pytest tests/ -v
+
+# Lint and format
+uv run ruff check src/
+uv run ruff format src/
+```
+
+## Documentation
+
+- [User Guide](../../docs/src/guide.md)
+- [CLI Reference](../../docs/src/cli-reference.md)
+
+## Related Packages
+
+- [hop3-server](../hop3-server/) - The server that hop3-cli communicates with
+- [hop3-tui](../hop3-tui/) - Alternative terminal UI interface
+
+## License
+
+Apache-2.0 - Copyright (c) 2024-2026, Abilian SAS

hop3_cli-0.4.0/README.md

@@ -0,0 +1,94 @@
+# hop3-cli
+
+Command-line interface for interacting with Hop3 servers.
+
+## Overview
+
+hop3-cli is a thin client that communicates with hop3-server via JSON-RPC over HTTP or SSH tunneling. It provides a familiar Heroku-like CLI experience for deploying and managing applications.
+
+## Features
+
+- **Application management**: Deploy, start, stop, restart, and scale applications
+- **Environment variables**: Securely manage app configuration
+- **Log streaming**: View real-time application logs
+- **Addon management**: Provision and manage backing services (PostgreSQL, Redis, MySQL)
+- **SSH tunneling**: Secure communication with remote servers
+- **Multiple output formats**: Human-readable, JSON, or quiet mode
+
+## Installation
+
+```bash
+pip install hop3-cli
+```
+
+## Quick Start
+
+```bash
+# Initialize connection to a Hop3 server
+hop3 init user@hop3.example.com
+
+# Or configure via environment
+export HOP3_API_URL="ssh://user@hop3.example.com"
+
+# List applications
+hop3 apps
+
+# View application logs
+hop3 app:logs myapp
+
+# Set environment variables
+hop3 config:set myapp KEY=value
+```
+
+## Configuration
+
+Configuration can be set via environment variables or config file (`~/.config/hop3-cli/config.toml`).
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `HOP3_API_URL` | Server URL (HTTP or SSH) | - |
+| `HOP3_API_TOKEN` | Authentication token | - |
+| `HOP3_DEV_MODE` | Enable development mode | `false` |
+
+## Architecture
+
+```
+hop3-cli/
+├── src/hop3_cli/
+│   ├── main.py           # Entry point, argument parsing
+│   ├── config.py         # Configuration management
+│   ├── rpc/
+│   │   └── client.py     # JSON-RPC client with SSH tunnel
+│   ├── commands/
+│   │   ├── local.py      # Local commands (init, login, settings)
+│   │   ├── flags.py      # CLI flag parsing
+│   │   └── destructive.py # Confirmation prompts
+│   └── ui/
+│       └── rich_printer.py # Output formatting
+└── tests/
+```
+
+## Development
+
+```bash
+# Run tests
+uv run pytest tests/ -v
+
+# Lint and format
+uv run ruff check src/
+uv run ruff format src/
+```
+
+## Documentation
+
+- [User Guide](../../docs/src/guide.md)
+- [CLI Reference](../../docs/src/cli-reference.md)
+
+## Related Packages
+
+- [hop3-server](../hop3-server/) - The server that hop3-cli communicates with
+- [hop3-tui](../hop3-tui/) - Alternative terminal UI interface
+
+## License
+
+Apache-2.0 - Copyright (c) 2024-2026, Abilian SAS

hop3_cli-0.4.0/pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+name = "hop3-cli"
+version = "0.4.0"
+authors = [
+    {name = "Stefane Fermigier", email = "sf@abilian.com"},
+]
+license = "Apache-2.0"
+requires-python = "<4.0,>=3.10"
+dependencies = [
+    # Configuration
+    "toml<1.0.0,>=0.10.2",
+    # Communication
+    "jsonrpcclient<5.0.0,>=4.0.3",
+    "requests<3.0.0,>=2.32.3",
+    # Presentation
+    "tabulate<1.0.0,>=0.9.0",
+    "rich>=13.0.0",  # Rich formatting, tables, progress bars, colors
+    # SSH tunneling - pin paramiko to 2.x for DSS key compatibility with sshtunnel
+    "sshtunnel>=0.4.0",
+    "paramiko>=2.11.0,<3.0.0",
+    "loguru>=0.7.3",
+    "pathspec>=0.12.1",
+    "platformdirs>=4.3.8",
+]
+description = ""
+readme = "README.md"
+
+[project.scripts]
+hop = "hop3_cli.main:main"
+hop3 = "hop3_cli.main:main"
+
+# ----------------------------------------
+
+[build-system]
+requires = ["uv-build>=0.8.4,<0.9.0"]
+build-backend = "uv_build"
+
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    # paramiko uses TripleDES which cryptography has deprecated
+    "ignore:TripleDES has been moved:cryptography.utils.CryptographyDeprecationWarning",
+]
+
+# Keep!
+[tool.pyrefly]
+project-includes = [
+    "**/*.py*",
+    "**/*.ipynb",
+]
+
+# Was:
+#[build-system]
+#requires = ["pdm-backend"]
+#build-backend = "pdm.backend"
+#
+#[tool.pdm.build]
+#includes = ["src/hop3_cli"]

hop3_cli-0.4.0/src/hop3_cli/__init__.py

@@ -0,0 +1 @@
+# Copyright (c) 2023-2025, Abilian SAS

hop3_cli-0.4.0/src/hop3_cli/commands/__init__.py

@@ -0,0 +1,47 @@
+# Copyright (c) 2025, Abilian SAS
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""Command processing for the Hop3 CLI.
+
+This package handles command parsing and local command execution:
+- local: Commands handled locally without server RPC
+- help: Help flag handling and help output injection
+- destructive: Confirmation prompts for destructive commands
+- flags: CLI flag parsing (--json, --quiet, -y, etc.)
+- arguments: Argument generation (e.g., deploy archive)
+"""
+
+from __future__ import annotations
+
+from .arguments import generate_archive, get_extra_args, pack_repository
+from .destructive import confirm_destructive_action, is_destructive_command
+from .flags import CliFlags, parse_flags
+from .help import (
+    handle_help_flags,
+    inject_local_commands_into_help,
+    is_help_command,
+)
+from .local import (
+    LOCAL_COMMANDS,
+    LOCAL_COMMANDS_INFO,
+    handle_local_command,
+    is_local_command,
+)
+
+__all__ = [
+    "LOCAL_COMMANDS",
+    "LOCAL_COMMANDS_INFO",
+    "CliFlags",
+    "confirm_destructive_action",
+    "generate_archive",
+    "get_extra_args",
+    "handle_help_flags",
+    "handle_local_command",
+    "inject_local_commands_into_help",
+    "is_destructive_command",
+    "is_help_command",
+    "is_local_command",
+    "pack_repository",
+    "parse_flags",
+]