meilisearch-python-sdk 3.3.0__tar.gz → 3.5.0__tar.gz

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/.github/workflows/nightly_testing.yml

@@ -4,6 +4,9 @@ on:
   schedule:
     # Set with UTC time
     - cron: "0 5 * * *"
+env:
+  UV_CACHE_DIR: /tmp/.uv-cache
+  PYTHON_VERSION: "3.12"
 jobs:
   random-test-order:
     strategy:
@@ -18,7 +21,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.12
+          python-version: ${{ env.PYTHON_VERSION }}
       - name: Restore uv cache
         uses: actions/cache@v4
         with:
@@ -30,7 +33,7 @@ jobs:
       - name: Install Dependencies
         run: |
           just install
-          uv add --dev pytest-randomly
+          uv pip install pytest-randomly
       - name: Test with pytest in random order
         run: just test-ci
       - name: Minimize uv cache

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/.github/workflows/pypi_publish.yaml

@@ -3,6 +3,8 @@ on:
   release:
     types:
       - published
+env:
+  PYTHON_VERSION: "3.12"
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -13,7 +15,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.12
+          python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Dependencies
         run: uv sync --frozen --all-extras
       - name: Build and publish package

meilisearch_python_sdk-3.5.0/.github/workflows/testing.yaml

@@ -0,0 +1,260 @@
+name: Testing
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+env:
+  UV_CACHE_DIR: /tmp/.uv-cache
+  PYTHON_VERSION: "3.9"
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install Just
+        uses: taiki-e/install-action@just
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+      - name: Install Dependencies
+        run: just install
+      - name: mypy check
+        run: just mypy
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+
+  parallel-testing:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13-dev"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install Just
+        uses: taiki-e/install-action@just
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+      - name: Install Dependencies
+        run: just install
+      - name: Test with pytest
+        run: just test-parallel-ci
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+
+  parallel-testing-http2:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13-dev"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install Just
+        uses: taiki-e/install-action@just
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+      - name: Install Dependencies
+        run: just install
+      - name: Install truststore
+        if: ${{ ! startsWith(matrix.python-version, '3.9') }}
+        run: uv pip install truststore
+      - name: Install ssl requirements
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libnss3-tools build-essential gcc
+          /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
+          brew install mkcert
+          mkcert -install
+          mkcert -key-file meilisearch.key -cert-file meilisearch.crt localhost 127.0.0.1 ::1
+      - name: Test with pytest
+        run: just test-parallel-ci-http2
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+
+  no-parallel-testing:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13-dev"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install Just
+        uses: taiki-e/install-action@just
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+      - name: Install Dependencies
+        run: just install
+      - name: Test with pytest
+        run: just test-no-parallel-ci
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+
+  no-parallel-testing-http2:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13-dev"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install Just
+        uses: taiki-e/install-action@just
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+      - name: Install Dependencies
+        run: just install
+      - name: Install truststore
+        if: ${{ ! startsWith(matrix.python-version, '3.9') }}
+        run: uv pip install truststore
+      - name: Install ssl requirements
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libnss3-tools build-essential gcc
+          /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
+          brew install mkcert
+          mkcert -install
+          mkcert -key-file meilisearch.key -cert-file meilisearch.crt localhost 127.0.0.1 ::1
+      - name: Test with pytest
+        run: just test-no-parallel-ci-http2
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+  example-testing:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13-dev"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install Just
+        uses: taiki-e/install-action@just
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+      - name: Test with pytest
+        run: just test-examples-ci
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install Just
+        uses: taiki-e/install-action@just
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+      - name: Install Dependencies
+        run: just install
+      - name: Test Docs Build
+        run: just build-docs
+      - name: Minimize uv cache
+        run: uv cache prune --ci

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/.gitignore

@@ -1,3 +1,5 @@
+meilisearch.crt
+meilisearch.key
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/.pre-commit-config.yaml

