codepraxis 0.3.2__tar.gz → 0.3.3__tar.gz

{codepraxis-0.3.2 → codepraxis-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codepraxis
-Version: 0.3.2
+Version: 0.3.3
 Summary: Author and validate CodePraxis challenge packs.
 Project-URL: Documentation, https://docs.codepraxis.com/authoring
 Author: CodePraxis
@@ -37,6 +37,7 @@ codepraxis --login
 codepraxis --publish my-challenge            # validates in the runner, then publishes
 codepraxis --list                            # list company questions
 codepraxis --edit 123 --open                 # update metadata/open a preview container
+codepraxis --publish my-challenge --challenge-id 123   # publish an edit, not a duplicate
 ```
 
 ## What this is
@@ -214,6 +215,31 @@ codepraxis --edit 123 --open
 
 `--list` shows the questions owned by your API key's company, including drafts.
 `--edit` updates question metadata and returns a container URL for inspection.
+
+### Publishing an edit
+
+Changing the *content* of a question means re-publishing the pack. Pass the
+question's id, or you get a second copy:
+
+```bash
+codepraxis --publish my-challenge --challenge-id 123
+```
+
+With `--challenge-id` the platform adds a new version to that question and
+keeps its id, assignments and history. Without it, publish always creates a
+new question — which is the right behaviour the first time and a duplicate
+every time after.
+
+### Deleting
+
+```bash
+codepraxis --delete 123
+```
+
+Asks first, and the platform refuses outright once the question has been
+assigned to anyone — deleting it then would orphan attempts and reports that
+candidates and reviewers still depend on. To take an assigned question out of
+circulation, set it back to draft with `--edit 123 --status draft`.
 Code changes still go through the pack workflow: edit locally, validate, and
 publish a new version.
 

{codepraxis-0.3.2 → codepraxis-0.3.3}/README.md

@@ -12,6 +12,7 @@ codepraxis --login
 codepraxis --publish my-challenge            # validates in the runner, then publishes
 codepraxis --list                            # list company questions
 codepraxis --edit 123 --open                 # update metadata/open a preview container
+codepraxis --publish my-challenge --challenge-id 123   # publish an edit, not a duplicate
 ```
 
 ## What this is
@@ -189,6 +190,31 @@ codepraxis --edit 123 --open
 
 `--list` shows the questions owned by your API key's company, including drafts.
 `--edit` updates question metadata and returns a container URL for inspection.
+
+### Publishing an edit
+
+Changing the *content* of a question means re-publishing the pack. Pass the
+question's id, or you get a second copy:
+
+```bash
+codepraxis --publish my-challenge --challenge-id 123
+```
+
+With `--challenge-id` the platform adds a new version to that question and
+keeps its id, assignments and history. Without it, publish always creates a
+new question — which is the right behaviour the first time and a duplicate
+every time after.
+
+### Deleting
+
+```bash
+codepraxis --delete 123
+```
+
+Asks first, and the platform refuses outright once the question has been
+assigned to anyone — deleting it then would orphan attempts and reports that
+candidates and reviewers still depend on. To take an assigned question out of
+circulation, set it back to draft with `--edit 123 --status draft`.
 Code changes still go through the pack workflow: edit locally, validate, and
 publish a new version.
 

{codepraxis-0.3.2 → codepraxis-0.3.3}/src/codepraxis/__init__.py

@@ -1,3 +1,3 @@
 """Author and validate CodePraxis challenge packs."""
 
-__version__ = "0.3.2"
+__version__ = "0.3.3"

{codepraxis-0.3.2 → codepraxis-0.3.3}/src/codepraxis/cli.py

@@ -71,6 +71,12 @@ def build_parser() -> argparse.ArgumentParser:
         metavar="CHALLENGE_ID",
         help="Edit question metadata and open its container preview.",
     )
+    actions.add_argument(
+        "--delete",
+        type=int,
+        metavar="CHALLENGE_ID",
+        help="Delete a question your company owns. Refused once it has been assigned.",
+    )
     actions.add_argument(
         "--install",
         choices=INSTALLABLES,
@@ -96,6 +102,14 @@ def build_parser() -> argparse.ArgumentParser:
         action="store_true",
         help="With --publish, publish straight to candidates instead of as a draft.",
     )
