Merge branch 'main' into multi2multivec-weaviate

Author: databyjp

.github/dependabot.yml

@@ -8,7 +8,7 @@ updates:
   - package-ecosystem: "pip" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: "monthly"
     ignore:
       - dependency-name: "grpcio"
       - dependency-name: "grpcio-tools"

.github/workflows/main.yaml

@@ -18,14 +18,15 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  WEAVIATE_125: 1.25.34
-  WEAVIATE_126: 1.26.17
   WEAVIATE_127: 1.27.27
   WEAVIATE_128: 1.28.16
-  WEAVIATE_129: 1.29.9
-  WEAVIATE_130: 1.30.12
-  WEAVIATE_131: 1.31.5
-  WEAVIATE_132: 1.32.5
+  WEAVIATE_129: 1.29.11
+  WEAVIATE_130: 1.30.22
+  WEAVIATE_131: 1.31.20
+  WEAVIATE_132: 1.32.23
+  WEAVIATE_133: 1.33.10
+  WEAVIATE_134: 1.34.5
+  WEAVIATE_135: 1.35.0
 
 jobs:
   lint-and-format:
@@ -59,7 +60,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
         folder: ["weaviate", "integration", "integration_embedded"]
     steps:
       - uses: actions/checkout@v4
@@ -79,7 +80,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
         folder: ["test", "mock_tests"]
     steps:
       - uses: actions/checkout@v4
@@ -122,7 +123,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
         optional_dependencies: [false]
     steps:
       - uses: actions/checkout@v4
@@ -153,11 +154,11 @@ jobs:
       fail-fast: false
       matrix:
         versions: [
-          { py: "3.9", weaviate: $WEAVIATE_131, grpc: "1.59.0"},
-          { py: "3.10", weaviate: $WEAVIATE_131, grpc: "1.66.0"},
-          { py: "3.11", weaviate: $WEAVIATE_131, grpc: "1.70.0"},
-          { py: "3.12", weaviate: $WEAVIATE_131, grpc: "1.72.1"},
-          { py: "3.13", weaviate: $WEAVIATE_131, grpc: "1.74.0"}
+          { py: "3.10", weaviate: $WEAVIATE_132, grpc: "1.59.0"},
+          { py: "3.11", weaviate: $WEAVIATE_132, grpc: "1.66.0"},
+          { py: "3.12", weaviate: $WEAVIATE_132, grpc: "1.70.0"},
+          { py: "3.13", weaviate: $WEAVIATE_132, grpc: "1.72.1"},
+          { py: "3.14", weaviate: $WEAVIATE_132, grpc: "1.76.0"}
         ]
         optional_dependencies: [false]
     steps:
@@ -208,11 +209,11 @@ jobs:
       fail-fast: false
       matrix:
         versions: [
-          { py: "3.9", weaviate: $WEAVIATE_131},
-          { py: "3.10", weaviate: $WEAVIATE_131},
-          { py: "3.11", weaviate: $WEAVIATE_131},
-          { py: "3.12", weaviate: $WEAVIATE_131},
-          { py: "3.13", weaviate: $WEAVIATE_131}
+          { py: "3.10", weaviate: $WEAVIATE_132},
+          { py: "3.11", weaviate: $WEAVIATE_132},
+          { py: "3.12", weaviate: $WEAVIATE_132},
+          { py: "3.13", weaviate: $WEAVIATE_132},
+          { py: "3.14", weaviate: $WEAVIATE_132}
         ]
         optional_dependencies: [false]
     steps:
@@ -297,14 +298,15 @@ jobs:
       fail-fast: false
       matrix:
         version: [
-          $WEAVIATE_125,
-          $WEAVIATE_126,
           $WEAVIATE_127,
           $WEAVIATE_128,
           $WEAVIATE_129,
           $WEAVIATE_130,
           $WEAVIATE_131,
-          $WEAVIATE_132
+          $WEAVIATE_132,
+          $WEAVIATE_133,
+          $WEAVIATE_134
+          $WEAVIATE_135
         ]
     steps:
       - name: Checkout

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.11.7
+  rev: v0.14.7
   hooks:
     # Run the linter.
     - id: ruff
