https://github.com/aerospike/avs-client-python
🚀➡️🔍🐍 Aerospike Vector Search Client for Python
https://github.com/aerospike/avs-client-python
aerospike avs python vector
Last synced: about 2 months ago
JSON representation
🚀➡️🔍🐍 Aerospike Vector Search Client for Python
- Host: GitHub
- URL: https://github.com/aerospike/avs-client-python
- Owner: aerospike
- License: apache-2.0
- Created: 2023-11-22T03:26:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-17T18:42:31.000Z (about 2 months ago)
- Last Synced: 2025-04-18T08:49:02.791Z (about 2 months ago)
- Topics: aerospike, avs, python, vector
- Language: Python
- Homepage: https://aerospike.com/docs/vector
- Size: 888 KB
- Stars: 2
- Watchers: 39
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Aerospike Vector Search Client Python
Python client for the Aerospike Vector Search Database
## Prerequisites
- Python 3.9 or higher
- pip version 9.0.1 or higher
- Aerospike Vector Search DB and Aerospike clusters running.
### Install the aerospike_vector_search using pip
```shell
python3 -m pip install aerospike-vector-search
```
Or
You can add the package name `aerospike-vector-search` to your application's `requirements.txt` and install all dependencies using
```shell
python3 -m pip install -r requirements.txt
```
## Installing from Artifactory/Jfrog
The Aerospike Vector Search client is also available on our own Artifactory repository.
To resolve the Artifactory client packages, pip install with the following command.
```shell
pip install aerospike-vector-search -i https://:@aerospike.jfrog.io/artifactory/api/pypi/ecosystem-python-dev-local/simple
```
**Note**
This project makes use of the warnings module to communicate deprecations and upcoming changes.
Run your project with the `-Wd` Python flag or the `PYTHONWARNINGS=default` environment variable to display relevant warnings.
## Building the client
### Setup the Python Virtual Environment
This is the recommended mode for building the python client.
```shell
# Create virtual environment to isolate dependencies.
python3 -m venv .venv
source .venv/bin/activate
```
### Install requirements
```shell
python3 -m pip install -vvv -r requirements.txt
```
### Generate gRPC client code
```shell
# Generate the gRPC client code
./proto/codegen.sh
```
### Build the package
```shell
python3 -m pip install build
python3 -m build
```
## Examples
See [examples](https://github.com/aerospike/aerospike-vector) for sample projects.