mirascope 1.23.3__tar.gz → 1.23.4__tar.gz

{mirascope-1.23.3 → mirascope-1.23.4}/.github/CODEOWNERS

@@ -4,8 +4,5 @@
 # Python Owner
 *.py        @willbakst
 
-# Documentation Owner
-/docs/      @willbakst
-
 # Examples Owner
 /examples/  @willbakst

{mirascope-1.23.3 → mirascope-1.23.4}/.github/workflows/lint.yml

@@ -19,8 +19,6 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: codespell-project/actions-codespell@v2
-        with:
-          exclude_file: "docs/tutorials/evals/evaluating_web_search_agent.ipynb,docs/tutorials/agents/web_search_agent.ipynb,docs/tutorials/more_advanced/knowledge_graph.ipynb"
 
       - name: Set up uv
         run: curl -LsSf https://astral.sh/uv/0.6.10/install.sh | sh

{mirascope-1.23.3 → mirascope-1.23.4}/.pre-commit-config.yaml

@@ -5,7 +5,6 @@ repos:
       - id: codespell
         additional_dependencies:
           - tomli
-        exclude: "docs/tutorials/more_advanced/knowledge_graph.ipynb|docs/tutorials/evals/evaluating_web_search_agent.ipynb|docs/tutorials/agents/web_search_agent.ipynb|docs/blog/posts/llm-prompt.md"
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: "v0.9.7"
     hooks:

