Merge pull request #12 from aerospike/Aerospike-Vector-Search-Client-…

…0.5.0

aerospike-vector-search client python release 0.5.0
Added sync and reconfigured async to the aio module
Reconfigured wait_interval to be more consistent

README.md

@@ -1,10 +1,10 @@
-# Aerospike Vector Client Python
-Python client for Aerospike VectorDB
+# Aerospike Vector Search Client Python
+Python client for Aerospike Vector Search Database
 
 ## Prerequisites
  - Python 3.8 or higher
  - pip version 9.0.1 or higher
- - Aerospike VectorDB and Aerospike clusters running.
+ - Aerospike Vector Search DB and Aerospike clusters running.
 
 
 ## Using the client from your application using pip
@@ -15,13 +15,13 @@ To resolve the client packages using pip, add the following to $HOME/.pip/pip.co
 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
+### Install the aerospike_vector_search using pip
 ```shell
-python3 -m pip install aerospike-vector
+python3 -m pip install aerospike-vector-search
 ```
 Or 
 
-You can add the package name `aerospike-vector` to your application's `requirements.txt` and install all dependencies using
+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
 ```

docs/conf.py

@@ -6,10 +6,10 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'aerospike-vector'
+project = 'aerospike-vector-search'
 copyright = '2024, Dominic Pelini'
 author = 'Dominic Pelini'
-release = '0.4.0'
+release = '0.5.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/index.rst

@@ -1,9 +1,9 @@
-.. aerospike-vector documentation master file, created by
+.. aerospike-vector-search documentation master file, created by
    sphinx-quickstart on Thu Apr 11 07:35:51 2024.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Aerospike Vector Client for Python.
+Welcome to Aerospike Vector Search Client for Python.
 
 This package splits the client functionality into two separate clients.
 

docs/requirements.txt

@@ -1,2 +1,2 @@
 sphinx_rtd_theme
-aerospike-vector
+aerospike-vector-search

docs/types.rst

@@ -3,7 +3,7 @@ types
 
 This module provides administrative functions for the VectorDB system.
 
-.. automodule:: aerospike_vector.types
+.. automodule:: aerospike_vector_search.types
    :members:
    :undoc-members:
    :show-inheritance:

docs/vectordb_admin.rst

@@ -4,7 +4,7 @@ vectordb_admin Module
 This module contains the admin client, which is designed to conduct Proximus administrative operation such as creating indexes, querying index information, and dropping indexes.
 
 
-.. automodule:: aerospike_vector.vectordb_admin
+.. automodule:: aerospike_vector_search.vectordb_admin
    :members:
    :undoc-members:
    :show-inheritance:

docs/vectordb_client.rst

@@ -4,7 +4,7 @@ vectordb_client Module
 This module contains the vector client (VectorDbClient), which specializes in performing database operations with vector data.
 
 
-.. automodule:: aerospike_vector.vectordb_client
+.. automodule:: aerospike_vector_search.vectordb_client
    :members:
    :undoc-members:
    :show-inheritance:

proto/codegen.sh

@@ -6,10 +6,10 @@ cd "$(dirname "$0")"
 python3 -m pip install grpcio-tools
 python3 -m grpc_tools.protoc \
   --proto_path=. \
-  --python_out=../src/aerospike_vector/ \
-  --grpc_python_out=../src/aerospike_vector/ \
+  --python_out=../src/aerospike_vector_search/shared/proto_generated/ \
+  --grpc_python_out=../src/aerospike_vector_search/shared/proto_generated/ \
   *.proto
 
 # The generated imports are not relative and fail in generated packages.
 # Fix with relative imports.
-find ../src/aerospike_vector/ -name "*.py" -exec sed -i -e 's/^import \(.*\)_pb2 /from . import \1_pb2 /g' {} \;
+find ../src/aerospike_vector_search/shared/proto_generated/ -name "*.py" -exec sed -i -e 's/^import \(.*\)_pb2 /from . import \1_pb2 /g' {} \;

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools","wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "aerospike-vector"
+name = "aerospike-vector-search"
 description = "Aerospike Proximus Client Library for Python"
 authors = [
     { name = "Aerospike, Inc.", email = "[email protected]" }
@@ -22,7 +22,7 @@ classifiers = [
     "Programming Language :: Python :: Implementation :: CPython",
     "Topic :: Database"
 ]
-version = "0.4.0"
+version = "0.5.0"
 requires-python = ">3.8"
 dependencies = [
     "grpcio",
@@ -35,5 +35,5 @@ dependencies = [
 [tool.setuptools]
 zip-safe = false
 include-package-data = true
-packages = ["aerospike_vector"]
+packages = ["aerospike_vector_search", "aerospike_vector_search.aio", "aerospike_vector_search.shared", "aerospike_vector_search.shared.proto_generated", "aerospike_vector_search.internal", "aerospike_vector_search.aio.internal"]
 package-dir={"" = "src"}