apizit-cli 0.3.0__tar.gz → 0.4.0b1__tar.gz

{apizit_cli-0.3.0 → apizit_cli-0.4.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apizit-cli
-Version: 0.3.0
+Version: 0.4.0b1
 Summary: Launch supported Python, JavaScript, TypeScript or Java APIs from your terminal or CI.
 Author: APIZIT
 Classifier: Environment :: Console
@@ -21,19 +21,23 @@ Check a project, launch its analyzed source and get its live API URL from your t
 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):
+Python 3.12 or later is required. This guide covers prerelease 0.4.0b1.
+Install that exact version with pip (or py -m pip on Windows):
 
 ```sh
-python -m pip install apizit-cli
+python -m pip install apizit-cli==0.4.0b1
 apizit login
+apizit account setup
 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.
+Use `python -m pip install --upgrade apizit-cli==0.4.0b1` to update.
+`pipx install apizit-cli==0.4.0b1` is an isolated alternative. An unversioned install
+can select an older stable release. No AWS account, Docker or backend checkout is needed.
+Account setup asks for your public username and explicit choices after reviewing required documents.
 
 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.
@@ -43,6 +47,9 @@ Names and slugs resolve accessible resources only; ambiguous names need IDs.
 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.
+The short commands above assume the same project folder. Copy the complete `Next:`
+command after scanning an absolute path; its `--project-dir`, endpoint and workspace
+keep the scan context when you execute it from another directory.
 
 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.

{apizit_cli-0.3.0 → apizit_cli-0.4.0b1}/README.md

@@ -4,19 +4,23 @@ Check a project, launch its analyzed source and get its live API URL from your t
 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):
+Python 3.12 or later is required. This guide covers prerelease 0.4.0b1.
+Install that exact version with pip (or py -m pip on Windows):
 
 ```sh
-python -m pip install apizit-cli
+python -m pip install apizit-cli==0.4.0b1
 apizit login
+apizit account setup
 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.
+Use `python -m pip install --upgrade apizit-cli==0.4.0b1` to update.
+`pipx install apizit-cli==0.4.0b1` is an isolated alternative. An unversioned install
+can select an older stable release. No AWS account, Docker or backend checkout is needed.
+Account setup asks for your public username and explicit choices after reviewing required documents.
 
 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.
@@ -26,6 +30,9 @@ Names and slugs resolve accessible resources only; ambiguous names need IDs.
 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.
+The short commands above assume the same project folder. Copy the complete `Next:`
+command after scanning an absolute path; its `--project-dir`, endpoint and workspace
+keep the scan context when you execute it from another directory.
 
 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.

{apizit_cli-0.3.0 → apizit_cli-0.4.0b1}/pyproject.toml

