apizit-cli 0.2.0b4__tar.gz → 0.3.0__tar.gz

apizit_cli-0.3.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: apizit-cli
+Version: 0.3.0
+Summary: Launch supported Python, JavaScript, TypeScript or Java APIs from your terminal or CI.
+Author: APIZIT
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: requests<3,>=2.32.0
+Requires-Dist: pydantic<3,>=2.12.5
+Requires-Dist: pyyaml<7,>=6.0.3
+Requires-Dist: keyring<26,>=25.7
+Requires-Dist: pathspec<2,>=1
+
+# APIZIT CLI
+
+Check a project, launch its analyzed source and get its live API URL from your terminal.
+Managed adapters cover Flask, FastAPI, Django, Express, NestJS and Spring Boot;
+APIZIT Linking provides declarative Python routes. Scan to confirm compatibility.
+
+Python 3.12 or later is required. Install with pip (or py -m pip on Windows):
+
+```sh
+python -m pip install apizit-cli
+apizit login
+apizit workspace use
+apizit scan .
+apizit deploy --from-scan latest
+apizit api show
+```
+
+Use `python -m pip install --upgrade apizit-cli` to update.
+`pipx install apizit-cli` is an isolated alternative. No AWS account, Docker or backend checkout is needed.
+
+The default view summarizes outcomes. `--verbose` adds technical details; `--json` preserves
+the complete versioned result and takes priority. Existing IDs and CI scripts remain supported.
+Names and slugs resolve accessible resources only; ambiguous names need IDs.
+`apizit api use "weather-api"` links an existing API without replacing another binding.
+
+Interactive operations save non-secret references in `.apizit/operations.json`, scoped by folder,
+endpoint and workspace. `latest` resumes the recorded operation. `deploy --from-scan latest`
+reuses the exact scanned snapshot, excluding later edits. `deploy .` uploads current bytes.
+
+APIZIT remains prelaunch. The default endpoint is `https://api.apizit.com/v1` (protected main domain).
+For TEST, pass `--endpoint https://api-test.apizit.com/v1` or set `APIZIT_API_URL` on every command.
+Sessions stay separate by endpoint. Configuration keeps its strict version 2 schema.
+
+Run `apizit --help` or `apizit docs`. CI and AI agents use `--json --non-interactive` with
+explicit IDs, stable idempotency keys and an expiring token. Store secrets in the workspace vault.

apizit_cli-0.3.0/README.md

@@ -0,0 +1,35 @@
+# APIZIT CLI
+
+Check a project, launch its analyzed source and get its live API URL from your terminal.
+Managed adapters cover Flask, FastAPI, Django, Express, NestJS and Spring Boot;
+APIZIT Linking provides declarative Python routes. Scan to confirm compatibility.
+
+Python 3.12 or later is required. Install with pip (or py -m pip on Windows):
+
+```sh
+python -m pip install apizit-cli
+apizit login
+apizit workspace use
+apizit scan .
+apizit deploy --from-scan latest
+apizit api show
+```
+
+Use `python -m pip install --upgrade apizit-cli` to update.
+`pipx install apizit-cli` is an isolated alternative. No AWS account, Docker or backend checkout is needed.
+
+The default view summarizes outcomes. `--verbose` adds technical details; `--json` preserves
+the complete versioned result and takes priority. Existing IDs and CI scripts remain supported.
+Names and slugs resolve accessible resources only; ambiguous names need IDs.
+`apizit api use "weather-api"` links an existing API without replacing another binding.
+
+Interactive operations save non-secret references in `.apizit/operations.json`, scoped by folder,
+endpoint and workspace. `latest` resumes the recorded operation. `deploy --from-scan latest`
+reuses the exact scanned snapshot, excluding later edits. `deploy .` uploads current bytes.
+
+APIZIT remains prelaunch. The default endpoint is `https://api.apizit.com/v1` (protected main domain).
+For TEST, pass `--endpoint https://api-test.apizit.com/v1` or set `APIZIT_API_URL` on every command.
+Sessions stay separate by endpoint. Configuration keeps its strict version 2 schema.
+
+Run `apizit --help` or `apizit docs`. CI and AI agents use `--json --non-interactive` with
+explicit IDs, stable idempotency keys and an expiring token. Store secrets in the workspace vault.

{apizit_cli-0.2.0b4 → apizit_cli-0.3.0}/pyproject.toml

