annotide 0.1.0__tar.gz

annotide-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

annotide-0.1.0/NOTICE

@@ -0,0 +1,7 @@
+Annotide Python SDK, CLI and MCP server
+Copyright 2026 R Squared Data Solutions (https://annotide.com)
+
+Licensed under the Apache License, Version 2.0 (see LICENSE). The Annotide
+server this SDK talks to is licensed separately, under the Elastic License
+2.0. "Annotide" is a trademark of R Squared Data Solutions; the Apache
+License grants no rights to it (section 6).

annotide-0.1.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: annotide
+Version: 0.1.0
+Summary: Cloud-agnostic annotation platform — Python SDK and CLI (API-3)
+License-Expression: Apache-2.0
+Requires-Python: >=3.12
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: httpx>=0.27
+Provides-Extra: mcp
+Requires-Dist: mcp<3,>=2.2; extra == "mcp"
+Provides-Extra: dev
+Requires-Dist: mcp<3,>=2.2; extra == "dev"
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: mypy>=1.13; extra == "dev"
+Requires-Dist: datamodel-code-generator>=0.83; extra == "dev"
+Dynamic: license-file

annotide-0.1.0/README.md

@@ -0,0 +1,108 @@
+# annotide
+
+Python SDK and command line for the Annotide API (API-3). One
+runtime dependency (`httpx`); responses are plain dicts typed with
+`TypedDict`s generated from the API's OpenAPI document.
+
+```sh
+pip install -e sdk            # from a checkout; not on a package index yet
+export ANNOTIDE_URL=https://annotate.example.com
+export ANNOTIDE_API_KEY=... # Settings → API keys; use a service account for CI
+```
+
+## Python
+
+```python
+from annotide import Client, JobFailedError
+
+with Client() as client:  # reads ANNOTIDE_URL / ANNOTIDE_API_KEY
+    project = next(p for p in client.list_projects() if p["name"] == "Cars")
+
+    # Freeze the dataset, then export it reproducibly.
+    snapshot = client.take_snapshot(
+        project["id"],
+        "2026-q3",
+        split={"train": 0.8, "val": 0.1, "test": 0.1, "seed": 0, "group_by": "folder"},
+    )
+    client.export(project["id"], "coco", "train.zip", snapshot_id=snapshot["id"], split="train")
+
+    # Import existing labels; a dry run reports what would happen.
+    report = client.import_file(project["id"], "labels.json", "coco", dry_run=True)
+    print(report["result"])
+```
+
+- Errors are `ApiError` (`status`, `title`, `detail` from the RFC 9457
+  body); a job that ends `failed`/`cancelled` raises `JobFailedError`, one
+  that outlives its `timeout` raises `JobTimeoutError`.
+- A 429 waits for `Retry-After` and repeats. Gateway errors (502/503/504)
+  repeat only when that is harmless: reads, and creates, which always carry
+  an `Idempotency-Key` so a repeat answers the first row.
+- Export downloads go straight to storage with the signed URL; the API key
+  is never sent there.
+- `client.request(method, path, ...)` reaches any endpoint without a method.
+
+## Command line
+
+```sh
+annotide whoami
+annotide projects list | jq -r '.name'
+annotide snapshots create <project> 2026-q3 --split 0.8,0.1,0.1 --group-by folder
+annotide export <project> --format coco --snapshot <id> --split train -o train.zip
+annotide import <project> labels.json --format coco --class-map '{"auto": "car"}' --dry-run
+annotide jobs wait <job>
+```
+
+Lists print as JSON Lines, single objects as JSON; errors go to stderr with
+exit status 1. The key is read from `ANNOTIDE_API_KEY` only, so it never
+lands in shell history.
+
+## MCP server for AI agents (API-8)
+
+`annotide mcp` serves the [Model Context Protocol](https://modelcontextprotocol.io)
+over stdio, so an AI agent (Claude Code, Claude Desktop, or any MCP client)
+can pre-label a project. It calls the REST API with an API key, so the agent
+can do exactly what that account may do. It can list projects and their label
+schema, view items (images come back as images), read annotations, claim and
+release tasks, and post pre-labels. It cannot submit, review, delete or
+export.
+
+Setup, once per agent:
+
+1. **Service account.** Settings → API keys → Service accounts: create one,
+   mint a `write` key, and add the account to the project as an annotator.
+2. **Model.** Models → Register model, name it after the agent, and leave
+   the endpoint empty. That makes it an *external producer*: the platform
+   never calls it, and the agent posts the pre-labels. Add version 1 and
+   note its id.
+3. **Client config.** For Claude Code (`.mcp.json`) or Claude Desktop:
+
+```json
+{
+  "mcpServers": {
+    "annotation": {
+      "command": "annotation",
+      "args": ["mcp"],
+      "env": {
+        "ANNOTIDE_URL": "https://annotate.example.com",
+        "ANNOTIDE_API_KEY": "ak_…",
+        "ANNOTIDE_MODEL_VERSION_ID": "<model version id>"
+      }
+    }
+  }
+}
+```
+
+Install with `pip install "annotide[mcp]"`. Pre-labels arrive as
+`draft` versions authored by the model version. People review and submit
+them as usual, and a pre-label never replaces human work (ML-10).
+
+## Development
+
+```sh
+make install                  # from the repository root: creates sdk/.venv
+cd sdk && .venv/bin/pytest && .venv/bin/mypy annotide tests tools
+make openapi                  # after an API change: docs/openapi.json + models.py
+```
+
+`annotide/models.py` is generated; never edit it by hand. CI fails when
+it or `docs/openapi.json` is stale.

annotide-0.1.0/annotide/__init__.py

@@ -0,0 +1,22 @@
+"""Python SDK for the Annotide API (API-3).
+
+from annotide import Client
+
+with Client("https://annotate.example.com", api_key="...") as client:
+    snapshot = client.take_snapshot(project_id, "2026-q3")
+    client.export(project_id, "coco", "dataset.zip", snapshot_id=snapshot["id"])
+"""
+
+from annotide.client import Client
+from annotide.errors import AnnotationError, ApiError, JobFailedError, JobTimeoutError
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "AnnotationError",
+    "ApiError",
+    "Client",
+    "JobFailedError",
+    "JobTimeoutError",
+    "__version__",
+]

annotide-0.1.0/annotide/cli.py

@@ -0,0 +1,214 @@
+"""`annotation` — command line over the SDK (API-3).
+
+Reads the key from `ANNOTIDE_API_KEY` only (a flag would end up in shell
+history and `ps`); the site from `--url` or `ANNOTIDE_URL`. Single objects
+print as indented JSON, lists as JSON Lines, so output pipes into `jq`.
+
+    annotide projects list
+    annotide snapshots create <project> "2026-q3" --split 0.8,0.1,0.1
+    annotide export <project> --format coco --snapshot <id> -o dataset.zip
+    annotide import <project> labels.json --format coco --dry-run
+    annotide mcp            # MCP server for AI agents over stdio (API-8)
+"""
+
+from __future__ import annotations
+
+import argparse
+import json
+import sys
+from collections.abc import Callable, Iterable
+from typing import Any
+
+from annotide import __version__
+from annotide.client import URL_ENV, Client
+from annotide.errors import AnnotationError
+
+ClientFactory = Callable[[str | None], Client]
+
+
+def _print_one(value: Any) -> None:
+    print(json.dumps(value, indent=2, ensure_ascii=False))
+
+
+def _print_many(values: Iterable[Any]) -> None:
+    for value in values:
+        print(json.dumps(value, ensure_ascii=False))
+
+
+def _split(text: str) -> dict[str, float]:
+    try:
+        train, val, test = (float(part) for part in text.split(","))
+    except ValueError as exc:
+        raise argparse.ArgumentTypeError("expected three ratios, e.g. 0.8,0.1,0.1") from exc
+    return {"train": train, "val": val, "test": test}
+
+
+def _class_map(text: str) -> dict[str, str | None]:
+    try:
+        value = json.loads(text)
+    except ValueError as exc:
+        raise argparse.ArgumentTypeError(f"not JSON: {exc}") from exc
+    if not isinstance(value, dict):
+        raise argparse.ArgumentTypeError('expected a JSON object, e.g. {"car": "vehicle"}')
+    return value
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="annotide",
+        description="Annotide command line. The API key is read from ANNOTIDE_API_KEY.",
+    )
+    parser.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
+    parser.add_argument("--url", help=f"site root, e.g. https://annotate.example.com (${URL_ENV})")
+    commands = parser.add_subparsers(dest="command", required=True, metavar="command")
+
+    commands.add_parser("whoami", help="the user or service account the key acts as")
+    commands.add_parser(
+        "mcp",
+        help="serve the Model Context Protocol over stdio for AI agents (needs the mcp extra)",
+    )
+
+    projects = commands.add_parser("projects", help="projects").add_subparsers(
+        dest="action", required=True
+    )
+    projects.add_parser("list", help="projects you are a member of")
+    stats = projects.add_parser("stats", help="dashboard numbers of one project")
+    stats.add_argument("project")
+
+    items = commands.add_parser("items", help="items").add_subparsers(dest="action", required=True)
+    items_list = items.add_parser("list", help="a project's items")
+    items_list.add_argument("project")
+    items_list.add_argument("--status")
+    items_list.add_argument("--media-type")
+    items_list.add_argument("--q", help="path substring")
+
+    snapshots = commands.add_parser("snapshots", help="dataset snapshots").add_subparsers(
+        dest="action", required=True
+    )
+    snapshots_list = snapshots.add_parser("list", help="a project's snapshots")
+    snapshots_list.add_argument("project")
+    create = snapshots.add_parser("create", help="freeze a snapshot and wait for it")
+    create.add_argument("project")
+    create.add_argument("name")
+    create.add_argument("--split", type=_split, help="train,val,test ratios, e.g. 0.8,0.1,0.1")
+    create.add_argument("--seed", type=int, default=0, help="split seed (default 0)")
+    create.add_argument("--group-by", help='keep groups together: "folder" or "meta.<key>"')
+    create.add_argument("--timeout", type=float, default=600.0)
+
+    export = commands.add_parser("export", help="export and download an archive")
+    export.add_argument("project")
+    export.add_argument("--format", required=True, help="coco, yolo or native")
+    export.add_argument("-o", "--output", required=True, help="file or directory to write")
+    export.add_argument("--snapshot", help="snapshot id (recommended: reproducible)")
+    export.add_argument("--split", choices=["train", "val", "test"])
+    export.add_argument("--timeout", type=float, default=1800.0)
+
+    imp = commands.add_parser("import", help="upload an annotation file and import it")
+    imp.add_argument("project")
+    imp.add_argument("file")
+    imp.add_argument("--format", required=True, help="coco, yolo, voc, cvat or label_studio")
+    imp.add_argument("--status", choices=["submitted", "draft"])
+    imp.add_argument("--class-map", type=_class_map, help='JSON, e.g. {"car": "vehicle"}')
+    imp.add_argument("--dry-run", action="store_true", help="report only, write nothing")
+    imp.add_argument("--timeout", type=float, default=1800.0)
+
+    jobs = commands.add_parser("jobs", help="background jobs").add_subparsers(
+        dest="action", required=True
+    )
+    jobs_list = jobs.add_parser("list", help="a project's jobs")
+    jobs_list.add_argument("project")
+    jobs_list.add_argument("--status")
+    jobs_list.add_argument("--type")
+    for name, text in (("get", "one job"), ("wait", "wait until a job finishes")):
+        sub = jobs.add_parser(name, help=text)
+        sub.add_argument("job")
+        if name == "wait":
+            sub.add_argument("--timeout", type=float, default=600.0)
+    return parser
+
+
+def run(args: argparse.Namespace, client: Client) -> None:
+    command, action = args.command, getattr(args, "action", None)
+    if command == "whoami":
+        _print_one(client.me())
+    elif command == "projects" and action == "list":
+        _print_many(client.list_projects())
+    elif command == "projects" and action == "stats":
+        _print_one(client.get_stats(args.project))
+    elif command == "items":
+        _print_many(
+            client.list_items(
+                args.project, status=args.status, media_type=args.media_type, q=args.q
+            )
+        )
+    elif command == "snapshots" and action == "list":
+        _print_many(client.list_snapshots(args.project))
+    elif command == "snapshots" and action == "create":
+        split = None
+        if args.split is not None:
+            split = {**args.split, "seed": args.seed, "group_by": args.group_by}
+        _print_one(client.take_snapshot(args.project, args.name, split=split, timeout=args.timeout))
+    elif command == "export":
+        path = client.export(
+            args.project,
+            args.format,
+            args.output,
+            snapshot_id=args.snapshot,
+            split=args.split,
+            timeout=args.timeout,
+        )
+        print(path)
+    elif command == "import":
+        _print_one(
+            client.import_file(
+                args.project,
+                args.file,
+                args.format,
+                class_mapping=args.class_map,
+                status=args.status,
+                dry_run=args.dry_run,
+                timeout=args.timeout,
+            )
+        )
+    elif command == "jobs" and action == "list":
+        _print_many(client.list_jobs(args.project, status=args.status, type=args.type))
+    elif command == "jobs" and action == "get":
+        _print_one(client.get_job(args.job))
+    elif command == "jobs" and action == "wait":
+        _print_one(client.wait_for_job(args.job, timeout=args.timeout))
+    else:  # pragma: no cover - argparse rejects anything else
+        raise AnnotationError(f"unknown command {command} {action or ''}".rstrip())
+
+
+def _serve_mcp(url: str | None) -> int:
+    """`annotide mcp`: the MCP server needs the `mcp` extra and owns stdout."""
+    try:
+        from annotide import mcp_server
+    except ImportError:
+        print(
+            'annotation: the MCP server needs the extra: pip install "annotide[mcp]"',
+            file=sys.stderr,
+        )
+        return 2
+    mcp_server.build_server(lambda: Client(url)).run("stdio")
+    return 0
+
+
+def main(argv: list[str] | None = None, client_factory: ClientFactory | None = None) -> int:
+    args = build_parser().parse_args(argv)
+    if args.command == "mcp":
+        return _serve_mcp(args.url)
+    factory: ClientFactory = client_factory or (lambda url: Client(url))
+    try:
+        with factory(args.url) as client:
+            run(args, client)
+    except AnnotationError as exc:
+        print(f"annotation: {exc}", file=sys.stderr)
+        return 1
+    except KeyboardInterrupt:
+        return 130
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())