llm-pycascade 0.1.0__tar.gz

llm_pycascade-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,72 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Build
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

llm_pycascade-0.1.0/.github/workflows/rtd-publish.yml

@@ -0,0 +1,18 @@
+name: Publish to ReadTheDocs
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  trigger-rtd-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Trigger ReadTheDocs build
+        run: |
+          VERSION=${{ github.event.release.tag_name }}
+          curl -X POST \
+            -H "Authorization: Token ${{ secrets.RTD_TOKEN }}" \
+            -H "Content-Type: application/json" \
+            https://readthedocs.org/api/v3/projects/llm-pycascade/versions/$VERSION/builds/

llm_pycascade-0.1.0/.gitignore

@@ -0,0 +1,219 @@
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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
+.docs-venv/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

llm_pycascade-0.1.0/.kilo/plans/1784060424714-mkdocs-rtd-docs-plan.md

@@ -0,0 +1,240 @@
+# Plan: MkDocs Documentation Site for Read the Docs
+
+## Goal
+Create a Material-themed MkDocs documentation site for `llm-pycascade` that builds on Read the Docs (RTD), wired to the existing `.readthedocs.yaml` (which already declares `configuration: mkdocs.yml` but the file does not yet exist). API reference is auto-generated from docstrings via `mkdocstrings`.
+
+## Confirmed Decisions
+- **API reference**: auto-generated with `mkdocstrings[python]` (Google-style docstrings already present on all public symbols).
+- **Content**: dedicated, structured `docs/` site (README stays as the GitHub landing page).
+- **Theme/output**: `mkdocs-material`, HTML only.
+- **Config location**: `mkdocs.yml` at repo root (matches existing `.readthedocs.yaml`), Markdown pages under `docs/`.
+
+## Key Context Found in Code
+- Public API surface (`src/llm_pycascade/__init__.py`): `run_cascade`, `AppConfig`, `CascadeConfig`, `CascadeEntry`, `DatabaseConfig`, `FailureConfig`, `ProviderConfig`, `ProviderType`, `load_config`, `init_db`, `CascadeError`, `ProviderError`, `ContentBlock`, `Conversation`, `LlmResponse`, `Message`, `MessageRole`, `ToolDefinition`, `__version__`.
+- Modules to expose in reference: `cascade`, `config`, `models` (conversation/response/tool), `providers` (base + openai/anthropic/gemini/ollama), `error`, `db`, `persistence`, `secrets`.
+- RTD project slug = `llm-pycascade` (from `.github/workflows/rtd-publish.yml`). Site URL: `https://llm-pycascade.readthedocs.io/`. Repo: `https://github.com/paluigi/llm-pycascade`.
+- Python build target on RTD: `3.13` (per `.readthedocs.yaml`).
+- `config.example.toml` is a complete reference; reuse its content in the configuration page.
+
+## Docstring / API Notes (must follow to avoid broken examples)
+- `ContentBlockType` is NOT in `__all__`/`models.__init__`. In the tools guide import it explicitly: `from llm_pycascade.models.response import ContentBlockType`.
+- The README quickstart uses a fragile `config.database.path.replace("~", "/home/user")`. In the docs quickstart use robust expansion instead: `from llm_pycascade.config import expand_tilde` (or `os.path.expanduser`).
+
+---
+
+## File Inventory to Create
+
+```
+mkdocs.yml                         # root config (Material theme + mkdocstrings)
+docs/
+├── requirements.txt               # docs build deps
+├── index.md                       # landing/overview
+├── installation.md                # pip, uv, [keyring] extra, Python >=3.10
+├── quickstart.md                  # minimal runnable async example (robust path expansion)
+├── configuration.md               # TOML schema: providers, cascades, database, failure_persistence, LLM_PYCASCADE_CONFIG
+├── concepts.md                    # cascade, failover, cooldown/backoff table, Retry-After, persistence, attempt log
+├── providers.md                   # built-in providers, base_url override, OpenAI-compatible endpoints
+├── tools.md                       # tool/function calling guide (correct ContentBlockType import)
+├── secrets.md                     # keyring integration vs env vars, resolution order, mask_key
+├── error-handling.md             # ProviderError variants + properties, CascadeError, failed-prompt JSON
+├── changelog.md                   # v0.1.0 entry; link to GitHub releases
+└── reference/
+    ├── cascade.md                 # ::: llm_pycascade.cascade
+    ├── config.md                  # ::: llm_pycascade.config
+    ├── models.md                  # ::: llm_pycascade.models (+ conversation, response, tool)
+    ├── providers.md               # ::: llm_pycascade.providers (+ base + each impl)
+    ├── error.md                   # ::: llm_pycascade.error
+    ├── db.md                      # ::: llm_pycascade.db
+    ├── persistence.md             # ::: llm_pycascade.persistence
+    └── secrets.md                 # ::: llm_pycascade.secrets
+```
+
+## Files to Edit
+- `.readthedocs.yaml` — enable the commented-out `python.install` block so RTD installs docs deps **and** the project (so `mkdocstrings`/griffe can introspect it).
+
+---
+
+## mkdocs.yml (skeleton to implement)
+
+```yaml
+site_name: llm-pycascade
+site_url: https://llm-pycascade.readthedocs.io/
+site_description: Resilient cascading LLM inference with failover, circuit breaking, and retry cooldowns.
+site_author: Luigi
+repo_url: https://github.com/paluigi/llm-pycascade
+repo_name: paluigi/llm-pycascade
+edit_uri: edit/main/docs/
+
+docs_dir: docs
+
+theme:
+  name: material
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - navigation.indexes
+    - navigation.top
+    - content.code.copy
+    - content.code.annotate
+    - content.tabs.link
+    - search.suggest
+    - search.highlight
+    - toc.follow
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  icon:
+    repo: fontawesome/brands/github
+
+nav:
+  - Overview: index.md
+  - Installation: installation.md
+  - Quickstart: quickstart.md
+  - Configuration: configuration.md
+  - Concepts:
+      - How it works: concepts.md
+      - Providers: providers.md
+      - Tools & function calling: tools.md
+      - Secrets & keyring: secrets.md
+      - Error handling: error-handling.md
+  - API Reference:
+      - cascade: reference/cascade.md
+      - config: reference/config.md
+      - models: reference/models.md
+      - providers: reference/providers.md
+      - error: reference/error.md
+      - db: reference/db.md
+      - persistence: reference/persistence.md
+      - secrets: reference/secrets.md
+  - Changelog: changelog.md
+
+markdown_extensions:
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - tables
+  - toc:
+      permalink: true
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.snippets
+
+plugins:
+  - search
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          paths: [src]
+          options:
+            docstring_style: google
+            show_source: true
+            show_root_heading: true
+            show_root_full_path: false
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            show_signature_annotations: true
+            separate_signature: true
+            merge_init_into_class: true
+            heading_level: 2
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/paluigi/llm-pycascade
+  version:
+    provider: mike
+```
+
+> Note: `paths: [src]` lets griffe resolve `llm_pycascade` from source without a runtime import. Installing the package on RTD (via `python.install`) is still done as a safety net.
+
+## .readthedocs.yaml change
+
+Replace the commented `python:` block with:
+
+```yaml
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+```
+
+## docs/requirements.txt
+
+```
+mkdocs>=1.6
+mkdocs-material>=9.5
+mkdocstrings[python]>=0.26
+```
+
+(`mike` is intentionally NOT required; `version.provider: mike` is a no-op on RTD unless configured — drop the `extra.version` block if you prefer zero-unused config.)
+
+## Reference page content (each `reference/*.md`)
+Each file is one or more `mkdocstrings` cross-references, e.g. `reference/models.md`:
+
+```markdown
+# Models
+
+::: llm_pycascade.models
+::: llm_pycascade.models.conversation
+::: llm_pycascade.models.response
+::: llm_pycascade.models.tool
+```
+
+- `reference/cascade.md` → `::: llm_pycascade.cascade`
+- `reference/config.md` → `::: llm_pycascade.config`
+- `reference/providers.md` → `::: llm_pycascade.providers` + `::: llm_pycascade.providers.base` + each of openai/anthropic/gemini/ollama
+- `reference/error.md` → `::: llm_pycascade.error`
+- `reference/db.md` → `::: llm_pycascade.db`
+- `reference/persistence.md` → `::: llm_pycascade.persistence`
+- `reference/secrets.md` → `::: llm_pycascade.secrets`
+
+## Written-page content guidance
+- **index.md**: 2–3 sentence pitch (from README tagline), feature bullets, badges (CI / RTD / PyPI / license), "next steps" links into Quickstart & Configuration.
+- **installation.md**: `pip install`, `uv add`, the `[keyring]` extra, Python ≥3.10 requirement.
+- **quickstart.md**: copy/adapt README basic example but use robust path expansion; show both a plain prompt and how to read `response.text_only()`.
+- **configuration.md**: explain the search order (`LLM_PYCASCADE_CONFIG` → XDG → legacy), embed `config.example.toml` content with per-section explanation.
+- **concepts.md**: reuse README architecture ASCII diagram + cooldown/backoff table + Retry-After behavior + persistence behavior + SQLite tables (`attempt_log`, `cooldown`).
+- **providers.md**: list built-in providers, default base URLs, `base_url` override for OpenAI-compatible (vLLM/LiteLLM/Together), Ollama needing no key.
+- **tools.md**: tool/function-calling guide; correct `ContentBlockType` import; show iterating `response.content`.
+- **secrets.md**: `resolve_api_key` resolution order (keyring → env), `set_key`/`get_key`/`has_key`/`delete_key`, `mask_key`, qualified service name `llm-pycascade/<provider>`.
+- **error-handling.md**: `ProviderError` variants (http/request/parse/missing_api_key/other), `http_status`/`retry_after_seconds` props, `CascadeError` + failed-prompt path.
+- **changelog.md**: initial "v0.1.0 — initial release" entry; link to GitHub Releases.
+
+---
+
+## Validation (run before finishing)
+1. Create an isolated env and install docs deps + project:
+   `uv pip install -r docs/requirements.txt && uv pip install -e .` (or `pip install -r docs/requirements.txt && pip install -e .`).
+2. `mkdocs build --strict` from repo root — must pass with zero warnings (catches broken nav, bad `:::` refs, dead links).
+3. `mkdocs serve` — spot-check nav, code highlighting, API reference rendering, dark/light toggle.
+4. After push: RTD builds automatically on every push to `main`; confirm the build at the RTD dashboard. (The `rtd-publish.yml` release-trigger is an additional versioned-build trigger.)
+
+## Risks / Gotchas
+- If `mkdocs build --strict` fails on `:::` refs, confirm the module path is importable from `src` (griffe `paths: [src]`) — installing the package (`pip install -e .`) resolves this.
+- `extra.version.provider: mike` does nothing without `mike` installed; remove it if unused to keep config honest.
+- Keep `mkdocs.yml` at repo root (NOT in `docs/`) — `.readthedocs.yaml` already expects it there.
+
+## Out of Scope
+- Versioned docs hosting via `mike` (can be added later).
+- PDF export.
+- i18n / translations.
+- Any source-code logic changes (doc-only, except the `.readthedocs.yaml` config edit).

llm_pycascade-0.1.0/.readthedocs.yaml

@@ -0,0 +1,24 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation with Mkdocs
+mkdocs:
+   configuration: mkdocs.yml
+
+# Declare the Python requirements required to build your documentation.
+# The project itself is also installed so mkdocstrings can introspect it.
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

llm_pycascade-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Luigi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.