@@ -19,24 +19,24 @@ repos:
       args: [ weaviate, integration, test, mock_tests, journey_tests ]
 
 - repo: https://github.com/PyCQA/flake8
-  rev: 7.1.0
+  rev: 7.3.0
   hooks:
     - id: flake8
       name: linting
       additional_dependencies: [
-        'flake8-bugbear==22.10.27',
-        'flake8-comprehensions==3.10.1',
-        'flake8-builtins==2.0.1'
+        'flake8-bugbear==24.12.12',
+        'flake8-comprehensions==3.17.0',
+        'flake8-builtins==3.0.0'
       ]
     - id: flake8
       name: docstrings
       additional_dependencies: [
         'flake8-docstrings==1.7.0',
-        'pydoclint==0.6.5',
+        'pydoclint==0.7.3',
       ]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.6.0
+  rev: v6.0.0
   hooks:
     - id: no-commit-to-branch
     - id: trailing-whitespace

.readthedocs.yaml

@@ -13,7 +13,8 @@ build:
   jobs:
     pre_build:
       - git clone -b main --depth=1 https://github.com/weaviate/weaviate-agents-python-client.git docs/weaviate-agents-python-client
+      - python -m pip install -e ./docs/weaviate-agents-python-client
 
 python:
   install:
-  - requirements: requirements-devel.txt
+    - requirements: requirements-devel.txt

CONTRIBUTING.md

@@ -1,18 +1,12 @@
 ### Setup
 
-We recommend that you use a virtual environment to contribute to the client.
-
-To create a virtual environment, activate it, and install dependencies, run the following shell code:
+The development requirements are listed in the `requirements-devel.txt` file. Install them to your virtual environment with:
 
 ```shell
-python3 -m venv .venv
-source .venv/bin/activate
 pip install -r requirements-devel.txt
 ```
 
