asp-cli 0.1.0__tar.gz → 0.5.0__tar.gz

{asp_cli-0.1.0 → asp_cli-0.5.0}/.gitignore

@@ -1,40 +1,40 @@
-# Python
-__pycache__/
-*.py[cod]
-*.egg-info/
-dist/
-build/
-*.egg
-
-# Virtual environment
-.venv/
-
-# Django
-*.sqlite3
-media/
-staticfiles/
-
-# Environment
-.env
-.env.local
-
-# IDE
-.idea/
-.vscode/
-*.swp
-*.swo
-
-# Node
-node_modules/
-
-# Local git worktrees
-.worktrees/
-/asf-doc/
-/asp-marketplace/
-
-# OS
-.DS_Store
-Thumbs.db
-
-.claude/*
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+*.egg
+
+# Virtual environment
+.venv/
+
+# Django
+*.sqlite3
+media/
+staticfiles/
+
+# Environment
+.env
+.env.local
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Node
+node_modules/
+
+# Local git worktrees
+.worktrees/
+#/asf-doc/
+#/asp-marketplace/
+
+# OS
+.DS_Store
+Thumbs.db
+
+.claude/*
 .asp/

{asp_cli-0.1.0 → asp_cli-0.5.0}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Agentic SOC Platform contributors
-
-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.
+MIT License
+
+Copyright (c) 2026 Agentic SOC Platform contributors
+
+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.

{asp_cli-0.1.0 → asp_cli-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asp-cli
-Version: 0.1.0
+Version: 0.5.0
 Summary: Command line client for Agentic SOC Platform
 Project-URL: Homepage, https://github.com/FunnyWolf/agentic-soc-platform
 Project-URL: Repository, https://github.com/FunnyWolf/agentic-soc-platform
@@ -47,8 +47,55 @@ asp doctor
 asp case list
 ```
 
-For automation and agent skills, prefer stable JSON output:
+`asp auth login` verifies the API URL and API key against the ASP server before writing local settings.
+
+For automation and skills, prefer stable JSON output:
 
 ```powershell
 asp case list --output json
 ```
+
+## Publish to PyPI
+
+The GitHub release workflow publishes `asp-cli` to PyPI automatically when a `v<version>` tag is pushed. The CLI package version does not include the leading `v` and must match the main release version, so update `version` in `pyproject.toml` before creating the tag.
+
+For example, release tag `v0.1.0` publishes PyPI version `0.1.0`.
+
+### Automatic publishing
+
+The workflow uses PyPI Trusted Publishing, so it does not need a PyPI API token in the repository or GitHub Secrets. Configure PyPI once with a trusted publisher:
+
+- PyPI project: `asp-cli`
+- Owner/repository: `FunnyWolf/agentic-soc-platform`
+- Workflow: `release.yml`
+- Environment: `pypi`
+
+If the PyPI project does not exist yet, add the same entry under PyPI's pending publishers before the first release.
+
+Release steps:
+
+```powershell
+# Update cli\pyproject.toml first, for example: version = "0.1.0"
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+### Manual fallback
+
+Manual publishing requires a PyPI API token. Keep it local and do not commit it:
+
+```powershell
+cd cli
+Remove-Item -Recurse -Force dist -ErrorAction SilentlyContinue
+uv build
+uvx twine check dist\*
+$env:UV_PUBLISH_TOKEN = "pypi-..."
+uv publish --token $env:UV_PUBLISH_TOKEN
+```
+
+After publishing, verify the package can be installed:
+
+```powershell
+pipx install --force asp-cli
+asp --version
+```

asp_cli-0.5.0/README.md

@@ -0,0 +1,72 @@
+# ASP CLI
+
+Command line client for Agentic SOC Platform.
+
+`asp-cli` provides the `asp` command for SOC analysts and automation agents to authenticate with an ASP server, inspect cases and alerts, add comments, upload files, run playbooks, and query investigation integrations.
+
+## Install
+
+```powershell
+pipx install asp-cli
+```
+
+## Quick start
+
+```powershell
+asp auth login --api-url https://asp.example.com --api-key asp_xxx
+asp doctor
+asp case list
+```
+
+`asp auth login` verifies the API URL and API key against the ASP server before writing local settings.
+
+For automation and skills, prefer stable JSON output:
+
+```powershell
+asp case list --output json
+```
+
+## Publish to PyPI
+
+The GitHub release workflow publishes `asp-cli` to PyPI automatically when a `v<version>` tag is pushed. The CLI package version does not include the leading `v` and must match the main release version, so update `version` in `pyproject.toml` before creating the tag.
+
+For example, release tag `v0.1.0` publishes PyPI version `0.1.0`.
+
+### Automatic publishing
+
+The workflow uses PyPI Trusted Publishing, so it does not need a PyPI API token in the repository or GitHub Secrets. Configure PyPI once with a trusted publisher:
+
+- PyPI project: `asp-cli`
+- Owner/repository: `FunnyWolf/agentic-soc-platform`
+- Workflow: `release.yml`
+- Environment: `pypi`
+
+If the PyPI project does not exist yet, add the same entry under PyPI's pending publishers before the first release.
+
+Release steps:
+
+```powershell
+# Update cli\pyproject.toml first, for example: version = "0.1.0"
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+### Manual fallback
+
+Manual publishing requires a PyPI API token. Keep it local and do not commit it:
+
+```powershell
+cd cli
+Remove-Item -Recurse -Force dist -ErrorAction SilentlyContinue
+uv build
+uvx twine check dist\*
+$env:UV_PUBLISH_TOKEN = "pypi-..."
+uv publish --token $env:UV_PUBLISH_TOKEN
+```
+
+After publishing, verify the package can be installed:
+
+```powershell
+pipx install --force asp-cli
+asp --version
+```

{asp_cli-0.1.0 → asp_cli-0.5.0}/pyproject.toml

@@ -1,48 +1,48 @@
-[project]
-name = "asp-cli"
-version = "0.1.0"
-description = "Command line client for Agentic SOC Platform"
-readme = "README.md"
-requires-python = ">=3.11"
-license = "MIT"
-authors = [
-    { name = "Agentic SOC Platform contributors" },
-]
-keywords = ["agentic-soc", "soc", "security", "cli"]
-classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Environment :: Console",
-    "Intended Audience :: Information Technology",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13",
-    "Topic :: Security",
-]
-dependencies = [
-    "httpx>=0.28.1",
-    "jmespath>=1.0.1",
-    "pydantic>=2.13.4",
-    "rich>=14.2.0",
-    "typer>=0.20.0",
-]
-
-[project.urls]
-Homepage = "https://github.com/FunnyWolf/agentic-soc-platform"
-Repository = "https://github.com/FunnyWolf/agentic-soc-platform"
-Issues = "https://github.com/FunnyWolf/agentic-soc-platform/issues"
-
-[project.scripts]
-asp = "asp_cli.main:run"
-
-[build-system]
-requires = ["hatchling>=1.28"]
-build-backend = "hatchling.build"
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/asp_cli"]
-
-[tool.hatch.build.targets.wheel.force-include]
-"src/asp_cli/spec/operations.json" = "asp_cli/spec/operations.json"
+[project]
+name = "asp-cli"
+version = "0.5.0"
+description = "Command line client for Agentic SOC Platform"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+authors = [
+    { name = "Agentic SOC Platform contributors" },
+]
+keywords = ["agentic-soc", "soc", "security", "cli"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Information Technology",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Security",
+]
+dependencies = [
+    "httpx>=0.28.1",
+    "jmespath>=1.0.1",
+    "pydantic>=2.13.4",
+    "rich>=14.2.0",
+    "typer>=0.20.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/FunnyWolf/agentic-soc-platform"
+Repository = "https://github.com/FunnyWolf/agentic-soc-platform"
+Issues = "https://github.com/FunnyWolf/agentic-soc-platform/issues"
+
+[project.scripts]
+asp = "asp_cli.main:run"
+
+[build-system]
+requires = ["hatchling>=1.28"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/asp_cli"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"src/asp_cli/spec/operations.json" = "asp_cli/spec/operations.json"

asp_cli-0.5.0/src/asp_cli/__init__.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+import tomllib
+from importlib.metadata import PackageNotFoundError, version
+from pathlib import Path
+
+
+def _source_version() -> str | None:
+    pyproject_path = Path(__file__).resolve().parents[2] / "pyproject.toml"
+    if not pyproject_path.exists():
+        return None
+
+    pyproject = tomllib.loads(pyproject_path.read_text(encoding="utf-8"))
+    project_version = pyproject.get("project", {}).get("version")
+    if not isinstance(project_version, str):
+        raise RuntimeError("Missing project.version in cli pyproject.toml")
+    return project_version
+
+
+try:
+    __version__ = _source_version() or version("asp-cli")
+except PackageNotFoundError as exc:
+    raise RuntimeError("Cannot resolve asp-cli package version") from exc

{asp_cli-0.1.0 → asp_cli-0.5.0}/src/asp_cli/api_client.py

@@ -1,118 +1,118 @@
-from __future__ import annotations
-
-import time
-from typing import Any
-
-import httpx
-from rich.console import Console
-
-from . import __version__
-from .config import redact_secret
-from .errors import (
-    CliError,
-    EXIT_AUTH,
-    EXIT_NETWORK,
-    EXIT_NOT_FOUND,
-    EXIT_PERMISSION,
-    EXIT_SERVER,
-    EXIT_USAGE,
-)
-
-
-class AspClient:
-    def __init__(
-        self,
-        *,
-        api_url: str,
-        api_key: str | None = None,
-        verbose: bool = False,
-        console: Console | None = None,
-        timeout: float = 20.0,
-    ) -> None:
-        self.base_url = _normalize_base_url(api_url)
-        self.api_key = api_key
-        self.verbose = verbose
-        self.console = console or Console(stderr=True)
-        self.timeout = timeout
-
-    def health(self) -> dict[str, Any]:
-        return self.request("GET", "/api/health/", authenticated=False)
-
-    def version(self) -> dict[str, Any]:
-        return self.request("GET", "/api/agent/v1/version/")
-
-    def request(self, method: str, path: str, *, authenticated: bool = True, json: Any = None, files: Any = None) -> dict[str, Any]:
-        if authenticated and not self.api_key:
-            raise CliError("missing_api_key", "API key is required", {}, EXIT_AUTH)
-
-        headers = {
-            "Accept": "application/json",
-            "User-Agent": f"asp-cli/{__version__}",
-        }
-        if authenticated and self.api_key:
-            headers["Authorization"] = f"Api-Key {self.api_key}"
-
-        url = f"{self.base_url}{path}"
-        started = time.perf_counter()
-        try:
-            response = httpx.request(method, url, headers=headers, json=json, files=files, timeout=self.timeout)
-        except httpx.HTTPError as exc:
-            raise CliError("network_error", f"Unable to reach ASP server: {exc}", {"url": _redact_url(url)}, EXIT_NETWORK) from exc
-
-        elapsed_ms = int((time.perf_counter() - started) * 1000)
-        if self.verbose:
-            self.console.print(f"{method} {path} -> {response.status_code} ({elapsed_ms}ms)", style="dim")
-
-        if response.status_code >= 400:
-            self._raise_http_error(response, path)
-
-        if not response.content:
-            return {}
-        try:
-            payload = response.json()
-        except ValueError as exc:
-            raise CliError("invalid_response", "Server returned non-JSON response", {"status_code": response.status_code}, EXIT_SERVER) from exc
-        if not isinstance(payload, dict):
-            raise CliError("invalid_response", "Server response must be a JSON object", {"status_code": response.status_code}, EXIT_SERVER)
-        return payload
-
-    def _raise_http_error(self, response: httpx.Response, path: str) -> None:
-        message = _response_message(response)
-        details = {"status_code": response.status_code, "path": path}
-        if response.status_code == 400:
-            raise CliError("bad_request", message, details, EXIT_USAGE)
-        if response.status_code == 401:
-            raise CliError("authentication_failed", message, details, EXIT_AUTH)
-        if response.status_code == 403:
-            raise CliError("permission_denied", message, details, EXIT_PERMISSION)
-        if response.status_code == 404:
-            raise CliError("not_found", message, details, EXIT_NOT_FOUND)
-        raise CliError("server_error", message, details, EXIT_SERVER)
-
-
-def _normalize_base_url(api_url: str) -> str:
-    base = api_url.strip().rstrip("/")
-    if base.endswith("/api"):
-        base = base[:-4]
-    if not base:
-        raise CliError("missing_api_url", "ASP API URL is required", {}, EXIT_USAGE)
-    return base
-
-
-def _response_message(response: httpx.Response) -> str:
-    try:
-        payload = response.json()
-    except ValueError:
-        return response.text.strip() or f"HTTP {response.status_code}"
-    if isinstance(payload, dict):
-        detail = payload.get("detail")
-        if isinstance(detail, str):
-            return detail
-        error = payload.get("error")
-        if isinstance(error, dict) and isinstance(error.get("message"), str):
-            return error["message"]
-    return f"HTTP {response.status_code}"
-
-
-def _redact_url(url: str) -> str:
-    return url.replace(redact_secret(url), "****") if "asp_" in url else url
+from __future__ import annotations
+
+import time
+from typing import Any
+
+import httpx
+from rich.console import Console
+
+from . import __version__
+from .config import redact_secret
+from .errors import (
+    CliError,
+    EXIT_AUTH,
+    EXIT_NETWORK,
+    EXIT_NOT_FOUND,
+    EXIT_PERMISSION,
+    EXIT_SERVER,
+    EXIT_USAGE,
+)
+
+
+class AspClient:
+    def __init__(
+        self,
+        *,
+        api_url: str,
+        api_key: str | None = None,
+        verbose: bool = False,
+        console: Console | None = None,
+        timeout: float = 20.0,
+    ) -> None:
+        self.base_url = _normalize_base_url(api_url)
+        self.api_key = api_key
+        self.verbose = verbose
+        self.console = console or Console(stderr=True)
+        self.timeout = timeout
+
+    def health(self) -> dict[str, Any]:
+        return self.request("GET", "/api/health/", authenticated=False)
+
+    def version(self) -> dict[str, Any]:
+        return self.request("GET", "/api/agent/v1/version/")
+
+    def request(self, method: str, path: str, *, authenticated: bool = True, json: Any = None, files: Any = None) -> dict[str, Any]:
+        if authenticated and not self.api_key:
+            raise CliError("missing_api_key", "API key is required", {}, EXIT_AUTH)
+
+        headers = {
+            "Accept": "application/json",
+            "User-Agent": f"asp-cli/{__version__}",
+        }
+        if authenticated and self.api_key:
+            headers["Authorization"] = f"Api-Key {self.api_key}"
+
+        url = f"{self.base_url}{path}"
+        started = time.perf_counter()
+        try:
+            response = httpx.request(method, url, headers=headers, json=json, files=files, timeout=self.timeout)
+        except httpx.HTTPError as exc:
+            raise CliError("network_error", f"Unable to reach ASP server: {exc}", {"url": _redact_url(url)}, EXIT_NETWORK) from exc
+
+        elapsed_ms = int((time.perf_counter() - started) * 1000)
+        if self.verbose:
+            self.console.print(f"{method} {path} -> {response.status_code} ({elapsed_ms}ms)", style="dim")
+
+        if response.status_code >= 400:
+            self._raise_http_error(response, path)
+
+        if not response.content:
+            return {}
+        try:
+            payload = response.json()
+        except ValueError as exc:
+            raise CliError("invalid_response", "Server returned non-JSON response", {"status_code": response.status_code}, EXIT_SERVER) from exc
+        if not isinstance(payload, dict):
+            raise CliError("invalid_response", "Server response must be a JSON object", {"status_code": response.status_code}, EXIT_SERVER)
+        return payload
+
+    def _raise_http_error(self, response: httpx.Response, path: str) -> None:
+        message = _response_message(response)
+        details = {"status_code": response.status_code, "path": path}
+        if response.status_code == 400:
+            raise CliError("bad_request", message, details, EXIT_USAGE)
+        if response.status_code == 401:
+            raise CliError("authentication_failed", message, details, EXIT_AUTH)
+        if response.status_code == 403:
+            raise CliError("permission_denied", message, details, EXIT_PERMISSION)
+        if response.status_code == 404:
+            raise CliError("not_found", message, details, EXIT_NOT_FOUND)
+        raise CliError("server_error", message, details, EXIT_SERVER)
+
+
+def _normalize_base_url(api_url: str) -> str:
+    base = api_url.strip().rstrip("/")
+    if base.endswith("/api"):
+        base = base[:-4]
+    if not base:
+        raise CliError("missing_api_url", "ASP API URL is required", {}, EXIT_USAGE)
+    return base
+
+
+def _response_message(response: httpx.Response) -> str:
+    try:
+        payload = response.json()
+    except ValueError:
+        return response.text.strip() or f"HTTP {response.status_code}"
+    if isinstance(payload, dict):
+        detail = payload.get("detail")
+        if isinstance(detail, str):
+            return detail
+        error = payload.get("error")
+        if isinstance(error, dict) and isinstance(error.get("message"), str):
+            return error["message"]
+    return f"HTTP {response.status_code}"
+
+
+def _redact_url(url: str) -> str:
+    return url.replace(redact_secret(url), "****") if "asp_" in url else url