o41-metrics-api 0.1.0__tar.gz

o41_metrics_api-0.1.0/LICENSE

@@ -0,0 +1,176 @@
+                              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

o41_metrics_api-0.1.0/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: o41-metrics-api
+Version: 0.1.0
+Summary: Python client for the 041 Metrics v2 API
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Dist: niquests>=3.16.0
+Requires-Dist: pydantic>=2.13.3
+Requires-Dist: pytest>=8.0.0 ; extra == 'dev'
+Requires-Dist: ruff>=0.15.12 ; extra == 'dev'
+Requires-Dist: ty>=0.0.34 ; extra == 'dev'
+Requires-Python: >=3.14, <3.15
+Provides-Extra: dev
+Description-Content-Type: text/markdown
+
+# 041 Metrics API Client
+
+Python client for the [041 Metrics](https://metrics.041.io/) v2 API.
+Use it to find and organize folders and experiments and to read one
+experiment's record, catalog, annotations, and series from code.
+
+Pick the right tool:
+
+- **Analysis across experiments:** the `o41-metrics-duckdb` extension
+  attaches Metrics as a database with an on-disk cache. Use it for plots,
+  tables, joins, and anything spanning a folder.
+- **Recording training or evaluation jobs:** `o41-metrics-collector` queues,
+  batches, and delivers metrics in the background. This client's write session
+  exists for API completeness, tests, and backfills.
+- **Programmatic control and one-experiment reads:** this client.
+
+## Install
+
+```bash
+uv add o41-metrics-api
+```
+
+## Connect
+
+```python
+from o41_metrics_api import Metrics
+
+metrics = Metrics()
+```
+
+The client resolves credentials the same way as the `o41-metrics` CLI. The
+API key comes from `api_key=`, then `O41_METRICS_API_KEY`, then the login
+saved by `o41-metrics auth login`. The host comes from `host=`, then
+`O41_METRICS_HOST`, then the saved login's host when the key came from that
+login, then `https://metrics.041.io`.
+`Metrics` is also a context manager that closes its HTTP session.
+
+## Folders and experiments
+
+Address a folder by absolute path or id; `/` is the root. Address an experiment
+by id or slug.
+
+```python
+mamba = metrics.make_folder("/models/mamba")  # creates missing parents
+mamba = metrics.folder("/models/mamba")       # MetricsNotFound when missing
+mamba.folders()                               # direct children
+mamba.experiments()                           # direct members
+mamba.experiments("run-*", recursive=True)    # slug glob, whole subtree
+metrics.experiments("syv-2039-*")             # every experiment matching a glob
+
+exp = metrics.experiment("mamba-run-001")
+exp.move("/archive")
+mamba.rename("mamba-v2")
+mamba.move("/")
+```
+
+Lookups use a snapshot of the folder tree, read on first use. Changes made
+through the client refresh it. A `folder()` or `experiment()` lookup that
+misses reads the tree again once before raising. Listings such as
+`folders()` and `experiments()` use the snapshot as is, so call
+`metrics.refresh()` to list what was created elsewhere. `Folder` and
+`Experiment` are immutable values. A rename or move returns a new handle.
+
+## Read one experiment
+
+```python
+info = exp.info()          # status, description, meta, error, lifecycle datetimes
+catalog = exp.catalog()    # series names with their metadata keys and values
+notes = exp.annotations()  # every annotation, newest first
+
+for series in exp.series("loss", where={"split": "valid"}):
+    print(series.metadata, series.steps, series.values)
+```
+
+`series()` returns one `Series` per metadata partition. Its `steps`,
+`timestamps_ms`, and `values` are aligned. Pass one name, several names, or
+none to read every series of the experiment. Results follow the order of the
+names, or name order when you pass none. One streaming request reads up to
+1,000 series. `where` matches exact metadata values, `has=("rank",)` requires a
+key, and `x="timestamp"` orders points by time instead of step. The client
+returns series only after the stream completes, so partial data is never
+returned.
+
+## Write session
+
+```python
+with metrics.open_experiment(
+    "backfill-001", description="Imported run", meta={"seed": 7}, folder="/imports"
+) as run:
+    run.start()
+    run.metric("loss", 0.25, step=1, metadata={"split": "train"})
+    run.done()
+```
+
+Each call is one acknowledged request. `metrics()` takes many `MetricPoint`s
+and sends up to 1000 per request. The session refreshes its experiment token
+before it expires and revokes the token when the block exits. Reopening an
+existing slug replaces its description and meta. An experiment already in
+another folder stays there. A token left idle past its 24 hour expiry cannot be
+refreshed, so reopen the experiment instead. For real training jobs use
+`o41-metrics-collector`.
+
+## Other events
+
+`metrics.send(event, data)` sends any v2 organization event to
+`/api/v2/events` and returns the reply data. The API reference is at
+`https://metrics.041.io/api/openapi.json`.
+
+## Errors and retries
+
+Every failure is a `MetricsError` with `code`, `message`, `status`, and
+`retryable`. `MetricsNotFound` (also a `LookupError`) reports an unresolved
+reference. `MetricsAuthError` reports missing credentials.
+
+Reads and metric writes retry transient failures with backoff. A retried
+metric keeps its original message id, which the API deduplicates. Every other
+write never retries, because repeating it can have side effects: folder
+creation, moves, renames, `open_experiment`, lifecycle events (a replayed
+`done` would move `done_at`), annotations, and `send()`.

o41_metrics_api-0.1.0/README.md

@@ -0,0 +1,119 @@
+# 041 Metrics API Client
+
+Python client for the [041 Metrics](https://metrics.041.io/) v2 API.
+Use it to find and organize folders and experiments and to read one
+experiment's record, catalog, annotations, and series from code.
+
+Pick the right tool:
+
+- **Analysis across experiments:** the `o41-metrics-duckdb` extension
+  attaches Metrics as a database with an on-disk cache. Use it for plots,
+  tables, joins, and anything spanning a folder.
+- **Recording training or evaluation jobs:** `o41-metrics-collector` queues,
+  batches, and delivers metrics in the background. This client's write session
+  exists for API completeness, tests, and backfills.
+- **Programmatic control and one-experiment reads:** this client.
+
+## Install
+
+```bash
+uv add o41-metrics-api
+```
+
+## Connect
+
+```python
+from o41_metrics_api import Metrics
+
+metrics = Metrics()
+```
+
+The client resolves credentials the same way as the `o41-metrics` CLI. The
+API key comes from `api_key=`, then `O41_METRICS_API_KEY`, then the login
+saved by `o41-metrics auth login`. The host comes from `host=`, then
+`O41_METRICS_HOST`, then the saved login's host when the key came from that
+login, then `https://metrics.041.io`.
+`Metrics` is also a context manager that closes its HTTP session.
+
+## Folders and experiments
+
+Address a folder by absolute path or id; `/` is the root. Address an experiment
+by id or slug.
+
+```python
+mamba = metrics.make_folder("/models/mamba")  # creates missing parents
+mamba = metrics.folder("/models/mamba")       # MetricsNotFound when missing
+mamba.folders()                               # direct children
+mamba.experiments()                           # direct members
+mamba.experiments("run-*", recursive=True)    # slug glob, whole subtree
+metrics.experiments("syv-2039-*")             # every experiment matching a glob
+
+exp = metrics.experiment("mamba-run-001")
+exp.move("/archive")
+mamba.rename("mamba-v2")
+mamba.move("/")
+```
+
+Lookups use a snapshot of the folder tree, read on first use. Changes made
+through the client refresh it. A `folder()` or `experiment()` lookup that
+misses reads the tree again once before raising. Listings such as
+`folders()` and `experiments()` use the snapshot as is, so call
+`metrics.refresh()` to list what was created elsewhere. `Folder` and
+`Experiment` are immutable values. A rename or move returns a new handle.
+
+## Read one experiment
+
+```python
+info = exp.info()          # status, description, meta, error, lifecycle datetimes
+catalog = exp.catalog()    # series names with their metadata keys and values
+notes = exp.annotations()  # every annotation, newest first
+
+for series in exp.series("loss", where={"split": "valid"}):
+    print(series.metadata, series.steps, series.values)
+```
+
+`series()` returns one `Series` per metadata partition. Its `steps`,
+`timestamps_ms`, and `values` are aligned. Pass one name, several names, or
+none to read every series of the experiment. Results follow the order of the
+names, or name order when you pass none. One streaming request reads up to
+1,000 series. `where` matches exact metadata values, `has=("rank",)` requires a
+key, and `x="timestamp"` orders points by time instead of step. The client
+returns series only after the stream completes, so partial data is never
+returned.
+
+## Write session
+
+```python
+with metrics.open_experiment(
+    "backfill-001", description="Imported run", meta={"seed": 7}, folder="/imports"
+) as run:
+    run.start()
+    run.metric("loss", 0.25, step=1, metadata={"split": "train"})
+    run.done()
+```
+
+Each call is one acknowledged request. `metrics()` takes many `MetricPoint`s
+and sends up to 1000 per request. The session refreshes its experiment token
+before it expires and revokes the token when the block exits. Reopening an
+existing slug replaces its description and meta. An experiment already in
+another folder stays there. A token left idle past its 24 hour expiry cannot be
+refreshed, so reopen the experiment instead. For real training jobs use
+`o41-metrics-collector`.
+
+## Other events
+
+`metrics.send(event, data)` sends any v2 organization event to
+`/api/v2/events` and returns the reply data. The API reference is at
+`https://metrics.041.io/api/openapi.json`.
+
+## Errors and retries
+
+Every failure is a `MetricsError` with `code`, `message`, `status`, and
+`retryable`. `MetricsNotFound` (also a `LookupError`) reports an unresolved
+reference. `MetricsAuthError` reports missing credentials.
+
+Reads and metric writes retry transient failures with backoff. A retried
+metric keeps its original message id, which the API deduplicates. Every other
+write never retries, because repeating it can have side effects: folder
+creation, moves, renames, `open_experiment`, lifecycle events (a replayed
+`done` would move `done_at`), annotations, and `send()`.

o41_metrics_api-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "o41-metrics-api"
+version = "0.1.0"
+description = "Python client for the 041 Metrics v2 API"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.14,<3.15"
+dependencies = [
+    "niquests>=3.16.0",
+    "pydantic>=2.13.3",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "ruff>=0.15.12",
+    "ty>=0.0.34",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[build-system]
+requires = ["uv_build>=0.11.9,<0.12"]
+build-backend = "uv_build"

o41_metrics_api-0.1.0/pyproject.toml.orig

@@ -0,0 +1,22 @@
+[project]
+name = "o41-metrics-api"
+version = "0.1.0"
+description = "Python client for the 041 Metrics v2 API"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.14,<3.15"
+dependencies = [
+    "niquests>=3.16.0",
+    "pydantic>=2.13.3",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0.0", "ruff>=0.15.12", "ty>=0.0.34"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[build-system]
+requires = ["uv_build>=0.11.9,<0.12"]
+build-backend = "uv_build"

o41_metrics_api-0.1.0/src/o41_metrics_api/__init__.py

@@ -0,0 +1,44 @@
+"""Python client for the 041 Metrics v2 API.
+
+Use :class:`Metrics` to find and organize folders and experiments, read one
+experiment's record, catalog, annotations, and series, and send any v2 org
+event. For analysis across many experiments use ``o41-metrics-duckdb``; to
+record training and evaluation runs use ``o41-metrics-collector``.
+"""
+
+from o41_metrics_api.client import Experiment, ExperimentRun, Folder, Metrics
+from o41_metrics_api.errors import (
+    MetricsAuthError,
+    MetricsError,
+    MetricsNotFound,
+)
+from o41_metrics_api.models import (
+    Annotation,
+    AuthOrganization,
+    AuthStatus,
+    CatalogSeries,
+    ExperimentError,
+    ExperimentInfo,
+    ExperimentStatus,
+    MetricPoint,
+    Series,
+)
+
+__all__ = [
+    "Annotation",
+    "AuthOrganization",
+    "AuthStatus",
+    "CatalogSeries",
+    "Experiment",
+    "ExperimentError",
+    "ExperimentInfo",
+    "ExperimentRun",
+    "ExperimentStatus",
+    "Folder",
+    "MetricPoint",
+    "Metrics",
+    "MetricsAuthError",
+    "MetricsError",
+    "MetricsNotFound",
+    "Series",
+]

o41_metrics_api-0.1.0/src/o41_metrics_api/_auth.py

@@ -0,0 +1,87 @@
+from __future__ import annotations
+
+import json
+import os
+from dataclasses import dataclass
+from pathlib import Path
+from urllib.parse import urlparse
+
+from o41_metrics_api.errors import MetricsAuthError
+
+DEFAULT_HOST = "https://metrics.041.io"
+API_KEY_ENV = "O41_METRICS_API_KEY"
+HOST_ENV = "O41_METRICS_HOST"
+
+
+@dataclass(frozen=True)
+class Credentials:
+    api_key: str
+    host: str
+
+
+def _env(name: str) -> str:
+    """Read an ``O41_METRICS_`` variable, else its pre-rename ``SYVAIN_METRICS_``
+    name."""
+    legacy = name.replace("O41_METRICS_", "SYVAIN_METRICS_", 1)
+    return os.environ.get(name, "").strip() or os.environ.get(legacy, "").strip()
+
+
+def cli_auth_path() -> Path:
+    """Return the file written by ``o41-metrics auth login``, else the one the
+    older ``syvain-metrics`` CLI wrote."""
+    config_home = os.environ.get("XDG_CONFIG_HOME")
+    root = Path(config_home).expanduser() if config_home else Path.home() / ".config"
+    path = root / "o41-metrics" / "auth.json"
+    legacy = root / "syvain-metrics" / "auth.json"
+    return legacy if not path.exists() and legacy.exists() else path
+
+
+def normalize_host(value: str) -> str:
+    """Return a plain HTTP(S) origin with no path, query, or fragment."""
+    parsed = urlparse(value.strip())
+    if (
+        parsed.scheme not in {"http", "https"}
+        or parsed.netloc == ""
+        or parsed.username is not None
+        or parsed.password is not None
+        or parsed.path not in {"", "/"}
+        or parsed.params
+        or parsed.query
+        or parsed.fragment
+    ):
+        raise MetricsAuthError(
+            f"Metrics host must be a plain HTTP(S) origin: {value!r}"
+        )
+    return f"{parsed.scheme}://{parsed.netloc}"
+
+
+def _read_cli_login() -> tuple[str, str]:
+    path = cli_auth_path()
+    try:
+        raw = json.loads(path.read_text(encoding="utf-8"))
+    except FileNotFoundError as error:
+        raise MetricsAuthError(
+            f"No Metrics API key: pass api_key, set {API_KEY_ENV}, "
+            "or run `o41-metrics auth login`."
+        ) from error
+    except json.JSONDecodeError as error:
+        raise MetricsAuthError(
+            f"Metrics CLI login is not valid JSON: {path}"
+        ) from error
+    api_key = raw.get("apiKey") if isinstance(raw, dict) else None
+    if not isinstance(api_key, str) or not api_key:
+        raise MetricsAuthError(f"Metrics CLI login has no apiKey: {path}")
+    host = raw.get("host")
+    return api_key, host if isinstance(host, str) else ""
+
+
+def resolve_credentials(api_key: str | None, host: str | None) -> Credentials:
+    """Resolve like the CLI: argument, then environment, then the saved login."""
+    key = (api_key or "").strip() or _env(API_KEY_ENV)
+    login_host = ""
+    if not key:
+        key, login_host = _read_cli_login()
+    chosen_host = (
+        (host or "").strip() or _env(HOST_ENV) or login_host.strip() or DEFAULT_HOST
+    )
+    return Credentials(api_key=key, host=normalize_host(chosen_host))