Merge pull request #362 from sanders41/meilisearch-1.0

Update CI for meilisearch 1.0

Author: sanders41

.github/release-draft-template.yaml

@@ -4,9 +4,11 @@ exclude-labels:
   - 'dependencies'
   - 'skip-changelog'
 version-resolver:
-  minor:
+  major:
     labels:
       - 'breaking-change'
+  minor:
+    labels:
       - 'enhancement'
       - 'feature'
   default: patch

.github/workflows/testing.yaml

@@ -77,7 +77,7 @@ jobs:
     - name: Install Dependencies
       run: poetry install
     - name: MeiliSearch (latest version) setup with Docker
-      run: docker run --rm -d -p 7700:7700 getmeili/meilisearch:v0.30.5 meilisearch --no-analytics --master-key=masterKey
+      run: docker run --rm -d -p 7700:7700 getmeili/meilisearch:latest meilisearch --no-analytics --master-key=masterKey
     - name: Test with pytest
       run: |
         poetry run pytest --cov=meilisearch_python_async --cov-report=xml

README.md

@@ -125,10 +125,6 @@ SearchResults(
 
 See our [docs](https://meilisearch-python-async.paulsanders.dev) for the full documentation.
 
-## Compatibility with Meilisearch
-
-This package only guarantees the compatibility with [version v0.30 of Meilisearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.30.0).
-
 ## Contributing
 
 Contributions to this project are welcome. If you are interesting in contributing please see our [contributing guide](CONTRIBUTING.md)

docs/index.md

@@ -4,7 +4,3 @@ Meilisearch Python Async is a Python async client for the [Meilisearch](https://
 
 The focus of this documentation is on the Meilisearch Python Async API. More information of
 Meilisearch itself and how to use it can be found in [here](https://docs.meilisearch.com/).
-
-## Compatibility with Meilisearch
-
-This package only guarantees the compatibility with [version v0.20 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0).

docs/pydantic.md

@@ -1,7 +1,7 @@
 # Pydantic usage
 
 This package uses [Pydantic](https://pydantic-docs.helpmanual.io/) to serialize/deserialize the JSON
-from MeiliSearch into Python objects wherever possible, and in the process converts the camelCaseNames
+from Meilisearch into Python objects wherever possible, and in the process converts the camelCaseNames
 from JSON into more Pythonic snake_case_names.
 
 In some instances it is not possible to return the data as an object because the structure will be

meilisearch_python_async/__init__.py

@@ -1 +1,3 @@
-from meilisearch_python_async.client import Client as Client  # noqa: F401
+from meilisearch_python_async.client import Client
+
+__all__ = ["Client"]

meilisearch_python_async/_http_requests.py

@@ -12,9 +12,9 @@
 )
 
 from meilisearch_python_async.errors import (
-    MeiliSearchApiError,
-    MeiliSearchCommunicationError,
-    MeiliSearchError,
+    MeilisearchApiError,
+    MeilisearchCommunicationError,
+    MeilisearchError,
 )
 
 
@@ -45,13 +45,13 @@ async def _send_request(
             return response
 
         except (ConnectError, ConnectTimeout, RemoteProtocolError) as err:
-            raise MeiliSearchCommunicationError(str(err)) from err
+            raise MeilisearchCommunicationError(str(err)) from err
         except HTTPError as err:
             if "response" in locals():
-                raise MeiliSearchApiError(str(err), response) from err
+                raise MeilisearchApiError(str(err), response) from err
             else:
                 # Fail safe just in case error happens before response is created
-                raise MeiliSearchError(str(err))  # pragma: no cover
+                raise MeilisearchError(str(err))  # pragma: no cover
 
     async def get(self, path: str) -> Response:
         return await self._send_request(self.http_client.get, path)

meilisearch_python_async/client.py

@@ -10,7 +10,7 @@
 from httpx import AsyncClient
 
 from meilisearch_python_async._http_requests import HttpRequests
-from meilisearch_python_async.errors import InvalidRestriction, MeiliSearchApiError
+from meilisearch_python_async.errors import InvalidRestriction, MeilisearchApiError
 from meilisearch_python_async.index import Index
 from meilisearch_python_async.models.client import ClientStats, Key, KeyCreate, KeySearch, KeyUpdate
 from meilisearch_python_async.models.health import Health
@@ -21,7 +21,7 @@
 
 
 class Client:
-    """The client to connect to the MeiliSearchApi."""
+    """The client to connect to the MeilisearchApi."""
 
     def __init__(
         self,
@@ -35,8 +35,8 @@ def __init__(
 
         Args:
 
-            url: The url to the MeiliSearch API (ex: http://localhost:7700)
-            api_key: The optional API key for MeiliSearch. Defaults to None.
+            url: The url to the Meilisearch API (ex: http://localhost:7700)
+            api_key: The optional API key for Meilisearch. Defaults to None.
             timeout: The amount of time in seconds that the client will wait for a response before
                 timing out. Defaults to None.
             verify: SSL certificates (a.k.a CA bundle) used to
@@ -72,7 +72,7 @@ async def aclose(self) -> None:
         await self.http_client.aclose()
 
     async def create_dump(self) -> TaskInfo:
-        """Trigger the creation of a MeiliSearch dump.
+        """Trigger the creation of a Meilisearch dump.
 
         Returns:
 
@@ -81,7 +81,7 @@ async def create_dump(self) -> TaskInfo:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -108,7 +108,7 @@ async def create_index(self, uid: str, primary_key: str | None = None) -> Index:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -132,7 +132,7 @@ async def delete_index_if_exists(self, uid: str) -> bool:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -219,7 +219,7 @@ async def get_indexes(self) -> list[Index] | None:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -257,7 +257,7 @@ async def get_index(self, uid: str) -> Index:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -283,7 +283,7 @@ def index(self, uid: str) -> Index:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -304,7 +304,7 @@ async def get_all_stats(self) -> ClientStats:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -331,8 +331,8 @@ async def get_or_create_index(self, uid: str, primary_key: str | None = None) ->
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.MeiliSearchTimeoutError: If the connection times out.
-            MeiliSearchTimeoutError: If the connection times out.
+            MeilisearchApiError: If the Meilisearch API returned an error.MeilisearchTimeoutError: If the connection times out.
+            MeilisearchTimeoutError: If the connection times out.
 
         Examples:
 
@@ -342,7 +342,7 @@ async def get_or_create_index(self, uid: str, primary_key: str | None = None) ->
         """
         try:
             index_instance = await self.get_index(uid)
-        except MeiliSearchApiError as err:
+        except MeilisearchApiError as err:
             if "index_not_found" not in err.code:
                 raise
             index_instance = await self.create_index(uid, primary_key)
@@ -363,7 +363,7 @@ async def create_key(self, key: KeyCreate) -> Key:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -397,7 +397,7 @@ async def delete_key(self, key: str) -> int:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -409,7 +409,7 @@ async def delete_key(self, key: str) -> int:
         return response.status_code
 
     async def get_keys(self) -> KeySearch:
-        """Gets the MeiliSearch API keys.
+        """Gets the Meilisearch API keys.
 
         Returns:
 
@@ -418,7 +418,7 @@ async def get_keys(self) -> KeySearch:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -444,7 +444,7 @@ async def get_key(self, key: str) -> Key:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -471,7 +471,7 @@ async def update_key(self, key: KeyUpdate) -> Key:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -486,7 +486,11 @@ async def update_key(self, key: KeyUpdate) -> Key:
         """
         # The json.loads(key.json()) is because Pydantic can't serialize a date in a Python dict,
         # but can when converting to a json string.
-        payload = {k: v for k, v in json.loads(key.json(by_alias=True)).items() if v is not None}
+        payload = {
+            k: v
+            for k, v in json.loads(key.json(by_alias=True)).items()
+            if v is not None and k != "key"
+        }
         response = await self._http_requests.patch(f"keys/{key.key}", payload)
 
         return Key(**response.json())
@@ -505,7 +509,7 @@ async def get_raw_index(self, uid: str) -> IndexInfo | None:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -532,7 +536,7 @@ async def get_raw_indexes(self) -> list[IndexInfo] | None:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -548,16 +552,16 @@ async def get_raw_indexes(self) -> list[IndexInfo] | None:
         return [IndexInfo(**x) for x in response.json()["results"]]
 
     async def get_version(self) -> Version:
-        """Get the MeiliSearch version.
+        """Get the Meilisearch version.
 
         Returns:
 
-            Information about the version of MeiliSearch.
+            Information about the version of Meilisearch.
 
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -570,16 +574,16 @@ async def get_version(self) -> Version:
         return Version(**response.json())
 
     async def health(self) -> Health:
-        """Get health of the MeiliSearch server.
+        """Get health of the Meilisearch server.
 
         Returns:
 
-            The status of the MeiliSearch server.
+            The status of the Meilisearch server.
 
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples:
 
@@ -605,7 +609,7 @@ async def swap_indexes(self, indexes: list[tuple[str, str]]) -> TaskInfo:
         Raises:
 
             MeilisearchCommunicationError: If there was an error communicating with the server.
-            MeilisearchApiError: If the MeiliSearch API returned an error.
+            MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples: