mca-sdk 0.9.1__tar.gz → 0.9.4.dev1__tar.gz

{mca_sdk-0.9.1 → mca_sdk-0.9.4.dev1}/.pip-audit-allowlist.txt

@@ -13,8 +13,3 @@
 #   review: 2026-08-31, ticket: 6-13-followup-protobuf-cve-track.
 CVE-2026-0994
 
-# CVE-2026-4539 - package: TBD. Inherited from prior story 6-13 review;
-# pre-existing allowlist entry, justification not yet captured. Must be
-# either justified-and-kept or removed-and-fixed by the review date.
-#   review: 2026-06-30, ticket: 6-13-followup-cve-2026-4539-justify.
-CVE-2026-4539

{mca_sdk-0.9.1 → mca_sdk-0.9.4.dev1}/CHANGELOG.md

@@ -4,6 +4,94 @@ All notable changes to the MCA SDK will be documented in this file.
 
 ## [Unreleased]
 
+## [0.9.3] - 2026-07-08
+
+### Added
+- **`mca_sdk.ai_assist` subpackage** — public API for end-user data
+  scientists to program against the AI-assistant surface. Exposes
+  `get_guide_path()`, `read_guide()`, `render_prompt(variant, **fields)`,
+  `list_assistants()`, and `install(assistant, dest, force=False)`.
+- **`%mca_instrument` / `%mca_prompt` IPython magics** —
+  `%load_ext mca_sdk.ai_assist.jupyter` registers a notebook-native
+  onboarding path. `%mca_instrument` reuses the same `_auto_init` /
+  `_shutdown_with_timeout` bootstrap as `mca-instrument` / `mca-run`, so
+  env-var semantics are identical across surfaces. IPython is optional
+  (`pip install "mca-sdk[jupyter]"`); the module raises a clear error if
+  IPython is missing.
+- **`mca-init ai-assist` subcommand** — scaffolds per-assistant config
+  files into the caller's repo at each assistant's canonical location:
+  Claude Code (`.claude/skills/mca-instrument.md`), Cursor
+  (`.cursor/rules/mca-instrument.mdc`), Copilot
+  (`.github/copilot-instructions.md`), Gemini CLI (`GEMINI.md`). Also
+  supports `mca-init ai-assist prompt --model-id ... --type ...` to
+  render a fully-filled Variant A/B paste-in prompt to stdout. Every
+  template LINKS to `FOR_AI_ASSISTANTS.md` inside the wheel — none
+  duplicate pattern content.
+- Notebook starter template shipped in the wheel at
+  `mca_sdk/ai_assist/templates/notebook/mca_starter.ipynb`.
+
+### Changed
+- **`FOR_AI_ASSISTANTS.md`** received three rounds of post-0.9.2
+  corrections from live instrumentation observations: six additional
+  pattern gaps closed (association-id join keys, batch-vs-per-instance
+  `record_*` rules, and related edge cases); `model_types` values
+  corrected to the canonical set; and a new section covering MLOps
+  pipeline usage and dependency-installation guidance.
+
+### Fixed
+- **OTel SDK 1.35–1.38 import compatibility** — `mca_sdk` no longer
+  raises `ImportError: cannot import name 'ReadableLogRecord' from
+  'opentelemetry.sdk._logs'` when installed against `opentelemetry-sdk`
+  releases in the 1.35 through 1.38 window (where the symbol did not
+  exist). `mca_sdk/exporters/gcp_logging.py` and
+  `mca_sdk/buffering/exporters.py` now use try/except fallback chains
+  to import `LogRecord`, `LogRecordExporter`, and
+  `LogRecordExportResult` from whichever module path the installed
+  OTel version exposes them at (`_logs`, `_logs._internal`, or the
+  older `LogExporter` / `LogExportResult` aliases). Verified against
+  OTel 1.35.0, 1.36.0, and 1.43.0. Type annotations changed from
+  `Sequence[ReadableLogRecord]` to `Sequence[LogRecord]`; runtime
+  behavior is unchanged.
+- **MANIFEST.in** now includes `FOR_AI_ASSISTANTS.md` and all
+  `ai_assist/templates/*` files in sdists. The guide previously shipped
+  only in wheels via `setup.py package_data`; sdist consumers
+  (`pip install --no-binary`) lost it.
+- Lint and mypy strict-mode errors resolved across
+  `mca_sdk/ai_assist/cli_install.py`, `mca_sdk/ai_assist/jupyter.py`,
+  `mca_sdk/buffering/exporters.py`, and
+  `mca_sdk/exporters/gcp_logging.py`. No behavior change.
+- **Sphinx docs build** — `IPython` is now mocked in `docs/conf.py`
+  so the `mca_sdk.ai_assist.jupyter` autosummary page builds cleanly
+  in docs environments without IPython installed.
+
+### Security
+- **cryptography** upgraded to 48.0.1. Expired CVE-2026-4539 entry
+  removed from `.pip-audit-allowlist.txt`.
+
+### Notes
+- The `mca-init <project_dir>` invocation is unchanged. The new
+  `ai-assist` action is pre-dispatched in `main()` before argparse sees
+  the positional arg, so no argparse restructure was needed.
+- **PHI is still the application's responsibility.** Every template
+  body carries the "warn, do not auto-mask" language from
+  FOR_AI_ASSISTANTS.md §6.
+
+## [0.9.2] - 2026-06-30
+
+### Changed
+- **Docs (`FOR_AI_ASSISTANTS.md`)**: rewrote the in-wheel AI-assistant
+  instrumentation guide. Now covers `autolog()` (stories 8-2, 9-1, 9-2),
+  agentic multi-step instrumentation (story 1-11), Vertex AI Gemini direct
+  via `record_llm_generation` context manager, FastAPI `lifespan` startup,
+  `RegistryClient` with `use_gcp_auth=True` + `token_audience`, vendor
+  bridge, direct OpenAI/Anthropic patchers, LangChain / LlamaIndex
+  callbacks, batch-vs-per-instance `record_*` rules, `association_id`
+  join-key guidance, and PHI opt-in (`MCA_ENABLE_PHI_FILTER`). Corrects
+  the env-var name from `MCA_COLLECTOR_ENDPOINT` to the canonical
+  `MCA_OTEL_ENDPOINT` (deployment-only override retained for backwards
+  compat). Adds owner-stated and fallback prompt templates so the
+  assistant cannot guess model type / shape (stories 1-6, 1-7, 1-8).
+
 ## [0.9.1] - 2026-06-12
 
 ### Changed

