# Milvus Python SDK
[](https://pypi.org/project/pymilvus/)
[](https://pypi.org/project/pymilvus/)
[](https://pepy.tech/project/pymilvus)
[](https://pepy.tech/project/pymilvus)
[](https://pepy.tech/project/pymilvus)
[](https://github.com/milvus-io/pymilvus/blob/master/LICENSE)
[![Mergify Status][mergify-status]][mergify]
[mergify]: https://mergify.com
[mergify-status]: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/milvus-io/pymilvus&style=flat
Python SDK for [Milvus](https://github.com/milvus-io/milvus). To contribute code to this project, please read our [contribution guidelines](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md) first. If you have some ideas or encounter a problem, you can find us in the Slack channel [#py-milvus](https://milvusio.slack.com/archives/C024XTWMT4L).
## Compatibility
The following collection shows Milvus versions and recommended PyMilvus versions:
|Milvus version| Recommended PyMilvus version |
|:-----:|:-----:|
| 1.0.\* | 1.0.1 |
| 1.1.\* | 1.1.2 |
| 2.0.\* | 2.0.2 |
| 2.1.\* | 2.1.3 |
| 2.2.\* | 2.2.15 |
| 2.3.\* | 2.3.7 |
| 2.4.\* | 2.4.10 |
| 2.5.\* | 2.5.0 |
## Installation
You can install PyMilvus via `pip` or `pip3` for Python 3.8+:
```shell
$ pip3 install pymilvus
$ pip3 install pymilvus[model] # for milvus-model
$ pip3 install pymilvus[bulk_writer] # for bulk_writer
```
You can install a specific version of PyMilvus by:
```shell
$ pip3 install pymilvus==2.4.10
```
You can upgrade PyMilvus to the latest version by:
```shell
$ pip3 install --upgrade pymilvus
```
## FAQ
Q1. How to get submodules?
A1. The following command will get the protos matching to the generated files, for protos of certain version, see
[milvus-proto](https://github.com/milvus-io/milvus-proto#usage) for details.
```shell
$ git submodule update --init
```
Q2. How to generate python files from milvus-proto?
A2.
```shell
$ make gen_proto
```
Q3. How to use the local PyMilvus repository for Milvus server?
A3.
```shell
$ make install
```
Q4. How to check coding styles?
A4.
```shell
make lint
```
Q5. How to fix the coding styles?
A5
```shell
make format
```
Q6. How to run unittests?
A6
```shell
$ pip install ".[dev]"
$ make unittest
```
Q7. `zsh: no matches found: pymilvus[model]`, how do I solve this?
A7
```shell
$ pip install "pymilvus[model]"
```
## Documentation
Documentation is available online: https://milvus.io/api-reference/pymilvus/v2.4.x/About.md
## Developing package releases
The commits on the development branch of each version will be packaged and uploaded to [Test PyPI](https://test.pypi.org/).
The package name generated by the development branch is x.y.z.rc<dist>, where <dist> is the number of commits that differ from the most recent release.
- For example, after the release of **2.3.4**, two commits were submitted on the 2.3 branch.
The version number of the latest commit of 2.3 branch is **2.3.5.rc2**.
- For example, after the release of **2.3.4**, 10 commits were submitted on the master branch.
The version number of the latest commit of master branch is **2.4.0.rc10**.
To install the package on Test PyPi, you need to append `--extra-index-url` after pip, for example:
```shell
$ python3 -m pip install --extra-index-url https://test.pypi.org/simple/ pymilvus==2.1.0.dev66
```
## License
[Apache License 2.0](LICENSE)
Raw data
{
"_id": null,
"home_page": null,
"name": "pymilvus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Milvus Team <milvus-team@zilliz.com>",
"download_url": "https://files.pythonhosted.org/packages/a9/8a/a10d29f5d9c9c33ac71db4594e3e6230279d557d6bd5fde6f99d1edfc360/pymilvus-2.5.3.tar.gz",
"platform": null,
"description": "# Milvus Python SDK\n\n[](https://pypi.org/project/pymilvus/)\n[](https://pypi.org/project/pymilvus/)\n[](https://pepy.tech/project/pymilvus)\n[](https://pepy.tech/project/pymilvus)\n[](https://pepy.tech/project/pymilvus)\n\n[](https://github.com/milvus-io/pymilvus/blob/master/LICENSE)\n[![Mergify Status][mergify-status]][mergify]\n\n\n[mergify]: https://mergify.com\n[mergify-status]: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/milvus-io/pymilvus&style=flat\n\nPython SDK for [Milvus](https://github.com/milvus-io/milvus). To contribute code to this project, please read our [contribution guidelines](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md) first. If you have some ideas or encounter a problem, you can find us in the Slack channel [#py-milvus](https://milvusio.slack.com/archives/C024XTWMT4L).\n\n\n## Compatibility\nThe following collection shows Milvus versions and recommended PyMilvus versions:\n\n|Milvus version| Recommended PyMilvus version |\n|:-----:|:-----:|\n| 1.0.\\* | 1.0.1 |\n| 1.1.\\* | 1.1.2 |\n| 2.0.\\* | 2.0.2 |\n| 2.1.\\* | 2.1.3 |\n| 2.2.\\* | 2.2.15 |\n| 2.3.\\* | 2.3.7 |\n| 2.4.\\* | 2.4.10 |\n| 2.5.\\* | 2.5.0 |\n\n\n## Installation\n\nYou can install PyMilvus via `pip` or `pip3` for Python 3.8+:\n\n```shell\n$ pip3 install pymilvus\n$ pip3 install pymilvus[model] # for milvus-model\n$ pip3 install pymilvus[bulk_writer] # for bulk_writer\n```\n\nYou can install a specific version of PyMilvus by:\n\n```shell\n$ pip3 install pymilvus==2.4.10\n```\n\nYou can upgrade PyMilvus to the latest version by:\n\n```shell\n$ pip3 install --upgrade pymilvus\n```\n\n## FAQ\nQ1. How to get submodules?\n\nA1. The following command will get the protos matching to the generated files, for protos of certain version, see\n[milvus-proto](https://github.com/milvus-io/milvus-proto#usage) for details.\n```shell\n$ git submodule update --init\n```\n\nQ2. How to generate python files from milvus-proto?\n\nA2.\n```shell\n$ make gen_proto\n```\n\nQ3. How to use the local PyMilvus repository for Milvus server?\n\nA3.\n```shell\n$ make install\n```\n\nQ4. How to check coding styles?\n\nA4.\n```shell\nmake lint\n```\n\nQ5. How to fix the coding styles?\n\nA5\n```shell\nmake format\n```\n\nQ6. How to run unittests?\n\nA6\n```shell\n$ pip install \".[dev]\"\n$ make unittest\n```\nQ7. `zsh: no matches found: pymilvus[model]`, how do I solve this?\n\nA7\n```shell\n$ pip install \"pymilvus[model]\"\n```\n\n## Documentation\n\nDocumentation is available online: https://milvus.io/api-reference/pymilvus/v2.4.x/About.md\n\n## Developing package releases\n\nThe commits on the development branch of each version will be packaged and uploaded to [Test PyPI](https://test.pypi.org/).\n\nThe package name generated by the development branch is x.y.z.rc<dist>, where <dist> is the number of commits that differ from the most recent release.\n\n- For example, after the release of **2.3.4**, two commits were submitted on the 2.3 branch.\nThe version number of the latest commit of 2.3 branch is **2.3.5.rc2**.\n\n- For example, after the release of **2.3.4**, 10 commits were submitted on the master branch.\nThe version number of the latest commit of master branch is **2.4.0.rc10**.\n\n\nTo install the package on Test PyPi, you need to append `--extra-index-url` after pip, for example:\n```shell\n$ python3 -m pip install --extra-index-url https://test.pypi.org/simple/ pymilvus==2.1.0.dev66\n```\n\n\n## License\n[Apache License 2.0](LICENSE)\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Sdk for Milvus",
"version": "2.5.3",
"project_urls": {
"repository": "https://github.com/milvus-io/pymilvus"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7eef2a5682e02ef69465f7a50aa48fd9ac3fe12a3f653f51cbdc211a28557efc",
"md5": "6fd6a6cdca7275338a11cf3a2fd4f762",
"sha256": "64ca63594284586937274800be27a402f3be2d078130bf81d94ab8d7798ac9c8"
},
"downloads": -1,
"filename": "pymilvus-2.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6fd6a6cdca7275338a11cf3a2fd4f762",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 229867,
"upload_time": "2025-01-02T11:19:58",
"upload_time_iso_8601": "2025-01-02T11:19:58.151849Z",
"url": "https://files.pythonhosted.org/packages/7e/ef/2a5682e02ef69465f7a50aa48fd9ac3fe12a3f653f51cbdc211a28557efc/pymilvus-2.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a98aa10d29f5d9c9c33ac71db4594e3e6230279d557d6bd5fde6f99d1edfc360",
"md5": "2ce2d34bac5449f230a3675b5c4955e9",
"sha256": "68bc3797b7a14c494caf116cee888894ffd6eba7b96a3ac841be85d60694cc5d"
},
"downloads": -1,
"filename": "pymilvus-2.5.3.tar.gz",
"has_sig": false,
"md5_digest": "2ce2d34bac5449f230a3675b5c4955e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1258217,
"upload_time": "2025-01-02T11:20:01",
"upload_time_iso_8601": "2025-01-02T11:20:01.136551Z",
"url": "https://files.pythonhosted.org/packages/a9/8a/a10d29f5d9c9c33ac71db4594e3e6230279d557d6bd5fde6f99d1edfc360/pymilvus-2.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-02 11:20:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "milvus-io",
"github_project": "pymilvus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "build",
"specs": [
[
"==",
"0.4.0"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.7.4"
]
]
},
{
"name": "chardet",
"specs": [
[
"==",
"4.0.0"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
">=",
"1.0.1"
],
[
"<",
"2.0.0"
]
]
},
{
"name": "grpcio",
"specs": [
[
"==",
"1.62.2"
]
]
},
{
"name": "grpcio-testing",
"specs": [
[
"==",
"1.62.2"
]
]
},
{
"name": "grpcio-tools",
"specs": [
[
"==",
"1.62.2"
]
]
},
{
"name": "protobuf",
"specs": [
[
"==",
"4.25.2"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.7"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"20.9"
]
]
},
{
"name": "pep517",
"specs": [
[
"==",
"0.10.0"
]
]
},
{
"name": "pyparsing",
"specs": [
[
"==",
"2.4.7"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "toml",
"specs": [
[
"==",
"0.10.2"
]
]
},
{
"name": "ujson",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"1.26.19"
]
]
},
{
"name": "m2r",
"specs": [
[
"==",
"0.3.1"
]
]
},
{
"name": "Sphinx",
"specs": [
[
"==",
"4.0.0"
]
]
},
{
"name": "sphinx-copybutton",
"specs": []
},
{
"name": "sphinx-rtd-theme",
"specs": []
},
{
"name": "sphinxcontrib-applehelp",
"specs": []
},
{
"name": "sphinxcontrib-devhelp",
"specs": []
},
{
"name": "sphinxcontrib-htmlhelp",
"specs": []
},
{
"name": "sphinxcontrib-jsmath",
"specs": []
},
{
"name": "sphinxcontrib-qthelp",
"specs": []
},
{
"name": "sphinxcontrib-serializinghtml",
"specs": []
},
{
"name": "sphinxcontrib-napoleon",
"specs": []
},
{
"name": "sphinxcontrib-prettyspecialmethods",
"specs": []
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.66.3"
]
]
},
{
"name": "pyarrow",
"specs": [
[
">=",
"12.0.0"
]
]
},
{
"name": "pytest",
"specs": [
[
">=",
"5.3.4"
]
]
},
{
"name": "pytest-cov",
"specs": [
[
">=",
"2.8.1"
]
]
},
{
"name": "pytest-timeout",
"specs": [
[
">=",
"1.3.4"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.1.5"
]
]
},
{
"name": "ruff",
"specs": [
[
">=",
"0.2.0"
]
]
},
{
"name": "black",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "minio",
"specs": []
},
{
"name": "azure-storage-blob",
"specs": []
},
{
"name": "milvus-lite",
"specs": [
[
">=",
"2.4.0"
]
]
}
],
"lcname": "pymilvus"
}
JSON