@@ -4,13 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "apizit-cli"
-version = "0.2.0b4"
+version = "0.3.0"
 description = "Launch supported Python, JavaScript, TypeScript or Java APIs from your terminal or CI."
 readme = "README.md"
 requires-python = ">=3.12"
 authors = [{name = "APIZIT"}]
 classifiers = [
-    "Development Status :: 4 - Beta",
     "Environment :: Console",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",

{apizit_cli-0.2.0b4 → apizit_cli-0.3.0}/src/apizit_cli/__init__.py

@@ -1,3 +1,3 @@
 """The APIZIT HTTP client. Importing this package never initializes a session."""
 
-__version__ = "0.2.0b4"
+__version__ = "0.3.0"

{apizit_cli-0.2.0b4 → apizit_cli-0.3.0}/src/apizit_cli/commands.py

@@ -33,8 +33,13 @@ def flag(name, help, **kwargs):
 
 GLOBAL_OPTIONS = (
     flag("--json", "Write one versioned JSON result to stdout.", action="store_true"),
-    flag("--workspace", "Workspace ID; overrides environment and saved context."),
-    flag("--endpoint", "APIZIT HTTPS endpoint; defaults to the development beta."),
+    flag(
+        "--verbose",
+        "Include readable technical details; --json takes priority.",
+        action="store_true",
+    ),
+    flag("--workspace", "Exact workspace name, slug or ID; overrides saved context."),
+    flag("--endpoint", "APIZIT HTTPS endpoint; use api-test.apizit.com/v1 for TEST."),
     flag("--non-interactive", "Never prompt or open a browser.", action="store_true"),
     flag("--token-stdin", "Read a CI token from stdin without saving it.", action="store_true"),
 )
@@ -53,7 +58,7 @@ FORMAT = flag(
     "--format", "Launch format.", choices=("automatic", "standard", "expanded", "max_power")
 )
 REGION = flag("--region", "Logical region, as returned by apizit regions.")
-API = flag("--api", "API ID; defaults to the API linked to this local project.")
+API = flag("--api", "Exact API name, slug or ID; defaults to the API linked to this folder.")
 REF = flag("--ref", "Git branch, tag or exact revision to verify on the server.")
 SOURCE = argument("source", "HTTPS Git URL or local folder.", optional=True)
 SCAN_OPTIONS = (REF, FORMAT, REGION) + WAIT_OPTIONS + WRITE_OPTIONS
@@ -72,7 +77,13 @@ COMMANDS = (
         "workspace use",
         "Select and verify a workspace.",
         "read",
-        (argument("id", "Workspace ID."),),
+        (
+            argument(
+                "id",
+                "Exact workspace name, slug or ID; otherwise select interactively.",
+                optional=True,
+            ),
+        ),
     ),
     Command("workspace show", "Show the selected workspace and its current capabilities.", "read"),
     Command(
@@ -138,6 +149,16 @@ COMMANDS = (
         "apizit deploy . --wait",
     ),
     Command("api list", "List APIs in the workspace.", "read"),
+    Command(
+        "api use",
+        "Link an accessible API to this folder without replacing an existing link.",
+        "read",
+        (
+            argument(
+                "id", "Exact API name, slug or ID; otherwise select interactively.", optional=True
+            ),
+        ),
+    ),
     Command(
         "api show",
         "Show an API, its live URL and releases.",
@@ -283,42 +304,43 @@ COMMANDS = (
 _EXAMPLES = {
     "login": "apizit login",
     "logout": "apizit logout",
-    "whoami": "apizit whoami --json",
-    "workspace list": "apizit workspace list --json",
-    "workspace use": "apizit workspace use ws_YOUR_WORKSPACE",
-    "workspace show": "apizit workspace show --json",
+    "whoami": "apizit whoami",
+    "workspace list": "apizit workspace list",
+    "workspace use": "apizit workspace use",
+    "api use": 'apizit api use "weather-api"',
+    "workspace show": "apizit workspace show",
     "workspace create": 'apizit workspace create "Weather APIs"',
     "init": "apizit init . --name weather-api",
-    "config validate": "apizit config validate . --json",
-    "config show": "apizit config show . --region europe --json",
-    "config schema": "apizit config schema --json",
-    "api list": "apizit api list --json",
-    "api show": "apizit api show api_YOUR_API --json",
-    "api logs": "apizit api logs api_YOUR_API --level error --limit 50 --json",
-    "api usage": "apizit api usage api_YOUR_API --json",
-    "api openapi": "apizit api openapi api_YOUR_API --output openapi.json",
-    "api key": "apizit api key api_YOUR_API --json",
-    "api delete": "apizit api delete api_YOUR_API --yes --wait --json",
-    "release list": "apizit release list --api api_YOUR_API --json",
-    "release show": "apizit release show dep_YOUR_RELEASE --json",
-    "release promote": "apizit release promote dep_YOUR_CANDIDATE --api api_YOUR_API --idempotency-key promote-release-001 --yes --json",
-    "release rollback": "apizit release rollback --api api_YOUR_API --idempotency-key rollback-release-001 --yes --json",
-    "release discard": "apizit release discard dep_YOUR_OLD_RELEASE --yes --wait --json",
-    "job show": "apizit job show job_YOUR_JOB --json",
-    "job wait": "apizit job wait job_YOUR_JOB --timeout 900 --json",
-    "job cancel": "apizit job cancel job_YOUR_JOB --yes --json",
-    "regions": "apizit regions --format standard --json",
-    "plans": "apizit plans --json",
-    "usage": "apizit usage --json",
-    "capabilities": "apizit capabilities --json",
+    "config validate": "apizit config validate .",
+    "config show": "apizit config show . --region europe",
+    "config schema": "apizit config schema",
+    "api list": "apizit api list",
+    "api show": "apizit api show",
+    "api logs": "apizit api logs --level error --limit 50",
+    "api usage": "apizit api usage",
+    "api openapi": "apizit api openapi --output openapi.json",
+    "api key": "apizit api key",
+    "api delete": 'apizit api delete "weather-api" --wait',
+    "release list": "apizit release list --verbose",
+    "release show": "apizit release show dep_YOUR_RELEASE",
+    "release promote": "apizit release promote dep_YOUR_CANDIDATE --idempotency-key promote-release-001 --yes",
+    "release rollback": "apizit release rollback --idempotency-key rollback-release-001 --yes",
+    "release discard": "apizit release discard dep_YOUR_OLD_RELEASE --yes --wait",
+    "job show": "apizit job show latest",
+    "job wait": "apizit job wait latest --timeout 900",
+    "job cancel": "apizit job cancel job_YOUR_JOB --yes",
+    "regions": "apizit regions --format standard",
+    "plans": "apizit plans",
+    "usage": "apizit usage",
+    "capabilities": "apizit capabilities",
     "token create": 'apizit token create "Release CI" --scope read --scope scan --scope deploy --expires-days 30',
-    "token list": "apizit token list --json",
+    "token list": "apizit token list",
     "token revoke": "apizit token revoke YOUR_TOKEN_ID --yes",
     "secret set": "apizit secret set weather_api_key --from-env WEATHER_API_KEY",
-    "secret list": "apizit secret list --json",
+    "secret list": "apizit secret list",
     "secret delete": "apizit secret delete weather_api_key --yes",
     "docs": 'apizit docs "release promote"',
-    "doctor": "apizit doctor --json",
+    "doctor": "apizit doctor",
 }
 COMMANDS = tuple(
     replace(command, example=command.example or _EXAMPLES[command.path]) for command in COMMANDS

{apizit_cli-0.2.0b4 → apizit_cli-0.3.0}/src/apizit_cli/context.py

@@ -93,6 +93,7 @@ class ClientContext:
         self.root = Path(root or Path.cwd()).resolve()
         self.path = home_directory() / "context.json"
         self.project_path = self.root / ".apizit" / "project.json"
+        self.operations_path = self.root / ".apizit" / "operations.json"
         self.preferences = read_json(self.path)
         self.project = read_json(self.project_path)
         self.origin = normalize_origin(
@@ -138,6 +139,83 @@ class ClientContext:
         write_json(self.path, self.preferences)
         self.workspace_id = workspace_id
 
+    def record_operation(self, kind, resource_id, *, source_kind=None, snapshot_id=None):
+        """Only selected non-secret references, scoped to this directory and endpoint."""
+        import re
+
+        if kind not in {"scan", "job"} or not re.fullmatch(
+            rf"{kind}_[A-Za-z0-9_-]{{1,128}}", resource_id
+        ):
+            raise CliError("Invalid operation reference.", code="INVALID_RESPONSE")
+        if kind == "scan" and (
+            source_kind not in {"local", "git"}
+            or (
+                snapshot_id is not None
+                and (
+                    not isinstance(snapshot_id, str)
+                    or not re.fullmatch(r"src_[A-Za-z0-9_-]{1,128}", snapshot_id)
+                )
+            )
+        ):
+            raise CliError("Invalid source reference.", code="INVALID_RESPONSE")
+        state = read_json(self.operations_path)
+        if state and state.get("schema_version") != 1:
+            raise CliError(
+                "Unsupported operations context.", code="CONTEXT_INVALID", exit_code=EXIT_USAGE
+            )
+        state.setdefault("schema_version", 1)
+        endpoints = state.setdefault("endpoints", {})
+        if not isinstance(endpoints, dict):
+            raise CliError(
+                "Invalid operations context.", code="CONTEXT_INVALID", exit_code=EXIT_USAGE
+            )
+        workspaces = endpoints.setdefault(self.origin, {})
+        if not isinstance(workspaces, dict):
+            raise CliError(
+                "Invalid operations context.", code="CONTEXT_INVALID", exit_code=EXIT_USAGE
+            )
+        scope = workspaces.setdefault(self.require_workspace(), {})
+        if not isinstance(scope, dict):
+            raise CliError(
+                "Invalid operations context.", code="CONTEXT_INVALID", exit_code=EXIT_USAGE
+            )
+        scope[kind] = {"id": resource_id}
+        if kind == "scan":
+            scope[kind].update(source_kind=source_kind, source_snapshot_id=snapshot_id)
+        write_json(self.operations_path, state)
+        self.ignore_context()
+
+    def latest_operation(self, kind):
+        import re
+
+        state = read_json(self.operations_path)
+        try:
+            value = state["endpoints"][self.origin][self.require_workspace()][kind]
+            valid = (
+                state["schema_version"] == 1
+                and isinstance(value, dict)
+                and re.fullmatch(rf"{kind}_[A-Za-z0-9_-]{{1,128}}", value.get("id", ""))
+            )
+        except (KeyError, TypeError, AttributeError):
+            valid = False
+        if not valid:
+            raise CliError(
+                f"No latest {kind} is recorded for this folder, endpoint and workspace. Use an explicit ID or start an interactive operation here.",
+                code="LATEST_NOT_FOUND",
+                exit_code=EXIT_USAGE,
+            )
+        return value
+
+    def ignore_context(self):
+        ignore = self.root / ".gitignore"
+        assert_safe_path(ignore)
+        previous = ignore.read_text(encoding="utf-8") if ignore.exists() else ""
+        if "/.apizit/" not in previous.splitlines():
+            with ignore.open("a", encoding="utf-8") as stream:
+                stream.write(
+                    ("\n" if previous and not previous.endswith("\n") else "") + "/.apizit/\n"
+                )
+
     def bind_api(self, api_id):
         ignore = self.root / ".gitignore"
         assert_safe_path(ignore)

{apizit_cli-0.2.0b4 → apizit_cli-0.3.0}/src/apizit_cli/main.py

@@ -53,7 +53,7 @@ def build_parser():
         prog="apizit",
         description=(
             "Launch supported Python, JavaScript, TypeScript or Java projects as managed public "
-            "APIs. Framework support follows the APIZIT compatibility guide. APIZIT prelaunch beta."
+            "APIs. Framework support follows the APIZIT compatibility guide. APIZIT is prelaunch."
         ),
         epilog=(
             "Managed frameworks: Flask, FastAPI, Django, Express, NestJS and Spring Boot. "
@@ -113,10 +113,12 @@ def main(argv=None):
     json_mode = "--json" in argv
     runner = None
     command = None
+    verbose = False
     exit_code = 0
     try:
         args = build_parser().parse_args(argv)
         json_mode = bool(getattr(args, "json", False))
+        verbose = bool(getattr(args, "verbose", False))
         command = args.command_path
         from apizit_cli.operations import CommandRunner
 
@@ -161,10 +163,21 @@ def main(argv=None):
     if json_mode:
         print(json.dumps(result, ensure_ascii=True, separators=(",", ":")))
     elif result["ok"]:
-        # JSON quoting prevents untrusted API names or logs from executing terminal escapes.
-        print(json.dumps(result["data"], ensure_ascii=True, indent=2))
+        from apizit_cli.presentation import render_success
+
+        print(
+            render_success(
+                command,
+                result["data"],
+                verbose=verbose,
+                latest=getattr(runner, "recorded_scan", False)
+                or getattr(runner, "recorded_job", False),
+            )
+        )
     else:
-        print(json.dumps(result["error"], ensure_ascii=True, indent=2), file=sys.stderr)
+        from apizit_cli.presentation import render_error
+
+        print(render_error(result["error"], verbose=verbose), file=sys.stderr)
     return exit_code