-To activate your virtual environment, run `source .venv/bin/activate`.
-
-The newest client versions sometimes require upcoming Weaviate core features. We recommend using Docker (see https://weaviate.io/developers/weaviate/installation/docker-compose) to run a local instance of the `latest Weaviate core <https://hub.docker.com/r/semitechnologies/weaviate/tags>`_ for client development.
+The newest client versions sometimes require upcoming Weaviate core features. We recommend using Docker (see https://docs.weaviate.io/deploy/installation-guides/docker-installation) to run a local instance of the `latest Weaviate core <https://hub.docker.com/r/semitechnologies/weaviate/tags>`_ for client development.
 
 #### Installation
 
@@ -34,10 +28,16 @@ You can install a particular branch directly from GitHub with:
 pip install git+https://github.com/weaviate/weaviate-python-client.git@BRANCH_NAME
 ```
 
+If any static analysis tools such as Pylance fail, try installing the package with:
+`--config-settings editable_mode=compat` suffix. (e.g. `pip install -e . --config-settings editable_mode=compat`)
 
 ### Testing
 
-> Note: We use [pytest](https://docs.pytest.org) to write tests for new client code. However, many older tests use [unittest](https://docs.python.org/3/library/unittest.html). These commands run the `pytest` and `unittest` tests.
+To set up the testing environment, install the test requirements with:
+
+```shell
+pip install -r requirements-test.txt
+```
 
 There are three kinds of tests:
 - Unit tests test individual client components.
@@ -67,9 +67,10 @@ pytest test
 > We strongly recommend using [pre-commit](https://pre-commit.com/) to automatically run all linters locally on each commit. Install `pre-commit` on your system, and then enable it with `pre-commit install`.
 
 We use the following tools to ensure a high code quality:
-- black (formatter), run with `black $FOLDER_WITH_CHANGES`
-- flake8 with plugins. Run with `flake8 $FOLDER_WITH_CHANGES`. Note that all plugins are listed in the `requirements.txt` file and are installed in the first step.
+- ruff (formatter), run with `ruff format $FOLDER_WITH_CHANGES`
+- flake8 with plugins. Run with `flake8 $FOLDER_WITH_CHANGES`.
 
+Note that all plugins are listed in the `requirements-devel.txt` file and are installed in the first step.
 
 ### Creating a Pull Request
 

RELEASING.md

@@ -0,0 +1,30 @@
+## How to create releases
+
+### Step 1: Prepare for release
+1. Pull latest main
+	- Merge any pending PRs
+2. Determine what the next version should be, following semantic versioning
+3. Create a new branch for the changelog
+4. Add a changelog entry to `docs/changelog.rst`
+	- `gh pr list --repo weaviate/weaviate-python-client --state merged --search "merged:>=YYYY-MM-DD"` where `YYYY-MM-DD` is the last release date
+	- Only add the relevant entries to the changelog
+	- Examples - [minor release](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.18.0), [patch release](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.16.10)
+5. Merge back to main
+6. Pull main
+
+### Step 2: Create release
+Option 1: With GH CLI
+1. `gh release create <VERSION_TAG>` (e.g. `gh release create v4.18.1`)
+
+Option 2: With git + GH web UI
+1. git tag VERSION
+	- `git tag -a v4.18.1 -m "v4.18.1"
+2. `git push --tags`
+3. Create a release [from the GH repo](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository?tool=webui#creating-a-release)
+
+### Step 3: Monitor pipeline
+1. Monitor the CICD pipeline
+	1. When all tests pass, the release will be pushed to PyPI automatically
+
+### Notes:
+- The package version is updated automatically (see setup.cfg)

ci/docker-compose-backup.yml

@@ -30,8 +30,8 @@ services:
       AUTHORIZATION_ENABLE_RBAC: "true"
       AUTHENTICATION_DB_USERS_ENABLED: "true"
       AUTHENTICATION_OIDC_ENABLED: 'true'
-      AUTHENTICATION_OIDC_CLIENT_ID: 'wcs'
-      AUTHENTICATION_OIDC_ISSUER: 'https://auth.wcs.api.weaviate.io/auth/realms/SeMI'
+      AUTHENTICATION_OIDC_CLIENT_ID: 'Peuc12y02UA0eAED1dqSjE5HtGUrpBsx'
+      AUTHENTICATION_OIDC_ISSUER: 'https://auth.weaviate.cloud/Peuc12y02UA0eAED1dqSjE5HtGUrpBsx'
       AUTHENTICATION_OIDC_USERNAME_CLAIM: 'email'
-      AUTHENTICATION_OIDC_GROUPS_CLAIM: 'groups'
+      AUTHENTICATION_OIDC_GROUPS_CLAIM: 'roles'
 ...

ci/docker-compose-rbac.yml

@@ -29,8 +29,8 @@ services:
       AUTHORIZATION_ENABLE_RBAC: "true"
       AUTHENTICATION_DB_USERS_ENABLED: "true"
       AUTHENTICATION_OIDC_ENABLED: 'true'
-      AUTHENTICATION_OIDC_CLIENT_ID: 'wcs'
-      AUTHENTICATION_OIDC_ISSUER: 'https://auth.wcs.api.weaviate.io/auth/realms/SeMI'
+      AUTHENTICATION_OIDC_CLIENT_ID: 'Peuc12y02UA0eAED1dqSjE5HtGUrpBsx'
+      AUTHENTICATION_OIDC_ISSUER: 'https://auth.weaviate.cloud/Peuc12y02UA0eAED1dqSjE5HtGUrpBsx'
       AUTHENTICATION_OIDC_USERNAME_CLAIM: 'email'
-      AUTHENTICATION_OIDC_GROUPS_CLAIM: 'groups'
+      AUTHENTICATION_OIDC_GROUPS_CLAIM: 'roles'
 ...

ci/docker-compose-wcs.yml

@@ -19,10 +19,10 @@ services:
       PERSISTENCE_DATA_PATH: '/var/lib/weaviate'
       AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: 'false'
       AUTHENTICATION_OIDC_ENABLED: 'true'
-      AUTHENTICATION_OIDC_CLIENT_ID: 'wcs'
-      AUTHENTICATION_OIDC_ISSUER: 'https://auth.wcs.api.weaviate.io/auth/realms/SeMI'
+      AUTHENTICATION_OIDC_CLIENT_ID: 'Peuc12y02UA0eAED1dqSjE5HtGUrpBsx'
+      AUTHENTICATION_OIDC_ISSUER: 'https://auth.weaviate.cloud/Peuc12y02UA0eAED1dqSjE5HtGUrpBsx'
       AUTHENTICATION_OIDC_USERNAME_CLAIM: 'email'
-      AUTHENTICATION_OIDC_GROUPS_CLAIM: 'groups'
+      AUTHENTICATION_OIDC_GROUPS_CLAIM: 'roles'
       AUTHORIZATION_ADMINLIST_ENABLED: 'true'
       AUTHORIZATION_ADMINLIST_USERS: 'oidc-test-user@weaviate.io'
       AUTHENTICATION_OIDC_SCOPES: 'openid,email'

docs/changelog.rst

@@ -1,6 +1,73 @@
 Changelog
 =========
 
+Version 4.19.0
+--------------
+This minor version includes:
+    - Support for new 1.35 features:
+        - Add support for time-to-live (TTL) on objects
+        - Add support for new ``multi2multivec-weaviate`` module
+        - Enhance model integration helper functions
+            - Add separate service-specific helpers for aws sagemaker vs bedrock, or google gemini vs vertex
+            - Add BaseURL support for Cohere rerankers
+            - Fix model provider parameters
+    - Improve batch performance by optimizing checks for live threads
+    - Update authlib
+
+
+Version 4.18.3
+--------------
+This patch version includes:
+    - Fixes wrong deprecation warning in PyCharm when creating a collection without vectorizers
+    - Fixes warnings with boolean filters
+
+Version 4.18.2
+--------------
+This patch version includes:
+    - Add support for contextual generative and reranker modules
+    - Add support for ZSTD compression in backups
+    - Add support for VoyageAI's voyage-3-large model
+
+Version 4.18.1
+--------------
+This patch version includes:
+    - Add 'dimensions' param to cohere vectorizers  (feat/cohere-dimensions-param)
+    - Add 'dimensions' parameter to text2vec-voyageai methods (feat/t2v-voyage-add-dimensions)
+
+Version 4.18.0
+--------------
+This minor version includes:
+    - Support for new 1.34 features:
+        - 1-bit rotational quantization (RQ) for hnsw indices
+        - 1-bit and 8-bit RQ for flat indices
+        - Support for latest preview release of Server-side Batching (SSB)
+    - Allow sorting backups by creation time
+    - Add support for ``gse_ch`` tokenizer
+
+Version 4.17.0
+--------------
+This minor version includes:
+    - Remove support for Weaviate versions < 1.27. Please update your Weaviate instances
+    - Support for new 1.33 features:
+        - OIDC group support in RBAC
+        - Uncompressed quantizer
+        - ContainsNone and Not filter operators
+    - Add support for ``verbosity`` and ``reasoning effort`` for generative-openai module
+    - Add alias.exists method
+    - Add multi2vec-aws and text2vec-morph modules
+    - Add support for max_tokens for generative-aws module
+    - Fix weaviate client installation with other packages depending on grpc-health-checking
+
+Version 4.16.10
+--------------
+This patch version includes:
+    - Addition of helper to create an uncompressed quantizer for use when not using default compression
+    - Support for ``overwrite_alias`` option to backup create/restore
+    - Support for OIDC groups
+    - Addition of ``multi2vec-aws`` and ``text2vec-morph`` modules
+    - Support for ``alias.exists`` method
+    - Update to ``weaviate-agents-client`` dependency for GA release of agents
+
 Version 4.16.9
 --------------
 This patch version includes: