Milvus Python SDK
Python SDK for Milvus. To contribute code to this project, please read our contribution guidelines first. If you have some ideas or encounter a problem, you can find us in the Slack channel #py-milvus.
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.X |
| 2.5.* | 2.5.X |
| 2.6.* | 2.6.X |
Installation
You can install PyMilvus via pip or pip3 for Python 3.8+:
$ 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:
$ pip3 install pymilvus==2.4.10
You can upgrade PyMilvus to the latest version by:
$ pip3 install --upgrade pymilvus
FAQ
Local development commands use uv. Install uv before running the
make targets below.
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 for details.
$ git submodule update --init
Q2. How to generate python files from milvus-proto?
A2.
$ make gen_proto
Q3. How to use the local PyMilvus repository for Milvus server?
A3.
$ make install
Q4. How to check and auto-fix the coding styles?
A4.
make lint
make format
Q5. How to set up pre-commit hooks to automatically check and fix the coding styles?
Once installed, the hooks will automatically run make format and make lint before each commit. If the checks fail, the commit will be aborted, and you'll need to fix the issues before committing again.
A5. Pre-commit hooks help ensure code quality by automatically running linting and formatting checks before each commit.
# Install pre-commit (if not already installed)
$ uv tool install pre-commit
# Install the git hook scripts
$ pre-commit install
Q7. How to run the maintained test suites?
A7
$ uv sync --group dev
$ make unittest
$ make integration-lite
Q8. zsh: no matches found: pymilvus[model], how do I solve this?
A8
$ pip install "pymilvus[model]"
Documentation
Documentation is available online: https://milvus.io/api-reference/pymilvus/v2.6.x/About.md
Developing package releases
The commits on the development branch of each version will be packaged and uploaded to Test PyPI.
The package name generated by the development branch is x.y.z.rc, where 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:
$ python3 -m pip install --extra-index-url https://test.pypi.org/simple/ pymilvus==2.1.0.dev66
License
Release files for pymilvus 2.6.18
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pymilvus-2.6.18.tar.gz | 320.9 kB | Without provenance | Details for pymilvus-2.6.18.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pymilvus-2.6.18-py3-none-any.whl | Python 3 | none | any | Details for pymilvus-2.6.18-py3-none-any.whl |
Total release size: 678.1 kB
Release files / pymilvus-2.6.18.tar.gz
| Download URL | pymilvus-2.6.18.tar.gz |
|---|---|
| Size | 320.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2db3fb297551a98db5d8620d7c47f6670e45168a691c31288020cf7ef8d8db83
|
|
BLAKE2b-256 checksum How to use checksums |
1f469930c94515ee2e926ccc845e332586b23d053913dd72cd7486bb34c1517b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / pymilvus-2.6.18-py3-none-any.whl
| Download URL | pymilvus-2.6.18-py3-none-any.whl |
|---|---|
| Size | 357.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a95a628c7ed94f406b7125a716479aca695b83a2e042cc94388fb8573795a0f3
|
|
BLAKE2b-256 checksum How to use checksums |
b119fdb31fa112d984238175d195919ece736db05e3d2158dd52f2ed50952405
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for pymilvus 2.6.18
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
