# Aerospike Vector Client Python
Python client for Aerospike VectorDB
## Prerequisites
- Python 3.8 or higher
- pip version 9.0.1 or higher
- Aerospike VectorDB and Aerospike clusters running.
## Using the client from your application using pip
To resolve the client packages using pip, add the following to $HOME/.pip/pip.conf
```ini
[global]
extra-index-url=https://<jfrog-username>:<jfrog-access-token>@aerospike.jfrog.io/artifactory/api/pypi/ecosystem-python-dev-local/simple
```
### Install the aerospike_vector using pip
```shell
python3 -m pip install aerospike-vector
```
Or
You can add the package name `aerospike-vector` to your application's `requirements.txt` and install all dependencies using
```shell
python3 -m pip install -r requirements.txt
```
## Building the client
### Setup build 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/proximus-examples) for working samples.
Raw data
{
"_id": null,
"home_page": null,
"name": "aerospike-vector",
"maintainer": null,
"docs_url": null,
"requires_python": ">3.8",
"maintainer_email": null,
"keywords": "aerospike, vector, database, ANN",
"author": null,
"author_email": "\"Aerospike, Inc.\" <info@aerospike.com>",
"download_url": "https://files.pythonhosted.org/packages/f3/80/7b63c0514d7ae78746ebeb6ff448416f0e14971323eece22026f2890aa15/aerospike-vector-0.4.0.tar.gz",
"platform": null,
"description": "# Aerospike Vector Client Python\nPython client for Aerospike VectorDB\n\n## Prerequisites\n - Python 3.8 or higher\n - pip version 9.0.1 or higher\n - Aerospike VectorDB and Aerospike clusters running.\n\n\n## Using the client from your application using pip\nTo resolve the client packages using pip, add the following to $HOME/.pip/pip.conf\n\n```ini\n[global]\nextra-index-url=https://<jfrog-username>:<jfrog-access-token>@aerospike.jfrog.io/artifactory/api/pypi/ecosystem-python-dev-local/simple \n```\n\n### Install the aerospike_vector using pip\n```shell\npython3 -m pip install aerospike-vector\n```\nOr \n\nYou can add the package name `aerospike-vector` to your application's `requirements.txt` and install all dependencies using\n```shell\npython3 -m pip install -r requirements.txt\n```\n\n## Building the client\n### Setup build Python Virtual Environment\nThis is the recommended mode for building the python client.\n\n```shell\n# Create virtual environment to isolate dependencies.\npython3 -m venv .venv\nsource .venv/bin/activate\n```\n\n### Install requirements\n```shell\npython3 -m pip install -vvv -r requirements.txt\n```\n\n### Generate gRPC client code\n```shell\n# Generate the gRPC client code\n./proto/codegen.sh\n```\n\n### Build the package\n```shell\npython3 -m pip install build\npython3 -m build\n```\n\n## Examples\n\nSee [examples](https://github.com/aerospike/proximus-examples) for working samples.\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Aerospike Proximus Client Library for Python",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://aerospike.com"
},
"split_keywords": [
"aerospike",
" vector",
" database",
" ann"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c8e09b42c51fb4da5db2d863fd37961a5cb9b92c48b81acccd62d9ab29bc5200",
"md5": "d28618be811e0e05fcc41fd9f5554b95",
"sha256": "40710aff4f2968cf8ecc5276b05c991758871e0e10f8a1b9f915ce18ae90641a"
},
"downloads": -1,
"filename": "aerospike_vector-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d28618be811e0e05fcc41fd9f5554b95",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3.8",
"size": 30534,
"upload_time": "2024-04-11T16:27:36",
"upload_time_iso_8601": "2024-04-11T16:27:36.642341Z",
"url": "https://files.pythonhosted.org/packages/c8/e0/9b42c51fb4da5db2d863fd37961a5cb9b92c48b81acccd62d9ab29bc5200/aerospike_vector-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f3807b63c0514d7ae78746ebeb6ff448416f0e14971323eece22026f2890aa15",
"md5": "c464c53f38b1cc6a3e6cac4f7f8d1e01",
"sha256": "ae77b59e440ddb1f908eccf22c52dc8ed8fab402308f6f732fcd3877ccfc3d85"
},
"downloads": -1,
"filename": "aerospike-vector-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "c464c53f38b1cc6a3e6cac4f7f8d1e01",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.8",
"size": 23023,
"upload_time": "2024-04-11T16:27:38",
"upload_time_iso_8601": "2024-04-11T16:27:38.446000Z",
"url": "https://files.pythonhosted.org/packages/f3/80/7b63c0514d7ae78746ebeb6ff448416f0e14971323eece22026f2890aa15/aerospike-vector-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 16:27:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "aerospike-vector"
}
JSON