+    parser.add_argument(
+        "--challenge-id",
+        type=int,
+        help=(
+            "With --publish, publish a new version of this existing question "
+            "instead of creating another one. Get the id from --list."
+        ),
+    )
     parser.add_argument(
         "--validation-run-id",
         help="With --publish, reuse a passing validation run instead of running a new one.",
@@ -316,6 +330,7 @@ def main(argv: list[str] | None = None) -> int:
                 assume_yes=args.yes,
                 live=args.live,
                 validation_run_id=args.validation_run_id,
+                challenge_id=args.challenge_id,
             )
         if args.list:
             return catalog_command.list_questions(as_json=args.json)
@@ -325,6 +340,8 @@ def main(argv: list[str] | None = None) -> int:
                 updates=_edit_updates(args),
                 open_browser=args.open_browser,
             )
+        if args.delete is not None:
+            return catalog_command.delete_question(args.delete, assume_yes=args.yes)
         if args.install:
             return _handle_install(args.install, args.force)
         if args.example:

{codepraxis-0.3.2 → codepraxis-0.3.3}/src/codepraxis/commands/catalog.py

@@ -11,6 +11,7 @@ from ..execution.remote.client import ApiClient
 from ..execution.remote.config import RemoteConfig
 
 EXIT_OK = 0
+EXIT_ABORTED = 2
 
 
 def list_questions(client: ApiClient | None = None, as_json: bool = False) -> int:
@@ -79,3 +80,35 @@ def _print_challenge(challenge: dict[str, Any]) -> None:
     if updated:
         line += f"\t{updated}"
     print(line)
+
+
+def delete_question(
+    challenge_id: int,
+    client: ApiClient | None = None,
+    assume_yes: bool = False,
+) -> int:
+    """Delete a question the company owns.
+
+    Confirmed by default: unlike a draft, this is not recoverable from the
+    dashboard. The platform refuses outright once the question has been assigned
+    to anyone, so the destructive case this guards is an unassigned question the
+    author still wanted.
+    """
+    import sys
+
+    client = client or ApiClient(RemoteConfig.resolve())
+
+    if not assume_yes:
+        if not sys.stdin.isatty():
+            raise PraxisError(
+                "Deleting needs confirmation, but stdin is not a terminal. Pass --yes."
+            )
+        print(f"Permanently delete question {challenge_id}? This cannot be undone.")
+        if input("Continue? [y/N] ").strip().lower() not in {"y", "yes"}:
+            print("Aborted.", file=sys.stderr)
+            return EXIT_ABORTED
+
+    payload = client.delete(f"/challenges/{challenge_id}")
+    removed = payload.get("versions_removed", 0)
+    print(f"Deleted question {challenge_id} ({removed} version(s) removed).")
+    return EXIT_OK

{codepraxis-0.3.2 → codepraxis-0.3.3}/src/codepraxis/commands/publish.py

@@ -40,6 +40,7 @@ def run(
     assume_yes: bool = False,
     live: bool = False,
     validation_run_id: str | None = None,
+    challenge_id: int | None = None,
     client: ApiClient | None = None,
 ) -> int:
     if not selector:
@@ -68,29 +69,36 @@ def run(
         run_id = _validate(pack, client, reporter)
 
     company = _company_name(client, config)
-    if not _confirm(pack.name, company, live, assume_yes):
+    if not _confirm(pack.name, company, live, assume_yes, challenge_id):
         print("Aborted.", file=sys.stderr)
         return EXIT_ABORTED
 
-    payload = client.post_json(
-        "/challenges",
-        {
-            # No company_id: the server derives ownership from the API key.
-            "name": pack.name,
-            "validation_run_id": run_id,
-            "status": "published" if live else "draft",
-        },
-    )
+    body = {
+        # No company_id: the server derives ownership from the API key.
+        "name": pack.name,
+        "validation_run_id": run_id,
+        "status": "published" if live else "draft",
+    }
+    # With an id, this publishes a new version of an existing question. Without
+    # one the platform creates a new question — which is why editing a pack and
+    # re-publishing used to leave a duplicate behind.
+    if challenge_id is not None:
+        body["challenge_id"] = challenge_id
+
+    payload = client.post_json("/challenges", body)
 
     challenge_id = payload.get("challenge_id")
     version_id = payload.get("challenge_version_id")
     container_url = payload.get("container_url")
     preview_error = payload.get("preview_error")
     state = "published" if live else "draft"
+    created = payload.get("created", True)
 
-    print(f"{pack.name} {state} for {company}")
+    verb = "published" if created else "updated"
+    print(f"{pack.name} {verb} for {company} ({state})")
     if challenge_id:
-        print(f"  challenge {challenge_id}, version {version_id}")
+        label = "challenge" if created else "challenge (new version of)"
+        print(f"  {label} {challenge_id}, version {version_id}")
     if container_url:
         print(f"  {container_url}")
     elif preview_error:
@@ -129,7 +137,7 @@ def _company_name(client: ApiClient, config: RemoteConfig | None) -> str:
     return company.get("name") or cached or "your company"
 
 
-def _confirm(pack_name: str, company: str, live: bool, assume_yes: bool) -> bool:
+def _confirm(pack_name: str, company: str, live: bool, assume_yes: bool, challenge_id: int | None = None) -> bool:
     if assume_yes:
         return True
     if not sys.stdin.isatty():
@@ -138,5 +146,6 @@ def _confirm(pack_name: str, company: str, live: bool, assume_yes: bool) -> bool
             "Pass --yes to publish non-interactively (CI)."
         )
     visibility = "LIVE to candidates" if live else "as a draft"
