Install PyMeilisearch#

Installing PyMeilisearch is as simple as installing any other Python library. However, to scrape and upload documents or a website to Meilisearch, you must have Meilisearch running as a service. For more information, see Installation and operating systems in the Meilisearch documentation.

You can install PyMeilisearch as either a user installation or a developer installation.

User installation#

For a user installation, you can install the latest stable version of PyMeilisearch from many different sources. Click the following tabs to see the one or more commands for installing PyMeilisearch from the public PyPI (Python Package Index), Ansys private PyPI, or GitHub.

python -m pip install pymeilisearch

export TWINE_USERNAME="__token__"
export TWINE_REPOSITORY_URL="https://pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/upload"
export TWINE_PASSWORD=***
python -m pip install pymeilisearch

python -m pip install git+https://github.com/ansys/pymeilisearch.git@v0.3.2

Developer installation#

The developer installation is specifically intended for project maintainers. This specialized installation is tailored to equip developers with the essential tools and resources required for effective contribution to the project’s development and maintenance. The developer installation assumes a certain level of technical expertise and familiarity with the project’s codebase, rendering it most suitable for individuals actively engaged in its continuous development and maintenance.

Start by cloning the repository:

git clone git@github.com:ansys/pymeilisearch

Move inside the project and create a new Python environment:

py -m venv <venv>

py -m venv <venv>

python -m venv <venv>

Activate this newly created environment:

<venv>\Scripts\activate.bat

<venv>\Scripts\Activate.ps1

source <venv>/bin/activate

Install the project in editable mode with this command:

python -m pip install --editable .

You can now make changes to the package’s source code. Your changes are immediately reflected in your project without requiring you to reinstall it.