@@ -9,12 +9,12 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.1
+    rev: v1.11.2
     hooks:
       - id: mypy
         additional_dependencies: [pydantic, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.1
+    rev: v0.6.5
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/CONTRIBUTING.md

@@ -52,7 +52,7 @@ need to install it with the instructions [here](https://docs.astral.sh/uv/gettin
 First the requirements need to be installed.
 
 ```sh
-uv sync --locked --all-extras
+uv sync --frozen --all-extras
 ```
 
 ### Creating a branch

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: meilisearch-python-sdk
-Version: 3.3.0
+Version: 3.5.0
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Project-URL: repository, https://github.com/sanders41/meilisearch-python-sdk
 Project-URL: homepage, https://github.com/sanders41/meilisearch-python-sdk
@@ -42,7 +42,7 @@ Requires-Python: >=3.9
 Requires-Dist: aiofiles>=0.7
 Requires-Dist: camel-converter>=1.0.0
 Requires-Dist: eval-type-backport>=0.2.0; python_version < '3.10'
-Requires-Dist: httpx>=0.17
+Requires-Dist: httpx[http2]>=0.17
 Requires-Dist: pydantic>=2.0.0
 Requires-Dist: pyjwt>=2.3.0
 Provides-Extra: all

meilisearch_python_sdk-3.5.0/codecov.yml

@@ -0,0 +1,6 @@
+codecov:
+  notify:
+    after_n_builds: 10
+
+comment:
+  after_n_builds: 10

meilisearch_python_sdk-3.5.0/docker-compose.https.yml

@@ -0,0 +1,12 @@
+services:
+  meilisearch:
+    image: getmeili/meilisearch:latest
+    ports:
+      - "7700:7700"
+    environment:
+      - MEILI_MASTER_KEY=masterKey
+      - MEILI_NO_ANALYTICS=true
+    volumes:
+      - ./meilisearch.key:/meilisearch.key
+      - ./meilisearch.crt:/meilisearch.crt
+    command: ["meilisearch", "--ssl-cert-path", "/meilisearch.crt", "--ssl-key-path", "/meilisearch.key"]

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/examples/add_documents_in_batches.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from meilisearch_python_sdk import Client

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/examples/async_add_documents_decorator.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import asyncio
 import json
+from pathlib import Path
 from typing import Any
 
 import aiofiles
@@ -14,8 +15,10 @@ from meilisearch_python_sdk.decorators import ConnectionInfo, async_add_document
     index_name="movies",
     connection_info=ConnectionInfo(url="http://127.0.0.1:7700", api_key="masterKey"),
 )
-async def load_documents() -> list[dict[str, Any]]:
-    async with aiofiles.open("../datasets/small_movies.json", "r") as f:
+async def load_documents(
+    file_path: Path | str = "../datasets/small_movies.json",
+) -> list[dict[str, Any]]:
+    async with aiofiles.open(file_path) as f:
         data = await f.read()
         documents = json.loads(data)
 

meilisearch_python_sdk-3.5.0/examples/async_add_documents_in_batches.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+import asyncio
+import json
+from pathlib import Path
+
+import aiofiles
+
+from meilisearch_python_sdk import AsyncClient, AsyncIndex
+from meilisearch_python_sdk.models.task import TaskInfo
+
+
+async def add_documents_in_batches(
+    index: AsyncIndex, file_path: Path | str = "../datasets/small_movies.json"
+) -> list[TaskInfo]:
+    async with aiofiles.open(file_path) as f:
+        data = await f.read()
+        documents = json.loads(data)
+
+    # Meilisearch prefers larger batch sizes so set this as large as you can.
+    return await index.add_documents_in_batches(documents, primary_key="id", batch_size=1000)
+
+
+async def main() -> int:
+    async with AsyncClient("http://127.0.0.1:7700", "masterKey") as client:
+        index = await client.create_index("movies", primary_key="id")
+
+        await add_documents_in_batches(index)
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(asyncio.run(main()))

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/examples/async_documents_and_search_results.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import asyncio
 import json
 from collections.abc import Sequence

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/examples/async_search_tracker.py

@@ -1,12 +1,18 @@
+from __future__ import annotations
+
 import asyncio
 import json
 import sqlite3
+from pathlib import Path
 from typing import Any
 
 import aiofiles
 
-from meilisearch_python_sdk import AsyncClient
+from meilisearch_python_sdk import AsyncClient, AsyncIndex
+from meilisearch_python_sdk.models.search import SearchResults
+from meilisearch_python_sdk.models.task import TaskInfo
 from meilisearch_python_sdk.plugins import AsyncEvent, AsyncIndexPlugins
+from meilisearch_python_sdk.types import JsonDict
 
 
 class SearchTrackerPlugin:
@@ -14,8 +20,8 @@ class SearchTrackerPlugin:
     POST_EVENT = False
     PRE_EVENT = False
 
-    def __init__(self) -> None:
-        self.conn = sqlite3.Connection("search_tracker.db")
+    def __init__(self, db_path: Path | str = "search_tracker.db") -> None:
+        self.conn = sqlite3.Connection(db_path)
         self.create_table()
 
     def create_table(self) -> None:
@@ -43,15 +49,24 @@ class SearchTrackerPlugin:
             cursor.close()
 
 
-async def main() -> int:
-    async with aiofiles.open("../datasets/small_movies.json") as f:
+async def add_documents(
+    index: AsyncIndex, file_path: Path | str = "../datasets/small_movies.json"
+) -> TaskInfo:
+    async with aiofiles.open(file_path) as f:
         data = await f.read()
         documents = json.loads(data)
+    return await index.add_documents(documents)
+
 
+async def search(index: AsyncIndex, query: str) -> SearchResults[JsonDict]:
+    return await index.search(query)
+
+
+async def main() -> int:
     async with AsyncClient("http://127.0.0.1:7700", "masterKey") as client:
         plugins = AsyncIndexPlugins(search_plugins=(SearchTrackerPlugin(),))
         index = await client.create_index("movies", primary_key="id", plugins=plugins)
-        task = await index.add_documents(documents)
+        task = await add_documents(index)
         await client.wait_for_task(task.task_uid)
         result = await index.search("Cars")
         print(result)  # noqa: T201

meilisearch_python_sdk-3.5.0/examples/async_update_settings.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+import asyncio
+import json
+from pathlib import Path
+
+import aiofiles
+
+from meilisearch_python_sdk import AsyncClient, AsyncIndex
+from meilisearch_python_sdk.models.settings import MeilisearchSettings
+from meilisearch_python_sdk.models.task import TaskInfo
+
+
+async def add_documents(
+    index: AsyncIndex, file_path: Path | str = "../datasets/small_movies.json"
+) -> TaskInfo:
+    async with aiofiles.open(file_path) as f:
+        data = await f.read()
+        documents = json.loads(data)
+
+    return await index.add_documents(documents)
+
+
+async def update_settings(index: AsyncIndex) -> TaskInfo:
+    settings = MeilisearchSettings(
+        filterable_attributes=["genre"], searchable_attributes=["title", "genre", "overview"]
+    )
+
+    return await index.update_settings(settings)
+
+
+async def main() -> int:
+    async with AsyncClient("http://127.0.0.1:7700", "masterKey") as client:
+        index = await client.create_index("movies", primary_key="id")
+        task = await update_settings(index)
+        await client.wait_for_task(task.task_uid)
+        await add_documents(index)
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(asyncio.run(main()))

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/examples/documents_and_search_results.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 from collections.abc import Sequence
 from typing import Any

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/examples/orjson_example.py

@@ -1,11 +1,20 @@
+from __future__ import annotations
+
+from pathlib import Path
+
 from meilisearch_python_sdk import Client
 from meilisearch_python_sdk.json_handler import OrjsonHandler
+from meilisearch_python_sdk.models.task import TaskInfo
 
 
-def main() -> int:
+def add_documents(file_path: Path | str = "../datasets/small_movies.json") -> TaskInfo:
     client = Client("http://127.0.0.1:7700", "masterKey", json_handler=OrjsonHandler())
     index = client.create_index("movies", primary_key="id")
-    index.add_documents_from_file("../datasets/small_movies.json")
+    return index.add_documents_from_file(file_path)
+
+
+def main() -> int:
+    add_documents()
 
     return 0
 

meilisearch_python_sdk-3.5.0/examples/pyproject.toml

@@ -0,0 +1,4 @@
+[tool.pytest.ini_options]
+minversion = "6.0"
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"

meilisearch_python_sdk-3.5.0/examples/requirements.txt

@@ -0,0 +1,4 @@
+../.[all]
+fastapi==0.115.0
+pytest==8.3.3
+pytest-asyncio==0.24.0

{meilisearch_python_sdk-3.3.0 → meilisearch_python_sdk-3.5.0}/examples/search_tracker.py

@@ -1,17 +1,23 @@
+from __future__ import annotations
+
 import json
 import sqlite3
+from pathlib import Path
 from typing import Any
 
-from meilisearch_python_sdk import Client
+from meilisearch_python_sdk import Client, Index
+from meilisearch_python_sdk.models.search import SearchResults
+from meilisearch_python_sdk.models.task import TaskInfo
 from meilisearch_python_sdk.plugins import Event, IndexPlugins
+from meilisearch_python_sdk.types import JsonDict
 
 
 class SearchTrackerPlugin:
     POST_EVENT = False
     PRE_EVENT = True  # Specifies the plugin should be run before the search
 
-    def __init__(self) -> None:
-        self.conn = sqlite3.Connection("search_tracker.db")
+    def __init__(self, db_path: Path | str = "search_tracker.db") -> None:
+        self.conn = sqlite3.Connection(db_path)
         self.create_table()
 
     def create_table(self) -> None:
@@ -34,16 +40,25 @@ class SearchTrackerPlugin:
             cursor.close()
 
 
-def main() -> int:
-    with open("../datasets/small_movies.json") as f:
+def add_documents(
+    index: Index, file_path: Path | str = "../datasets/small_movies.json"
+) -> TaskInfo:
+    with open(file_path) as f:
         documents = json.load(f)
+    return index.add_documents(documents)
+
 
+def search(index: Index, query: str) -> SearchResults[JsonDict]:
+    return index.search(query)
+
+
+def main() -> int:
     client = Client("http://127.0.0.1:7700", "masterKey")
     plugins = IndexPlugins(search_plugins=(SearchTrackerPlugin(),))
     index = client.create_index("movies", primary_key="id", plugins=plugins)
-    task = index.add_documents(documents)
+    task = add_documents(index)
     client.wait_for_task(task.task_uid)
-    result = index.search("Cars")
+    result = search(index, "Cars")
     print(result)  # noqa: T201
 
     return 0