-    print(f"\nAbout to publish {pack_name} to {company}, {visibility}.")
+    target = f"as a new version of question {challenge_id}" if challenge_id else "as a new question"
+    print(f"\nAbout to publish {pack_name} to {company} {target}, {visibility}.")
     return input("Continue? [y/N] ").strip().lower() in {"y", "yes"}

{codepraxis-0.3.2 → codepraxis-0.3.3}/src/codepraxis/execution/remote/client.py

@@ -125,6 +125,9 @@ class ApiClient:
             content_type="application/json",
         )
 
+    def delete(self, path: str) -> dict[str, Any]:
+        return self.request("DELETE", path)
+
     def post_bytes(self, path: str, blob: bytes) -> dict[str, Any]:
         return self.request("POST", path, body=blob, content_type="application/zip")
 

{codepraxis-0.3.2 → codepraxis-0.3.3}/tests/test_publish.py

@@ -227,3 +227,93 @@ def test_prints_container_url_when_platform_returns_one(tmp_path: Path, capsys):
     )
 
     assert "https://container.example" in capsys.readouterr().out
+
+
+class TestRepublishingAnEdit:
+    """Editing a pack and publishing again must update, not duplicate.
+
+    Without a challenge_id the platform creates a new question every time, which
+    is how a typo fix used to leave two copies in the catalog.
+    """
+
+    def test_challenge_id_is_sent_when_given(self, tmp_path):
+        build_pack(tmp_path)
+        client = FakeClient()
+
+        publish.run(
+            root=tmp_path,
+            selector="demo",
+            reporter=NullReporter(),
+            assume_yes=True,
+            validation_run_id="vr_1",
+            challenge_id=64,
+            client=client,
+        )
+
+        assert client.posted[0][1]["challenge_id"] == 64
+
+    def test_no_challenge_id_means_create(self, tmp_path):
+        build_pack(tmp_path)
+        client = FakeClient()
+
+        publish.run(
+            root=tmp_path,
+            selector="demo",
+            reporter=NullReporter(),
+            assume_yes=True,
+            validation_run_id="vr_1",
+            client=client,
+        )
+
+        assert "challenge_id" not in client.posted[0][1]
+
+    def test_output_says_updated_when_the_platform_reused_a_question(self, tmp_path, capsys):
+        build_pack(tmp_path)
+        client = FakeClient()
+        client.post_json = lambda path, payload: {
+            "challenge_id": 64,
+            "challenge_version_id": 91,
+            "created": False,
+        }
+
+        publish.run(
+            root=tmp_path,
+            selector="demo",
+            reporter=NullReporter(),
+            assume_yes=True,
+            validation_run_id="vr_1",
+            challenge_id=64,
+            client=client,
+        )
+
+        output = capsys.readouterr().out
+        assert "updated" in output
+        assert "published for" not in output
+
+
+class TestDelete:
+    class Client:
+        def __init__(self, payload=None):
+            self.deleted = []
+            self.payload = payload or {"challenge_id": 7, "versions_removed": 2}
+
+        def delete(self, path):
+            self.deleted.append(path)
+            return self.payload
+
+    def test_deletes_after_confirmation_is_waived(self, capsys):
+        from codepraxis.commands import catalog
+
+        client = self.Client()
+        assert catalog.delete_question(7, client=client, assume_yes=True) == 0
+        assert client.deleted == ["/challenges/7"]
+        assert "Deleted question 7" in capsys.readouterr().out
+
+    def test_refuses_without_a_terminal_and_without_yes(self):
+        from codepraxis.commands import catalog
+        from codepraxis.errors import PraxisError
+
+        client = self.Client()
+        with pytest.raises(PraxisError, match="not a terminal"):
+            catalog.delete_question(7, client=client)
+        assert client.deleted == []