tsagentkit 1.0.2__tar.gz

tsagentkit-1.0.2/.github/workflows/workflow.yml

@@ -0,0 +1,82 @@
+name: Publish to PyPI
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.11', '3.12']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+      with:
+        version: 'latest'
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: uv sync --extra dev
+
+    - name: Run type checks
+      run: uv run mypy src/tsagentkit
+
+    - name: Run linting
+      run: uv run ruff check src/
+
+    - name: Run tests
+      run: uv run pytest --cov=src/tsagentkit -v
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    if: startsWith(github.ref, 'refs/tags/v')
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+      with:
+        version: 'latest'
+
+    - name: Build package
+      run: uv build
+
+    - name: Upload distributions
+      uses: actions/upload-artifact@v4
+      with:
+        name: dist
+        path: dist/
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/v')
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download distributions
+      uses: actions/download-artifact@v4
+      with:
+        name: dist
+        path: dist/
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

tsagentkit-1.0.2/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

tsagentkit-1.0.2/.python-version

@@ -0,0 +1 @@
+3.11

tsagentkit-1.0.2/AGENTS.md

@@ -0,0 +1,43 @@
+# Repository Guidelines
+
+## Python Environment
+
+- Python version: 3.11
+- Dependencies: Listed in `pyproject.toml`.
+- Always use `uv` to manage dependencies. 
+  - Add packages to `pyproject.toml` as needed.
+  - Use `uv sync` to install dependencies.
+  - Use `uv run <command>` to run commands with the correct environment.
+
+## Project Structure & Module Organization
+This repository contains implementation and documentation:
+- `docs/PRD.md`: Technical requirements and module layout.
+- `src/tsagentkit/`: Core Python packages such as `contracts/`, `qa/`, `series/`, `features/`, `router/`, `models/`, `backtest/`, `serving/`, `monitoring/`, and `skill/`.
+- `tests/`: Test suite mirroring the package structure (e.g., `tests/contracts/`).
+
+## Build, Test, and Development Commands
+- Run unit/integration tests: `uv run pytest`
+- Run real TSFM smoke tests (downloads models): `TSFM_RUN_REAL=1 uv run pytest -m tsfm`
+- Prefer single-entry commands (e.g., `python -m pytest`) over custom scripts unless needed.
+
+## Coding Style & Naming Conventions
+`tsagentkit` is intended to be a Python library (see `docs/PRD.md`). Until tooling is added, follow standard Python conventions:
+- Indentation: 4 spaces; no tabs.
+- Naming: `snake_case` for functions/variables, `PascalCase` for classes, `UPPER_SNAKE_CASE` for constants.
+- Types: add type hints for public APIs and key data structures.
+
+## Testing Guidelines
+- Prefer deterministic, time-order-safe cases (no random splits; see `E_SPLIT_RANDOM_FORBIDDEN` in the PRD).
+- Name tests descriptively (e.g., `test_router_fallback_ladder`).
+- Document test runner commands in this file and in the README.
+
+## Commit & Pull Request Guidelines
+Git history is minimal and uses short, plain summaries (e.g., “init”, “Initial commit”), so no formal convention is established. Use clear, imperative subject lines and keep each commit focused.
+
+For PRs:
+- Describe the change, scope, and any new modules.
+- Link related issues or PRDs when applicable.
+- Call out any deviations from the PRD or new guardrail behavior.
+
+## Agent-Specific Instructions
+If you add or update agent-facing documentation, place it under `skill/` and keep the “What/When/Inputs/Workflow” format described in `docs/PRD.md`.

tsagentkit-1.0.2/CLAUDE.md