@@ -1,34 +1,34 @@
-[build-system]
-requires = ["setuptools>=77"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "apizit-cli"
-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 = [
-    "Environment :: Console",
-    "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.12",
-]
-dependencies = [
-    "requests>=2.32.0,<3",
-    "pydantic>=2.12.5,<3",
-    "pyyaml>=6.0.3,<7",
-    "keyring>=25.7,<26",
-    "pathspec>=1,<2",
-]
-
-[project.scripts]
-apizit = "apizit_cli.main:main"
-
-[tool.setuptools.packages.find]
-where = ["src"]
-include = ["apizit_cli*"]
-
-[tool.setuptools.package-data]
-apizit_cli = ["data/*.json", "data/*.md", "data/*.yaml"]
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "apizit-cli"
+version = "0.4.0b1"
+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 = [
+    "Environment :: Console",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "requests>=2.32.0,<3",
+    "pydantic>=2.12.5,<3",
+    "pyyaml>=6.0.3,<7",
+    "keyring>=25.7,<26",
+    "pathspec>=1,<2",
+]
+
+[project.scripts]
+apizit = "apizit_cli.main:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["apizit_cli*"]
+
+[tool.setuptools.package-data]
+apizit_cli = ["data/*.json", "data/*.md", "data/*.yaml"]

{apizit_cli-0.3.0 → apizit_cli-0.4.0b1}/src/apizit_cli/__init__.py

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

apizit_cli-0.4.0b1/src/apizit_cli/account.py

@@ -0,0 +1,107 @@
+"""Account setup through the existing server-owned profile and acceptance contracts."""
+
+import re
+import sys
+
+from apizit_cli.errors import CliError, EXIT_USAGE
+from apizit_cli.presentation import safe_text
+
+
+def account_command(runner):
+    profile = runner.get("/account/profile", workspace=False)
+    if runner.args.command_path == "account show":
+        return profile
+    username = runner.args.username or profile.get("username")
+    if not username:
+        if runner.non_interactive:
+            raise CliError(
+                "Provide a public username: apizit account setup <username>.",
+                code="USERNAME_REQUIRED",
+                exit_code=EXIT_USAGE,
+            )
+        print("Public username: ", end="", file=sys.stderr, flush=True)
+        username = sys.stdin.readline().strip()
+    # Format, uniqueness and rename rules belong to the server, never to a second CLI model.
+    if profile.get("legal_acceptance_current") is True:
+        if username == profile.get("username"):
+            return {"profile": profile, "already_complete": True}
+        updated = runner.client.request(
+            "PUT",
+            "/account/profile",
+            workspace=False,
+            body={
+                "username": username,
+                "company_name": profile.get("company_name"),
+                "profession": profile.get("profession"),
+            },
+        )
+        return {"profile": updated}
+
+    requirements = profile.get("legal_requirements") or runner.get(
+        "/account/legal-requirements", workspace=False, authenticated=False
+    )
+    documents = requirements.get("documents")
+    if (
+        not isinstance(documents, list)
+        or not documents
+        or any(
+            not isinstance(doc, dict)
+            or not re.fullmatch(r"[a-z][a-z0-9_]{0,63}", str(doc.get("document_id", "")))
+            or not re.fullmatch(r"[a-zA-Z0-9.-]{1,64}", str(doc.get("version", "")))
+            or doc.get("choice") not in {"agreement", "acknowledgement"}
+            or not isinstance(doc.get("url"), str)
+            or not doc["url"].startswith("https://")
+            for doc in documents
+        )
+    ):
+        raise CliError(
+            "APIZIT returned invalid account document requirements.", code="INVALID_RESPONSE"
+        )
+    expected = {f"{doc['document_id']}={doc['version']}" for doc in documents}
+    selected = runner.args.accept_document or []
+    if selected and (set(selected) != expected or len(selected) != len(expected)):
+        raise CliError(
+            "Document choices do not match the current versions. Review account show before retrying.",
+            code="LEGAL_DOCUMENT_VERSION_CHANGED",
+            exit_code=EXIT_USAGE,
+        )
+    if not selected:
+        if runner.non_interactive:
+            raise CliError(
+                "Review the current documents with apizit account show. Then repeat account setup "
+                "with --accept-document DOCUMENT_ID=VERSION for each explicit choice.",
+                code="LEGAL_ACCEPTANCE_REQUIRED",
+                exit_code=EXIT_USAGE,
+                details={"required_documents": documents},
+            )
+        for doc in documents:
+            verb = "agree to" if doc["choice"] == "agreement" else "acknowledge"
+            print(
+                f"{safe_text(doc.get('title') or doc['document_id'])} "
+                f"(version {safe_text(doc['version'])}): {safe_text(doc['url'])}",
+                file=sys.stderr,
+            )
+            print(
+                f'After reviewing this document, type "yes" to {verb} it: ',
+                end="",
+                file=sys.stderr,
+                flush=True,
+            )
+            if sys.stdin.readline().strip() != "yes":
+                raise CliError(
+                    "Account setup was not submitted. No document choice was saved.",
+                    code="CONFIRMATION_DECLINED",
+                    exit_code=EXIT_USAGE,
+                )
+    return runner.client.request(
+        "POST",
+        "/account/onboarding",
+        workspace=False,
+        body={
+            "username": username,
+            "legal_acceptances": [
+                {"document_id": doc["document_id"], "version": doc["version"], "accepted": True}
+                for doc in documents
+            ],
+        },
+    )