expr-tracker 0.3.1__tar.gz → 0.3.2__tar.gz

{expr_tracker-0.3.1 → expr_tracker-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: expr_tracker
-Version: 0.3.1
+Version: 0.3.2
 Summary: Local-first experiment tracking with queryable history and expression-based alerts on your training metrics
 Project-URL: Homepage, https://hspk.github.io/expr_tracker/
 Project-URL: Documentation, https://hspk.github.io/expr_tracker/
@@ -27,6 +27,7 @@ Requires-Python: >=3.10
 Requires-Dist: click>=8.1.0
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: pydantic>=2.0
+Requires-Dist: python-dotenv>=1.0
 Provides-Extra: all
 Requires-Dist: nvidia-ml-py>=12.0; extra == 'all'
 Requires-Dist: pandas>=1.5; extra == 'all'

{expr_tracker-0.3.1 → expr_tracker-0.3.2}/docs/guide/cli.md

@@ -89,3 +89,17 @@ et alert "node 3 is on fire" --level critical --channel oncall
 
 Channels come from the same configuration the library uses: `ET_ALERT_CONFIG` or the
 `ET_LARK_WEBHOOK_URL` environment variable. See [Alerts](alerts.md).
+
+`et alert` automatically loads `.env` from the directory where you invoke it,
+before resolving alert configuration. Existing environment variables take
+precedence, including empty values. It does not search parent directories; a
+missing `.env` is fine. Use `--no-dotenv` to disable loading.
+
+```dotenv
+# .env
+ET_LARK_WEBHOOK_URL=https://example.com/your-webhook
+```
+
+Quoted values, comments, and `${VAR}` expansion are supported; shell commands are
+not executed. Keep secrets out of version control. This loading applies only to
+`et alert`, not other CLI commands or the Python API.

{expr_tracker-0.3.1 → expr_tracker-0.3.2}/pyproject.toml

@@ -34,6 +34,7 @@ dependencies = [
     "click>=8.1.0",
     "loguru>=0.7.3",
     "pydantic>=2.0",
+    "python-dotenv>=1.0",
 ]
 
 dynamic = ["version"]

{expr_tracker-0.3.1 → expr_tracker-0.3.2}/src/expr_tracker/cli.py

@@ -4,8 +4,10 @@ from __future__ import annotations
 
 import json
 import time
+from pathlib import Path
 
 import click
+from dotenv import load_dotenv
 
 from .alerts import alert as send_alert
 from .alerts.dispatch import Dispatcher
@@ -26,8 +28,21 @@ def main():
 @click.option("--title", default="Alert", help="Title of the alert")
 @click.option("--level", default="info", help="info | warning | error | critical")
 @click.option("--channel", "channels", multiple=True, help="Restrict to these channels")
-def alert(msg: str, title: str, level: str, channels: tuple[str, ...]):
-    """Send a manual alert."""
+@click.option(
+    "--no-dotenv", is_flag=True, help="Skip loading .env from the current directory"
+)
+def alert(
+    msg: str, title: str, level: str, channels: tuple[str, ...], no_dotenv: bool
+):
+    """Send a manual alert, loading the current directory's .env by default."""
+    if not no_dotenv:
+        try:
+            with Path(".env").open(encoding="utf-8") as stream:
+                load_dotenv(stream=stream, override=False)
+        except FileNotFoundError:
+            pass
+        except (OSError, UnicodeError) as exc:
+            raise click.ClickException(f"Could not read .env: {exc}") from exc
     send_alert(title=title, text=msg, level=level, channels=list(channels) or None)
 
 

{expr_tracker-0.3.1 → expr_tracker-0.3.2}/tests/test_cli.py

@@ -1,6 +1,7 @@
 """The full CLI surface: every command, every format, and their error paths."""
 
 import json
+import os
 
 import pytest
 from click.testing import CliRunner
@@ -10,7 +11,9 @@ from expr_tracker.history import HistoryStore
 
 
 @pytest.fixture
-def runner():
+def runner(monkeypatch, tmp_path):
+    monkeypatch.chdir(tmp_path)
+    monkeypatch.setattr(os, "environ", os.environ.copy())
     return CliRunner()
 
 
@@ -237,6 +240,81 @@ def test_alert_without_a_message_fails(runner, channel):
     assert runner.invoke(cli.main, ["alert"]).exit_code != 0
 
 
+def test_alert_loads_dotenv_before_resolving_channels(runner, monkeypatch, tmp_path):
+    from expr_tracker.alerts import load_config
+
+    monkeypatch.delenv("ET_LARK_WEBHOOK_URL", raising=False)
+    monkeypatch.delenv("ET_ALERT_CONFIG", raising=False)
+    (tmp_path / ".env").write_text(
+        '# Alert settings\nexport ET_LARK_WEBHOOK_URL="https://example.test/hook"\n',
+        encoding="utf-8",
+    )
+    configs = []
+    monkeypatch.setattr(cli, "send_alert", lambda **kwargs: configs.append(load_config()))
+
+    invoke(runner, "alert", "hello")
+
+    assert any(
+        c.type == "lark" and c.resolve_url() == "https://example.test/hook"
+        for c in configs[0].channels
+    )
+
+
+@pytest.mark.parametrize("existing", ["from-shell", ""])
+def test_alert_dotenv_preserves_existing_environment(
+    runner, channel, monkeypatch, tmp_path, existing
+):
+    monkeypatch.setenv("ET_TEST_DOTENV", existing)
+    (tmp_path / ".env").write_text("ET_TEST_DOTENV=from-file\n", encoding="utf-8")
+
+    invoke(runner, "alert", "hello")
+
+    assert os.environ["ET_TEST_DOTENV"] == existing
+    assert len(channel) == 1
+
+
+def test_alert_does_not_search_parent_dotenv(runner, channel, monkeypatch, tmp_path):
+    monkeypatch.delenv("ET_TEST_DOTENV", raising=False)
+    (tmp_path / ".env").write_text("ET_TEST_DOTENV=parent\n", encoding="utf-8")
+    child = tmp_path / "child"
+    child.mkdir()
+    monkeypatch.chdir(child)
+
+    invoke(runner, "alert", "hello")
+
+    assert "ET_TEST_DOTENV" not in os.environ
+    assert len(channel) == 1
+
+
+def test_alert_can_skip_dotenv(runner, channel, monkeypatch, tmp_path):
+    monkeypatch.delenv("ET_TEST_DOTENV", raising=False)
+    (tmp_path / ".env").write_text("ET_TEST_DOTENV=from-file\n", encoding="utf-8")
+
+    invoke(runner, "alert", "hello", "--no-dotenv")
+
+    assert "ET_TEST_DOTENV" not in os.environ
+    assert len(channel) == 1
+
+
+def test_alert_reports_unreadable_dotenv(runner, channel, tmp_path):
+    (tmp_path / ".env").mkdir()
+
+    result = runner.invoke(cli.main, ["alert", "hello"])
+
+    assert result.exit_code != 0
+    assert "Could not read .env" in result.output
+    assert not channel
+
+
+def test_other_commands_do_not_load_dotenv(runner, monkeypatch, tmp_path):
+    monkeypatch.delenv("ET_TEST_DOTENV", raising=False)
+    (tmp_path / ".env").write_text("ET_TEST_DOTENV=from-file\n", encoding="utf-8")
+
+    invoke(runner, "rules", "explain", "loss > 1")
+
+    assert "ET_TEST_DOTENV" not in os.environ
+
+
 # ------------------------------------------------------------------ rules
 
 

{expr_tracker-0.3.1 → expr_tracker-0.3.2}/uv.lock

@@ -463,6 +463,7 @@ dependencies = [
     { name = "click" },
     { name = "loguru" },
     { name = "pydantic" },
+    { name = "python-dotenv" },
 ]
 
 [package.optional-dependencies]
@@ -517,6 +518,7 @@ requires-dist = [
     { name = "polars", marker = "extra == 'all'", specifier = ">=0.20" },
     { name = "polars", marker = "extra == 'polars'", specifier = ">=0.20" },
     { name = "pydantic", specifier = ">=2.0" },
+    { name = "python-dotenv", specifier = ">=1.0" },
     { name = "trackio", marker = "extra == 'all'", specifier = ">=0.4.0" },
     { name = "trackio", marker = "extra == 'trackio'", specifier = ">=0.4.0" },
     { name = "wandb", marker = "extra == 'all'", specifier = ">=0.21.0" },