Merge pull request #700 from sanders41/rename-project

Rename package to meilisearch_python_sdk

Author: sanders41

.github/workflows/pypi_publish.yaml

@@ -9,20 +9,16 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Install Poetry
-      run: |
-        pip install pipx
-        pipx install poetry
+      run: pipx install poetry
+    - name: Add pypi token to Poetry
+      run: poetry config pypi-token.pypi ${{ secrets.PYPI_API_KEY }}
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
         python-version: 3.11
         cache: "poetry"
     - name: Install Dependencies
-      run: |
-        poetry install
-    - name: Add pypi token to Poetry
-      run: |
-        poetry config pypi-token.pypi ${{ secrets.PYPI_API_KEY }}
+      run: poetry install
     - name: Publish package
       run: poetry publish --build
     - name: Deploy Docs

CONTRIBUTING.md

@@ -4,7 +4,7 @@
 
 All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.
 
-The best place to start is to check the [issues](https://github.com/sanders41/meilisearch-python-async/issues)
+The best place to start is to check the [issues](https://github.com/sanders41/meilisearch-python-sdk/issues)
 for something that interests you.
 
 ## Bug Reports
@@ -15,7 +15,7 @@ Please include:
 [GitHub markdown](https://docs.github.com/en/free-pro-team@latest/github/writing-on-github). For example:
 
   ```py
-  from meilisearch_python_async import Client
+  from meilisearch_python_sdk import Client
 
   async with Client(BASE_URL, MASTER_KEY) as client:
       client.index("movies")
@@ -34,12 +34,12 @@ this project.
 Once the project is forked clone it to your local machine:
 
 ```sh
-git clone https://github.com/your-user-name/meilisearch-python-async.git
-cd meilisearch-python-async
-git remote add upstream https://github.com/sanders41/meilisearch-python-async.git
+git clone https://github.com/your-user-name/meilisearch-python-sdk.git
+cd meilisearch-python-sdk
+git remote add upstream https://github.com/sanders41/meilisearch-python-sdk.git
 ```
 
-This creates the directory meilisearch-python-async and connects your repository to the upstream (main project) repository.
+This creates the directory meilisearch-python-sdk and connects your repository to the upstream (main project) repository.
 
 ### Working with the code
 
@@ -74,21 +74,21 @@ git pull upstream main --ff-only
 
 ### Code Standards and tests (ruff, black, mypy, pytest, and pre-commit)
 
-meilisearch-python-async uses [ruff](https://github.com/charliermarsh/ruff),
+meilisearch-python-sdk uses [ruff](https://github.com/charliermarsh/ruff),
 [Black](https://github.com/psf/black), and [mypy](https://mypy.readthedocs.io/en/stable/) to ensure
 consistent code formatting.
 
 You can run linting on your code at any time with:
 
 ```sh
 # Run black
-poetry run black meilisearch_python_async tests
+poetry run black meilisearch_python_sdk tests
 
 # Run ruff
 poetry run ruff check .
 
 # Run mypy
-poetry run mypy meilisearch_python_async
+poetry run mypy meilisearch_python_sdk
 ```
 
 It is also suggested that you setup [pre-commit](https://pre-commit.com/) in order to run linting
@@ -140,7 +140,7 @@ This project uses [pytest](https://docs.pytest.org/en/stable/) for testing. Plea
 additions/changes you make to the code have tests to go along with them. Code coverage should not
 drop blow it's current level with any pull requests you make, if it does the pull request will not
 be accepted. You can view the current coverage level in the codecov badge on the
-[main github page](https://github.com/sanders41/meilisearch-python-async). You can run tests and see the
+[main github page](https://github.com/sanders41/meilisearch-python-sdk). You can run tests and see the
 code coverage.
 
 There are multiple way Meilisearch can be setup for testing. The examples below use docker, however
@@ -186,7 +186,7 @@ To see a full list of `just` commands run `just --list`
 
 Documentation is automatically generated based on the doc strings from the functions/methods. If
 functions/methods are added/removed make sure to update the
-[api documentation page](https://github.com/sanders41/meilisearch-python-async/docs/api.md) accordingly.
+[api documentation page](https://github.com/sanders41/meilisearch-python-sdk/docs/api.md) accordingly.
 
 You can view any changes to the docs locally by running:
 
@@ -238,11 +238,11 @@ git remote -v
 
 ## Making a Pull Request
 
-After pushing your code to origin it is now on GitHub but not yet part of the meilisearch-python-async project. When you’re ready to ask for a code review, file a pull request. Before you do, once again make sure that you have followed all the guidelines outlined in this document regarding code style, tests, and documentation.
+After pushing your code to origin it is now on GitHub but not yet part of the meilisearch-python-sdk project. When you’re ready to ask for a code review, file a pull request. Before you do, once again make sure that you have followed all the guidelines outlined in this document regarding code style, tests, and documentation.
 
 ### Make the pull request
 
-If everything looks good, you are ready to make a pull request. This is how you let the maintainers of the meilisearch-python-async project know you have code ready to be reviewed. To submit the pull request:
+If everything looks good, you are ready to make a pull request. This is how you let the maintainers of the meilisearch-python-sdk project know you have code ready to be reviewed. To submit the pull request:
 
 1. Navigate to your repository on GitHub
 2. Click on the Pull Request button for your feature branch

README.md

@@ -1,12 +1,12 @@
-# Meilisearch Python Async
+# Meilisearch Python SDK
 
-[![Tests Status](https://github.com/sanders41/meilisearch-python-async/workflows/Testing/badge.svg?branch=main&event=push)](https://github.com/sanders41/meilisearch-python-async/actions?query=workflow%3ATesting+branch%3Amain+event%3Apush)
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sanders41/meilisearch-python-async/main.svg)](https://results.pre-commit.ci/latest/github/sanders41/meilisearch-python-async/main)
-[![Coverage](https://codecov.io/github/sanders41/meilisearch-python-async/coverage.svg?branch=main)](https://codecov.io/gh/sanders41/meilisearch-python-async)
-[![PyPI version](https://badge.fury.io/py/meilisearch-python-async.svg)](https://badge.fury.io/py/meilisearch-python-async)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/meilisearch-python-async?color=5cc141)](https://github.com/sanders41/meilisearch-python-async)
+[![Tests Status](https://github.com/sanders41/meilisearch-python-sdk/workflows/Testing/badge.svg?branch=main&event=push)](https://github.com/sanders41/meilisearch-python-sdk/actions?query=workflow%3ATesting+branch%3Amain+event%3Apush)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sanders41/meilisearch-python-sdk/main.svg)](https://results.pre-commit.ci/latest/github/sanders41/meilisearch-python-sdk/main)
+[![Coverage](https://codecov.io/github/sanders41/meilisearch-python-sdk/coverage.svg?branch=main)](https://codecov.io/gh/sanders41/meilisearch-python-sdk)
+[![PyPI version](https://badge.fury.io/py/meilisearch-python-sdk.svg)](https://badge.fury.io/py/meilisearch-python-sdk)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/meilisearch-python-sdk?color=5cc141)](https://github.com/sanders41/meilisearch-python-sdk)
 
-Meilisearch Python Async provides both an async and sync client for the
+Meilisearch Python SDK provides both an async and sync client for the
 [Meilisearch](https://github.com/meilisearch/meilisearch) API.
 
 Which client to use depends on your use case. If the code base you are working with uses asyncio,
@@ -22,7 +22,7 @@ Using a virtual environmnet is recommended for installing this package. Once the
 environment is created and activated install the package with:
 
 ```sh
-pip install meilisearch-python-async
+pip install meilisearch-python-sdk
 ```
 
 ## Run Meilisearch
@@ -49,7 +49,7 @@ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --mas
 network call to send the data yet so it does not need to be awaited.
 
 ```py
-from meilisearch_python_async import AsyncClient
+from meilisearch_python_sdk import AsyncClient
 
 async with AsyncClient('http://127.0.0.1:7700', 'masterKey') as client:
     index = client.index("books")
@@ -65,7 +65,7 @@ async with AsyncClient('http://127.0.0.1:7700', 'masterKey') as client:
 #### Client
 
 ```py
-from meilisearch_python_async import Client
+from meilisearch_python_sdk import Client
 
 client = Client('http://127.0.0.1:7700', 'masterKey')
 index = client.index("books")
@@ -195,13 +195,13 @@ This test compares how long it takes to send 1 million documents in batches of 1
 Meilisearch server for indexing (lower is better). The time does not take into account how long
 Meilisearch takes to index the documents since that is outside of the library functionality.
 
-![Add Documents in Batches](https://raw.githubusercontent.com/sanders41/meilisearch-python-async/main/assets/add_in_batches.png)
+![Add Documents in Batches](https://raw.githubusercontent.com/sanders41/meilisearch-python-sdk/main/assets/add_in_batches.png)
 
 ### Muiltiple Searches
 
 This test compares how long it takes to complete 1000 searches (lower is better)
 
-![Multiple Searches](https://raw.githubusercontent.com/sanders41/meilisearch-python-async/main/assets/searches.png)
+![Multiple Searches](https://raw.githubusercontent.com/sanders41/meilisearch-python-sdk/main/assets/searches.png)
 
 ### Independent testing
 
@@ -211,7 +211,7 @@ results how he tested them in his [blog post](https://thedataquarry.com/posts/me
 
 ## Documentation
 
-See our [docs](https://meilisearch-python-async.paulsanders.dev) for the full documentation.
+See our [docs](https://meilisearch-python-sdk.paulsanders.dev) for the full documentation.
 
 ## Contributing
 

benchmark/run_benchmark.py

@@ -14,8 +14,8 @@
 from rich.console import Console
 from rich.progress import track
 
-from meilisearch_python_async import AsyncClient, Client
-from meilisearch_python_async.models.task import TaskInfo
+from meilisearch_python_sdk import AsyncClient, Client
+from meilisearch_python_sdk.models.task import TaskInfo
 
 
 def generate_data(add_records: int = 1000000) -> list[dict[str, Any]]:

docs/CNAME

@@ -1 +1 @@
-meilisearch-python-async.paulsanders.dev
+meilisearch-python-sdk.paulsanders.dev

docs/async_client_api.md

@@ -6,7 +6,7 @@ This client runs in a context manager which ensures that everything is cleaned u
 the client is done. To create a client:
 
 ```py
-from milisearch-python-async import AsyncClient
+from meilisearch-python-sdk import AsyncClient
 
 
 async with AsyncClient("http://localhost:7700", "masterKey") as client:
@@ -20,7 +20,7 @@ It is also possible to call the client without using a context manager, but in d
 need to make sure to do the cleanup yourself:
 
 ```py
-from meilisearch-python-async import AsyncClient
+from meilisearch-python-sdk import AsyncClient
 
 
 try:
@@ -33,4 +33,4 @@ finally:
 
 ## `AsyncClient API`
 
-::: meilisearch_python_async._client.AsyncClient
+::: meilisearch_python_sdk._client.AsyncClient

docs/async_index_api.md

@@ -6,4 +6,4 @@ it will create an `AsyncIndex` instance.
 
 ## `AsyncIndex API`
 
-::: meilisearch_python_async._index.AsyncIndex
+::: meilisearch_python_sdk._index.AsyncIndex

docs/client_api.md

@@ -5,7 +5,7 @@
 To create a client:
 
 ```py
-from milisearch-python-async import Client
+from milisearch_python_sdk import Client
 
 
 client = Client("http://localhost:7700", "masterKey")
@@ -15,4 +15,4 @@ index = client.index("movies")
 
 ## `Client API`
 
-::: meilisearch_python_async._client.Client
+::: meilisearch_python_sdk._client.Client

docs/index_api.md

@@ -5,4 +5,4 @@ a new index with the `Client` it will create an `Index` instance.
 
 ## `Index`
 
-::: meilisearch_python_async._index.Index
+::: meilisearch_python_sdk._index.Index

docs/pydantic.md

@@ -11,15 +11,15 @@ either work with the data in the dictionary that is returned, or because you wil
 you can generate your own Pydantic models.
 
 As an example, if you want to get a movie from the
-[small movies example](https://github.com/sanders41/meilisearch-python-async/blob/main/datasets/small_movies.json)
+[small movies example](https://github.com/sanders41/meilisearch-python-sdk/blob/main/datasets/small_movies.json)
 you could put the results into an object with the following:
 
 ```py
 from datetime import datetime
 from typing import Optional
 
 from camel_converter.pydantic_base import CamelBase
-from meilisearch_python_async import Client
+from meilisearch_python_sdk import Client
 
 
 # Inheriting from CamelBase will allow your class to automatically convert
@@ -53,7 +53,7 @@ Movie(
 )
 ```
 
-By inheriting from CamelBase, or any of the other [provided models](https://github.com/sanders41/meilisearch-python-async/tree/main/meilisearch_python_async/models)
+By inheriting from CamelBase, or any of the other [provided models](https://github.com/sanders41/meilisearch-python-sdk/tree/main/meilisearch_python_sdk/models)
 you will be inheriting Pydantic models and therefore have access to the funcitonality Pydantic provides
 such as [validators](https://pydantic-docs.helpmanual.io/usage/validators/) and [Fields](https://pydantic-docs.helpmanual.io/usage/model_config/#alias-precedence).
 Pydantic will also automatically deserialized the data into the correct data type based on the type