{mca_sdk-0.9.1 → mca_sdk-0.9.4.dev1}/MANIFEST.in

@@ -3,3 +3,5 @@ include LICENSE
 include CHANGELOG.md
 recursive-include mca_sdk *.py
 recursive-include mca_sdk py.typed
+recursive-include mca_sdk *.md
+recursive-include mca_sdk/ai_assist/templates *

{mca_sdk-0.9.1/mca_sdk.egg-info → mca_sdk-0.9.4.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mca-sdk
-Version: 0.9.1
+Version: 0.9.4.dev1
 Summary: Model Collector Agent SDK for OpenTelemetry monitoring
 Author-email: Baptist Health South Florida <ai-ml@baptisthealth.net>
 License: Apache-2.0
@@ -50,12 +50,15 @@ Requires-Dist: numpy>=1.24.0; extra == "autolog"
 Provides-Extra: instrument
 Requires-Dist: opentelemetry-instrumentation>=0.48b0; extra == "instrument"
 Requires-Dist: opentelemetry-distro>=0.48b0; extra == "instrument"
+Provides-Extra: jupyter
+Requires-Dist: ipython>=7.0; extra == "jupyter"
 Provides-Extra: test
 Requires-Dist: pytest>=7.4.0; extra == "test"
 Requires-Dist: pytest-cov>=4.1.0; extra == "test"
 Requires-Dist: pytest-mock>=3.12.0; extra == "test"
 Requires-Dist: pytest-asyncio>=0.23.0; extra == "test"
 Requires-Dist: opentelemetry-exporter-prometheus>=0.48b0; extra == "test"
+Requires-Dist: ipython>=7.0; extra == "test"
 Provides-Extra: dev
 Requires-Dist: black>=24.0.0; extra == "dev"
 Requires-Dist: mypy>=1.8.0; extra == "dev"
@@ -66,6 +69,7 @@ Requires-Dist: pytest-mock>=3.12.0; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
 Requires-Dist: opentelemetry-exporter-prometheus>=0.48b0; extra == "dev"
 Requires-Dist: pdoc>=14.0.0; extra == "dev"
+Requires-Dist: ipython>=7.0; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: pdoc>=14.0.0; extra == "docs"
 Provides-Extra: all
@@ -296,6 +300,25 @@ If you are using an agentic coding assistant (like Claude Code, Gemini CLI, Curs
 Simply paste this prompt to your AI assistant:
 > "Please review my codebase and instrument my models using the MCA SDK. You can find the instructions on how to do this by reading the guide located at `mca_sdk/FOR_AI_ASSISTANTS.md` within the installed package."
 
+**Drop assistant configs into your repo with one command:**
+```bash
+mca-init ai-assist install --assistant all          # Claude Code + Cursor + Copilot + Gemini CLI
+mca-init ai-assist install --assistant cursor       # just Cursor rules
+mca-init ai-assist prompt --model-id mdl-001 --type predictive --shape script  # print a ready-to-paste prompt
+```
+
+**In a Jupyter notebook** (see also the `mca_starter.ipynb` template shipped with the SDK):
+```python
+%load_ext mca_sdk.ai_assist.jupyter
+%mca_instrument --model-id mdl-001 --team clinical-ai
+```
+
+**Programmatic access to the guide:**
+```python
+from mca_sdk.ai_assist import get_guide_path, read_guide
+print(get_guide_path())
+```
+
 ### Approach 2: Zero-Code Auto-Instrumentation (Recommended)
 This approach utilizes the `mca-instrument` CLI wrapper to automatically instrument your application's external calls and supported framework inferences without touching your source code.
 **Prerequisites**: Install the SDK with instrumentation dependencies: `pip install "mca-sdk[instrument]"` and run `opentelemetry-bootstrap -a install`.
@@ -323,7 +346,7 @@ Provide configuration via environment variables in your deployment manifest. The
 - **GCP Exporters**: To route telemetry to GCP buckets, you must set `MCA_GCP_LOGGING_ENABLED=true` and `MCA_GCP_TRACE_ENABLED=true` environment variables.
 
 ### Approach 3: Manual Instrumentation
-If you are not using standard HTTP/DB frameworks, **if you are working in a Jupyter Notebook**, or if you need precise programmatic control, use the SDK's Python API directly in your code.
+If you are not using standard HTTP/DB frameworks, or if you need precise programmatic control, use the SDK's Python API directly in your code. (In a Jupyter notebook, prefer the `%mca_instrument` magic under Approach 1.)
 
 ```python
 from mca_sdk import MCAClient

{mca_sdk-0.9.1 → mca_sdk-0.9.4.dev1}/README.md

@@ -209,6 +209,25 @@ If you are using an agentic coding assistant (like Claude Code, Gemini CLI, Curs
 Simply paste this prompt to your AI assistant:
 > "Please review my codebase and instrument my models using the MCA SDK. You can find the instructions on how to do this by reading the guide located at `mca_sdk/FOR_AI_ASSISTANTS.md` within the installed package."
 
+**Drop assistant configs into your repo with one command:**
+```bash
+mca-init ai-assist install --assistant all          # Claude Code + Cursor + Copilot + Gemini CLI
+mca-init ai-assist install --assistant cursor       # just Cursor rules
+mca-init ai-assist prompt --model-id mdl-001 --type predictive --shape script  # print a ready-to-paste prompt
+```
+
+**In a Jupyter notebook** (see also the `mca_starter.ipynb` template shipped with the SDK):
+```python
+%load_ext mca_sdk.ai_assist.jupyter
+%mca_instrument --model-id mdl-001 --team clinical-ai
+```
+
+**Programmatic access to the guide:**
+```python
+from mca_sdk.ai_assist import get_guide_path, read_guide
+print(get_guide_path())
+```
+
 ### Approach 2: Zero-Code Auto-Instrumentation (Recommended)
 This approach utilizes the `mca-instrument` CLI wrapper to automatically instrument your application's external calls and supported framework inferences without touching your source code.
 **Prerequisites**: Install the SDK with instrumentation dependencies: `pip install "mca-sdk[instrument]"` and run `opentelemetry-bootstrap -a install`.
@@ -236,7 +255,7 @@ Provide configuration via environment variables in your deployment manifest. The
 - **GCP Exporters**: To route telemetry to GCP buckets, you must set `MCA_GCP_LOGGING_ENABLED=true` and `MCA_GCP_TRACE_ENABLED=true` environment variables.
 
 ### Approach 3: Manual Instrumentation
-If you are not using standard HTTP/DB frameworks, **if you are working in a Jupyter Notebook**, or if you need precise programmatic control, use the SDK's Python API directly in your code.
+If you are not using standard HTTP/DB frameworks, or if you need precise programmatic control, use the SDK's Python API directly in your code. (In a Jupyter notebook, prefer the `%mca_instrument` magic under Approach 1.)
 
 ```python
 from mca_sdk import MCAClient