{mirascope-1.23.3 → mirascope-1.23.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mirascope
-Version: 1.23.3
+Version: 1.23.4
 Summary: LLM abstractions that aren't obstructions
 Project-URL: Homepage, https://mirascope.com
 Project-URL: Documentation, https://mirascope.com/WELCOME
@@ -101,19 +101,19 @@ Provides-Extra: xai
 Requires-Dist: openai<2,>=1.6.0; extra == 'xai'
 Description-Content-Type: text/markdown
 
-<div align="center" justiry="start">
-    <a href="https://mirascope.com">
-        <img align="bottom" src="https://github.com/Mirascope/mirascope/assets/99370834/e403d7ee-f8bc-4df1-b2d0-33763f021c89" alt="Frog Logo" width="84"/><br><img align="bottom" src="https://uploads-ssl.webflow.com/65a6fd6a1c3b2704d6217d3d/65b5674e9ceef563dc57eb11_Medium%20length%20hero%20headline%20goes%20here.svg" width="400" alt="Mirascope"/>
+<p align="center">
+    <a href="https://mirascope.com/#mirascope">
+        <img src="https://github.com/user-attachments/assets/58b04850-8f30-40a6-be68-96ed2aa9b6d8" />
     </a>
-</div>
+</p>
 
 <p align="center">
     <a href="https://github.com/Mirascope/mirascope/actions/workflows/tests.yml" target="_blank"><img src="https://github.com/Mirascope/mirascope/actions/workflows/tests.yml/badge.svg?branch=main" alt="Tests"/></a>
     <a href="https://codecov.io/github/Mirascope/mirascope" target="_blank"><img src="https://codecov.io/github/Mirascope/mirascope/graph/badge.svg?token=HAEAWT3KC9" alt="Coverage"/></a>
-    <a href="https://mirascope.com/WELCOME" target="_blank"><img src="https://img.shields.io/badge/docs-available-brightgreen" alt="Docs"/></a>
+    <a href="https://mirascope.com/docs/mirascope" target="_blank"><img src="https://img.shields.io/badge/docs-available-brightgreen" alt="Docs"/></a>
     <a href="https://pypi.python.org/pypi/mirascope" target="_blank"><img src="https://img.shields.io/pypi/v/mirascope.svg" alt="PyPI Version"/></a>
     <a href="https://pypi.python.org/pypi/mirascope" target="_blank"><img src="https://img.shields.io/pypi/pyversions/mirascope.svg" alt="Stars"/></a>
-    <a href="https://github.com/Mirascope/mirascope/blog/dev/LICENSE"><img src="https://img.shields.io/github/license/Mirascope/mirascope.svg" alt="License"/></a>
+    <a href="https://github.com/Mirascope/mirascope/tree/main/LICENSE"><img src="https://img.shields.io/github/license/Mirascope/mirascope.svg" alt="License"/></a>
     <a href="https://github.com/Mirascope/mirascope/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/Mirascope/mirascope.svg" alt="Stars"/></a>
 </p>
 

{mirascope-1.23.3 → mirascope-1.23.4}/README.md

@@ -1,16 +1,16 @@
-<div align="center" justiry="start">
-    <a href="https://mirascope.com">
-        <img align="bottom" src="https://github.com/Mirascope/mirascope/assets/99370834/e403d7ee-f8bc-4df1-b2d0-33763f021c89" alt="Frog Logo" width="84"/><br><img align="bottom" src="https://uploads-ssl.webflow.com/65a6fd6a1c3b2704d6217d3d/65b5674e9ceef563dc57eb11_Medium%20length%20hero%20headline%20goes%20here.svg" width="400" alt="Mirascope"/>
+<p align="center">
+    <a href="https://mirascope.com/#mirascope">
+        <img src="https://github.com/user-attachments/assets/58b04850-8f30-40a6-be68-96ed2aa9b6d8" />
     </a>
-</div>
+</p>
 
 <p align="center">
     <a href="https://github.com/Mirascope/mirascope/actions/workflows/tests.yml" target="_blank"><img src="https://github.com/Mirascope/mirascope/actions/workflows/tests.yml/badge.svg?branch=main" alt="Tests"/></a>
     <a href="https://codecov.io/github/Mirascope/mirascope" target="_blank"><img src="https://codecov.io/github/Mirascope/mirascope/graph/badge.svg?token=HAEAWT3KC9" alt="Coverage"/></a>
-    <a href="https://mirascope.com/WELCOME" target="_blank"><img src="https://img.shields.io/badge/docs-available-brightgreen" alt="Docs"/></a>
+    <a href="https://mirascope.com/docs/mirascope" target="_blank"><img src="https://img.shields.io/badge/docs-available-brightgreen" alt="Docs"/></a>
     <a href="https://pypi.python.org/pypi/mirascope" target="_blank"><img src="https://img.shields.io/pypi/v/mirascope.svg" alt="PyPI Version"/></a>
     <a href="https://pypi.python.org/pypi/mirascope" target="_blank"><img src="https://img.shields.io/pypi/pyversions/mirascope.svg" alt="Stars"/></a>
-    <a href="https://github.com/Mirascope/mirascope/blog/dev/LICENSE"><img src="https://img.shields.io/github/license/Mirascope/mirascope.svg" alt="License"/></a>
+    <a href="https://github.com/Mirascope/mirascope/tree/main/LICENSE"><img src="https://img.shields.io/github/license/Mirascope/mirascope.svg" alt="License"/></a>
     <a href="https://github.com/Mirascope/mirascope/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/Mirascope/mirascope.svg" alt="Stars"/></a>
 </p>
 

mirascope-1.23.4/api_ref/llm/call_response.md

@@ -0,0 +1,3 @@
+# mirascope.llm.call_response
+
+::: mirascope.llm.call_repsonse

mirascope-1.23.4/api_ref/llm/call_response_chunk.md

@@ -0,0 +1,3 @@
+# mirascope.llm.call_response_chunk
+
+::: mirascope.llm.call_repsonse_chunk

mirascope-1.23.4/api_ref/llm/context.md

@@ -0,0 +1,3 @@
+# mirascope.llm.context
+
+::: mirascope.llm.context

mirascope-1.23.4/api_ref/llm/override.md

@@ -0,0 +1,3 @@
+# mirascope.llm.override
+
+::: mirascope.llm.override

mirascope-1.23.4/api_ref/llm/stream.md

@@ -0,0 +1,3 @@
+# mirascope.llm.stream
+
+::: mirascope.llm.stream

mirascope-1.23.4/api_ref/llm/tool.md

@@ -0,0 +1,3 @@
+# mirascope.llm.tool
+
+::: mirascope.llm.tool

mirascope-1.23.4/api_ref/mcp/client.md

@@ -0,0 +1,3 @@
+# mirascope.mcp.client
+
+::: mirascope.mcp.client

mirascope-1.23.4/api_ref/retries/fallback.md

@@ -0,0 +1,3 @@
+# mirascope.retries.fallback
+
+::: mirascope.retries.fallback

mirascope-1.23.4/api_ref/retries/tenacity.md

@@ -0,0 +1,3 @@
+# mirascope.retries.tenacity
+
+::: mirascope.retries.tenacity

{mirascope-1.23.3 → mirascope-1.23.4}/mirascope/llm/__init__.py

@@ -3,11 +3,13 @@ from ._call import call
 from ._context import context
 from ._override import override
 from .call_response import CallResponse
+from .call_response_chunk import CallResponseChunk
 from .stream import Stream
 from .tool import Tool
 
 __all__ = [
     "CallResponse",
+    "CallResponseChunk",
     "CostMetadata",
     "LocalProvider",
     "Provider",

{mirascope-1.23.3 → mirascope-1.23.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mirascope"
-version = "1.23.3"
+version = "1.23.4"
 description = "LLM abstractions that aren't obstructions"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -209,7 +209,7 @@ venvPath = "."
 venv = ".venv"
 
 [tool.codespell]
-skip = [".git", "*.lock", "./docs/blog/posts/llm-prompt.md"]
+skip = [".git", "*.lock"]
 ignore-words-list = 'EHR,reworkd,ROUGE,rouge,Rouge'
 ignore-regex = 'and buyed some milk'
 

{mirascope-1.23.3 → mirascope-1.23.4}/uv.lock

@@ -3170,7 +3170,7 @@ wheels = [
 
 [[package]]
 name = "mirascope"
-version = "1.23.2"
+version = "1.23.4"
 source = { editable = "." }
 dependencies = [
     { name = "docstring-parser" },

mirascope-1.23.3/.github/workflows/docs.yml

@@ -1,38 +0,0 @@
-name: ci
-on:
-  push:
-    branches:
-      - main
-permissions:
-  contents: write
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up uv
-        run: curl -LsSf https://astral.sh/uv/0.6.10/install.sh | sh
-
-      - name: Set up Python
-        run: uv python install 3.10
-
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-
-      - name: Generate llms.txt
-        run: uv run python docs/generate_llms_txt.py
-
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-
-      - uses: actions/cache@v4
-        with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-
-      - run: uv run mkdocs gh-deploy --force

mirascope-1.23.3/docs/CNAME

@@ -1 +0,0 @@
-mirascope.com

mirascope-1.23.3/docs/CONTRIBUTING.md

@@ -1,192 +0,0 @@
-# Contributing
-
-## Setting Up Development Environment
-
-We use [uv](https://docs.astral.sh/uv/) as our package and dependency manager.
-
-### Installation
-
-First, install `uv` using the official method:
-
-**macOS and Linux**
-
-```sh
-curl -LsSf https://astral.sh/uv/install.sh | sh
-```
-
-**Windows**
-
-```powershell
-powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
-```
-
-For more detailed instructions, refer to the [official uv setup guide](https://docs.astral.sh/uv/#getting-started).
-
-### Create a Virtual Environment
-
-After installing `uv`, create a virtual environment for development by running:
-
-```sh
-uv sync --all-extras --dev
-```
-
-### Pre-commit Setup
-
-To set up pre-commit hooks, run the following command:
-
-```sh
-uv run pre-commit install --install-hooks
-```
-
-This will ensure that your code is automatically checked and formatted before each commit.
-
-## Development Workflow
-
-1. Search through existing [GitHub Issues](https://github.com/Mirascope/mirascope/issues) to see if what you want to work on has already been added.
-
-    - If not, please create a new issue. This will help to reduce duplicated work.
-
-2. For first-time contributors, visit [https://github.com/mirascope/mirascope](https://github.com/Mirascope/mirascope) and "Fork" the repository (see the button in the top right corner).
-
-    - You'll need to set up [SSH authentication](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
-
-    - Clone the forked project and point it to the main project:
-
-    ```shell
-    git clone https://github.com/<your-username>/mirascope.git
-    git remote add upstream https://github.com/Mirascope/mirascope.git
-    ```
-
-3. Development.
-
-    - Make sure you are in sync with the main repo:
-
-    ```shell
-    # for anything that only requires a fix version bump (e.g. bug fixes)
-    git checkout main
-    git pull upstream main
-
-    # for anything that is "new" and requires at least a minor version bump
-    git checkout release/vX.Y  # replace X with the current major version and Y with the next minor version
-    git pull upstream release/vX.Y
-    ```
-
-    - Create a `git` feature branch with a meaningful name where you will add your contributions.
-
-    ```shell
-    git checkout -b meaningful-branch-name
-    ```
-
-    - Start coding! commit your changes locally as you work:
-
-    ```shell
-    git add mirascope/modified_file.py tests/test_modified_file.py
-    git commit -m "feat: specific description of changes contained in commit"
-    ```
-
-    - Format your code!
-
-    ```shell
-    uv run ruff format .
-    ```
-
-    - Lint and test your code! From the base directory, run:
-
-    ```shell
-    uv run ruff check .
-    uv run pyright .
-    ```
-
-4. Test!
-
-    - Add tests. Tests should be mirrored based on structure of the source.
-
-    ```bash
-    | - mirascope
-    |  | - core
-    |  |  | - openai
-    |  |  |  | - ...
-    | - tests
-    |  | - core
-    |  |  | - openai
-    |  |  |  | - ...
-    ```
-  
-    - Run tests to make sure nothing is broken
-
-    ```shell
-    uv run pytest tests/
-    ```
-
-    - Check coverage report
-
-    ```shell
-    uv run pytest tests/ --cov=./ --cov-report=html
-    ```
-
-5. Contributions are submitted through [GitHub Pull Requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
-
-    - When you are ready to submit your contribution for review, push your branch:
-
-    ```shell
-    git push origin meaningful-branch-name
-    ```
-
-    - Open the printed URL to open a PR.
-    - Fill in a detailed title and description.
-    - Check box to allow edits from maintainers
-    - Submit your PR for review. You can do this via Contribute in your fork repo.
-    - Link the issue you selected or created under "Development"
-    - We will review your contribution and add any comments to the PR. Commit any updates you make in response to comments and push them to the branch (they will be automatically included in the PR)
-
-### Pull Requests
-
-Please conform to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for all PR titles and commits.
-
-## Documentation
-
-We care deeply about maintaining high-quality, up-to-date documentation. This means that all PRs must include corresponding changes to the documentation (if any changes were necessary).
-
-The documentation lives in the [docs/](https://github.com/Mirascope/mirascope/tree/main/docs) directory, which can be built by running `uv run mkdocs serve`.
-
-### Fast Docs Development
-
-For faster local documentation development, we provide a script that automatically creates a modified configuration without slow plugins. It can be invoked via: 
-
-```shell
-# Run the fast docs development server
-uv run python scripts/serve_docs_dev.py
-```
-
-Under the hood, this script disables the `social` and `mkdocs-jupyter` plugins, and sets `strict: false`, which significantly speeds up rebuild times during development.
-
-### Documentation Notes
-
-1. We have code examples in the `examples` folder for all code snippets in the documentation, and we maintain snippets for every option (e.g. prompt writing methods, providers, etc.). While this seems unnecessarily cumbersome, these examples operate as tests for type hints because we run `pyright` on all of the examples. When writing documentation that changes existing examples or requires new examples, make sure to properly update the actual code in the `examples/` directory to match the existing structure.
-2. The API reference is generated automatically, but things like new modules still need to be included in the `docs/api` structure for generation to work.
-3. The `docs/tutorials` are written as Jupyter notebooks that get converted into markdown. This conversion will happen on every save when running the server locally, which can make writing docs slow. We recommend using the fast docs development script to address this.
-
-!!! tip "MacOS Users Will Need `cairo`
-
-    If you're developing using MacOS, you'll need to follow these steps:
-
-    1. `brew install cairo`
-    2. `export PKG_CONFIG_PATH="/usr/local/lib/pkgconfig:/opt/homebrew/lib/pkgconfig:$PKG_CONFIG_PATH"`
-    3. `export DYLD_LIBRARY_PATH="/usr/local/lib:/opt/homebrew/lib:$DYLD_LIBRARY_PATH"`
-    4. `source ~/.bash_profile`
-
-## Testing
-
-All changes to the codebase must be properly unit tested. If a change requires updating an existing unit test, make sure to think through if the change is breaking.
-
-We use `pytest` as our testing framework. If you haven't worked with it before, take a look at [their docs](https://docs.pytest.org/).
-
-Furthermore, we have a full coverage requirement, so all incoming code must have 100% coverage. This policy ensures that every line of code is run in our tests. However, while achieving full coverage is essential, it is not sufficient on its own. Coverage metrics ensure code execution but do not guarantee correctness under all conditions. Make sure to stress test beyond coverage to reduce bugs.
-
-We use a [Codecov dashboard](https://app.codecov.io/github/Mirascope/mirascope/tree/main) to monitor and track our coverage.
-
-## Formatting and Linting
-
-In an effort to keep the codebase clean and easy to work with, we use `ruff` for formatting and both `ruff` and `pyright` for linting. Before sending any PR for review, make sure to run both `ruff` and `pyright`.
-
-If you are using VS Code, then install the extensions in `.vscode/extensions.json` and the workspace settings should automatically run `ruff` formatting on save and show `ruff` and `pyright` errors.

mirascope-1.23.3/docs/HELP.md

@@ -1,75 +0,0 @@
-# Help
-
-## Getting help with Mirascope
-
-If you need help getting started with **Mirascope** or with advanced usage, the following sources may be useful.
-
-### :simple-slack: Slack
-
-The [Mirascope Slack](https://join.slack.com/t/mirascope-community/shared_invite/zt-2ilqhvmki-FB6LWluInUCkkjYD3oSjNA) is a great place to ask questions and get help and chat about Mirascope.
-
-### :material-help: Usage Documentation
-
-The [Learn](./learn/index.md) documentation is the most complete guide on how to get started with **Mirascope**.
-
-### :material-api: SDK API Documentation
-
-The [API Reference](./api/core/anthropic/call.md) give reference docs for the **Mirascope** library, auto-generated directly from the code so it's always up-to-date.
-
-### :simple-github: GitHub Issues
-
-The [Mirascope GitHub Issues](https://github.com/Mirascope/mirascope/issues) are a great place to ask questions and give us feedback.
-
-### :material-email: Email
-
-You can also email us at [support@mirascope.com](mailto:support@mirascope.com) or [feedback@mirascope.com](mailto:feedback@mirascope.com).
-
-
-## How *you* can help Mirascope
-
-### Star Mirascope on GitHub
-
-⭐️ You can "star" Mirascope on [GitHub](https://github.com/mirascope/mirascope) ⭐️
-
-### Connect with the authors
-
--   Follow us on GitHub
-    -   See other related Open Source projects that might help you with machine learning
--   Follow William Bakst on [Twitter/X](https://twitter.com/WilliamBakst)
-    -   Tell me how you use mirascope
-    -   Hear about new announcements or releases
--   Connect with William Bakst on [LinkedIn](https://www.linkedin.com/in/wbakst/)
-    -   Give me any feedback or suggestions about what we're building
-
-### Post about Mirascope
-
--   Twitter, Reddit, Hackernews, LinkedIn, and others.
--   We love to hear about how Mirascope has helped you and how you are using it.
-
-### Help Others
-
-We are a kind and welcoming community that encourages you to help others with their questions on GitHub Issues or in our Slack Community.
-
--   Guide for asking questions
-    -   First, search through issues and discussions to see if others have faced similar issues
-    -   Be as specific as possible, add minimal reproducible example
-    -   List out things you have tried, errors, etc
-    -   Close the issue if your question has been successfully answered
--   Guide for answering questions
-    -   Understand the question, ask clarifying questions
-    -   If there is sample code, reproduce the issue with code given by original poster
-    -   Give them solution or possibly an alternative that might be better than what original poster is trying to do
-    -   Ask original poster to close the issue
-
-### Review Pull Requests
-
-You are encouraged to review any pull requests. Here is a guideline on how to review a pull request:
-
--   Understand the problem the pull request is trying to solve
--   Ask clarification questions to determine whether the pull request belongs in the package
--   Check the code, run it locally, see if it solves the problem described by the pull request
--   Add a comment with screenshots or accompanying code to verify that you have tested it
--   Check for tests
-    -   Request the original poster to add tests if they do not exist
-    -   Check that tests fail before the PR and succeed after
--   This will greatly speed up the review process for a PR and will ultimately make Mirascope a better package