Merge branch 'main' into feature/sambanovacloud_integration

.github/workflows/pyright.yml

@@ -21,29 +21,13 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Cache Poetry virtualenv
-        uses: actions/cache@v2
-        with:
-          path: ~/.cache/pypoetry/virtualenvs
-          key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-poetry-
-
-      - name: Install Poetry
-        uses: snok/[email protected]
-
-      - name: Install dependencies
-        run: poetry install --with dev,anthropic
-
-      - name: Add poetry to PATH
-        run: echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
-
-      - uses: jakebailey/pyright-action@v2
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          version: 1.1.373
+          enable-cache: true
+      - name: Set up Python
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install the project
+        run: uv sync --all-extras
+      - name: Run pyright
+        run: uv run pyright

.github/workflows/python-publish.yml

@@ -21,21 +21,17 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          python-version: '3.10' 
-
-      - name: Install Poetry
-        uses: snok/[email protected]
-        env:
-          ACTIONS_ALLOW_UNSECURE_COMMANDS: 'true'
-
-      - name: Get release version
-        run: echo "RELEASE_VERSION=$(poetry version | awk '{print $2}')" >> $GITHUB_ENV
-
+          enable-cache: true
+      - name: Set up Python
+        run: uv python install 3.10
+      - name: Install the project
+        run: uv sync --all-extras
+      - name: Build the project
+        run: uv build
       - name: Build and publish Python package
-        run: poetry publish --build
+        run: uv publish
         env:
-          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}

.github/workflows/ruff.yml

@@ -20,16 +20,14 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-      - name: Environment setup
-        uses: actions/setup-python@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          python-version: 3.9
-          cache: "pip"
-      - name: Install dev dependencies
-        run: |
-          python3 -m pip install --upgrade pip setuptools wheel
-          python3 -m pip install -r requirements.txt
-          python3 -m pip install -r requirements-doc.txt
+          enable-cache: true
+      - name: Set up Python
+        run: uv python install 3.9
+      - name: Install the project
+        run: uv sync --all-extras
       - name: Run Continuous Integration Action
         uses: astral-sh/ruff-action@v1
       - name: Upload Artifacts

.github/workflows/test.yml

@@ -15,40 +15,34 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Cache Poetry virtualenv
-        uses: actions/cache@v2
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          path: ~/.cache/pypoetry/virtualenvs
-          key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-poetry-
-
-      - name: Install Poetry
-        uses: snok/[email protected]
-
-      - name: Install dependencies
-        run: poetry install --with dev,anthropic
-
+          enable-cache: true
+      - name: Set up Python
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install the project
+        run: uv sync --all-extras
       - name: Run tests
         if: matrix.python-version != '3.11'
-        run: poetry run pytest tests/ -k 'not llm and not openai and not gemini and not anthropic and not cohere and not vertexai' && poetry run pytest tests/llm/test_cohere
+        run: uv run pytest tests/ -k 'not llm and not openai and not gemini and not anthropic and not cohere and not vertexai'
         env:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
           ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
           COHERE_API_KEY: ${{ secrets.COHERE_API_KEY }}
 
+      - name: Run Gemini Tests
+        if: matrix.python-version == '3.11'
+        run: uv run pytest tests/llm/test_gemini
+        env:
+          GOOGLE_API_KEY: ${{ secrets.GOOGLE_API_KEY }}
+
       - name: Generate coverage report
         if: matrix.python-version == '3.11'
         run: |
-          poetry run coverage run -m pytest tests/ -k "not docs and not anthropic and not gemini and not cohere and not vertexai and not fireworks"
-          poetry run coverage report
-          poetry run coverage html
+          uv run coverage run -m pytest tests/ -k "not docs and not anthropic and not gemini and not cohere and not vertexai and not fireworks"
+          uv run coverage report
+          uv run coverage html
         env:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
           ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}

.github/workflows/test_docs.yml

@@ -28,18 +28,10 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           cache: "poetry"
-
-      - name: Cache Poetry virtualenv
-        uses: actions/cache@v2
-        with:
-          path: ~/.cache/pypoetry/virtualenvs
-          key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-poetry-
-
-      - name: Install dependencies
-        run: poetry install --with dev,docs,test-docs,anthropic,google-generativeai
-
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+      - name: Install the project
+        run: uv sync --all-extras
       - name: Run tests
         run: poetry run pytest tests/llm/test_openai/docs
         env:

README.md

@@ -1,6 +1,6 @@
 # Instructor, The Most Popular Library for Simple Structured Outputs
 
-Instructor is the most popular Python library for working with structured outputs from large language models (LLMs), boasting over 600,000 monthly downloads. Built on top of Pydantic, it provides a simple, transparent, and user-friendly API to manage validation, retries, and streaming responses. Get ready to supercharge your LLM workflows with the community's top choice!
+Instructor is the most popular Python library for working with structured outputs from large language models (LLMs), boasting over 1 million monthly downloads. Built on top of Pydantic, it provides a simple, transparent, and user-friendly API to manage validation, retries, and streaming responses. Get ready to supercharge your LLM workflows with the community's top choice!
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/jxnlco?style=social)](https://twitter.com/jxnlco)
 [![Discord](https://img.shields.io/discord/1192334452110659664?label=discord)](https://discord.gg/bD9YE9JArw)
@@ -131,9 +131,10 @@ user_info = client.chat.completions.create(
 
 print(f"Name: {user_info.name}, Age: {user_info.age}")
 #> Name: John, Age: 20
-``` 
+```
 
 This example demonstrates:
+
 1. A pre-execution hook that logs all kwargs passed to the function.
 2. An exception hook that logs any exceptions that occur during execution.
 
@@ -513,6 +514,14 @@ We invite you to contribute to evals in `pytest` as a way to monitor the quality
 
 If you want to help, checkout some of the issues marked as `good-first-issue` or `help-wanted` found [here](https://github.com/jxnl/instructor/labels/good%20first%20issue). They could be anything from code improvements, a guest blog post, or a new cookbook.
 
+Here's a quick list of commands that you can run to get started. We're using `uv` to manage our dependencies so make sure you have that installed.
+
+1. `uv sync --all-extras --group <dependency groups you'd like to install>`: This should install all the dependencies for the project using `uv`, make sure to install the specific dependencies that you'd like to install
+
+2. `uv run pytest` : This runs the tests in `pytest`. If you're pushing up a new PR, make sure that you've written some tests and that they're passing locally for you
+
+We use `ruff` and `pyright` for linting and type checking so make sure those are passing when you push up a PR. You can check pyright by running `uv run pyright` and ruff with `uv run ruff check` locally.
+
 ## CLI
 
 We also provide some added CLI functionality for easy convenience:
@@ -538,6 +547,6 @@ This project is licensed under the terms of the MIT License.
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-<a href="https://github.com/jxnl/instructor/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=jxnl/instructor" />
+<a href="https://github.com/instructor-ai/instructor/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=instructor-ai/instructor" />
 </a>