@@ -0,0 +1,169 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+`tsagentkit` is a Python library that serves as a robust execution engine for external coding agents (LLMs/AI agents) performing time-series forecasting tasks. It provides strict guardrails to enforce proper time-series practices (preventing data leakage, enforcing temporal integrity, etc.).
+
+**Version**: 1.0.2 (Released)
+
+## Python Environment
+
+- Python version: 3.11
+- Dependencies: Listed in `pyproject.toml`.
+- Always use `uv` to manage dependencies.
+  - Add packages to `pyproject.toml` as needed.
+  - Use `uv sync` to install dependencies.
+  - Use `uv run <command>` to run commands with the correct environment.
+
+## Architecture
+
+The codebase follows this workflow pipeline:
+
+```
+validate -> QA -> series -> route -> backtest -> fit -> predict -> package
+```
+
+### Module Structure
+
+| Module | Responsibility | Key Output |
+|--------|---------------|------------|
+| `contracts/` | Data validation, task specifications | `ValidationReport`, `TaskSpec` |
+| `qa/` | Data quality checks, leakage detection | `QAReport` |
+| `series/` | Time alignment, resampling, sparsity ID | `TSDataset`, `SparsityProfile` |
+| `features/` | Feature engineering, covariate alignment | `FeatureMatrix`, signatures |
+| `router/` | Model selection, fallback strategies | `Plan` |
+| `models/` | Model adapters and baselines | `ModelArtifact`, `ForecastResult` |
+| `backtest/` | Rolling window backtesting | `BacktestReport`, `SegmentMetrics`, `TemporalMetrics` |
+| `serving/` | Batch inference | `RunArtifact` |
+| `monitoring/` | Drift detection, retrain triggers | `DriftReport` |
+| `skill/` | Documentation and recipes for AI agents | Recipes, tool maps |
+| `hierarchy/` | Hierarchical forecasting | `HierarchyStructure`, reconciliation methods |
+
+### Key Design Principles
+
+1. **TSFM-first Strategy**: Time-Series Foundation Models are the primary choice, with automatic fallback to simpler models on failure.
+
+2. **Fallback Ladder**: TSFM -> Lightweight (optional) -> Tree/Baseline -> Naive
+
+3. **Strict Guardrails**:
+   - `E_SPLIT_RANDOM_FORBIDDEN`: Random train/test splits are banned
+   - `E_COVARIATE_LEAKAGE`: Future leakage detection
+   - Temporal integrity enforced throughout
+
+4. **Provenance**: Full traceability with signatures for data, features, model config, and plan
+
+## Build, Test, and Development Commands
+
+### Running Tests
+
+```bash
+# Run all tests
+uv run python -m pytest
+
+# Run tests with coverage
+uv run python -m pytest --cov=src/tsagentkit --cov-report=term-missing
+
+# Run specific test file
+uv run python -m pytest tests/contracts/test_task_spec.py -v
+
+# Run tests for a specific module
+uv run python -m pytest tests/backtest/ -v
+```
+
+### Type Checking
+
+```bash
+# Run mypy type checker
+uv run mypy src/tsagentkit
+```
+
+### Code Formatting and Linting
+
+```bash
+# Format code with ruff
+uv run ruff format src/
+
+# Check code with ruff
+uv run ruff check src/
+
+# Fix auto-fixable issues
+uv run ruff check src/ --fix
+```
+
+### Running Examples
+
+```bash
+# Run a quick forecast example
+uv run python -c "
+import pandas as pd
+from tsagentkit import TaskSpec, run_forecast
+
+df = pd.DataFrame({
+    'unique_id': ['A'] * 30,
+    'ds': pd.date_range('2024-01-01', periods=30),
+    'y': range(30)
+})
+result = run_forecast(df, TaskSpec(h=7, freq='D'))
+print(result.summary())
+"
+```
+
+## Coding Conventions
+
+- **Language**: Python
+- **Indentation**: 4 spaces; no tabs
+- **Naming**: `snake_case` for functions/variables, `PascalCase` for classes, `UPPER_SNAKE_CASE` for constants
+- **Types**: Add type hints for public APIs and key data structures
+
+## Testing Guidelines
+
+- Place tests in a top-level `tests/` directory that mirrors the package structure (e.g., `tests/contracts/`)
+- Prefer deterministic, time-order-safe cases (no random splits; see `E_SPLIT_RANDOM_FORBIDDEN` in the PRD)
+- Name tests descriptively (e.g., `test_router_fallback_ladder`)
+
+## Key Documentation
+
+- `docs/PRD.md`: Technical requirements and architecture document
+- `AGENTS.md`: Repository guidelines for AI agents
+- `skill/README.md`: Agent documentation with module guide
+- `skill/tool_map.md`: Complete API reference
+- `skill/recipes.md`: Runnable end-to-end examples
+
+## Version Roadmap
+
+- **v0.1** ✅: Minimum loop (contracts, qa, series, basic router, baseline models, rolling backtest)
+- **v0.2** ✅: Enhanced robustness (monitoring, advanced router, feature hashing)
+- **v1.0** ✅: Ecosystem (external adapters, hierarchical reconciliation, structured logging)
+
+## Quick Reference
+
+### Common Imports
+
+```python
+from tsagentkit import (
+    TaskSpec,               # Define forecasting tasks
+    validate_contract,      # Validate input data
+    run_forecast,           # Main entry point
+    TSDataset,              # Time series dataset
+    Plan,                   # Execution plan
+    BacktestReport,         # Backtest results
+    # Errors
+    ESplitRandomForbidden,
+    ECovariateLeakage,
+)
+```
+
+### Main Entry Point
+
+```python
+from tsagentkit import TaskSpec, run_forecast
+
+spec = TaskSpec(h=7, freq="D", quantiles=[0.1, 0.5, 0.9])
+result = run_forecast(data, spec, mode="standard")
+
+# Access results
+forecast_df = result.forecast.df
+backtest_metrics = result.backtest_report.aggregate_metrics
+```