Universal SDK for Vector DBs
Project description
Vector SDK
Universal SDK for Vector Databases
Features
- Universal interface for multiple vector databases
- Type-safe operations
- Consistent API across different vector DB providers
- Built-in telemetry (optional)
Installation
pip install vector-sdk
Development Setup
Prerequisites
- Python 3.10 or higher
- Git
- pip (for installing uv)
Local Development Setup
-
Add Remote Repository to Your Local Repository:
git remote add origin https://github.com/dhruv-anand-aintech/vector-sdk.git git fetch origin git checkout -b main origin/main
-
Install Development Tools:
pip install -U uv pre-commit
-
Set Up the Development Environment:
# Create and activate virtual environment # Windows python -m venv .venv .venv\Scripts\activate # Unix/Mac python -m venv .venv source .venv/bin/activate # Install dependencies uv pip install -e ".[dev]" # Setup pre-commit hooks pre-commit install
Project Structure
vector-sdk/
├── src/ # Source code
│ └── vector_sdk/ # Main package
├── tests/ # Test files
├── docs/ # Documentation
└── .github/ # GitHub Actions workflows
Development Workflow
- Create a new branch for your feature/fix
- Make your changes
- Commit your changes (pre-commit hooks will run automatically)
- Push and create a PR
Version Management
We use semantic versioning (X.Y.Z):
- X: Major version (breaking changes)
- Y: Minor version (new features)
- Z: Patch version (bug fixes)
To bump version:
python bump_version.py <major|minor|patch|rc|release>
Release Process
- Bump version using
bump_version.py
- Run release script: (Only for Windows PowerShell)
.\release.ps1 <rc|release>
Documentation
Detailed documentation is available in the docs/
directory:
License
MIT License - see LICENSE file for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
vector_sdk-0.1.1.tar.gz
(21.6 kB
view details)
Built Distribution
File details
Details for the file vector_sdk-0.1.1.tar.gz
.
File metadata
- Download URL: vector_sdk-0.1.1.tar.gz
- Upload date:
- Size: 21.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 853e27f1609c51ec051bd28f835f179b5f90ca653977bad8748039a2d8d815c8 |
|
MD5 | 3c6b88c6d3ee6b09a6385bff69043865 |
|
BLAKE2b-256 | 4b4d7f3f378af84134914f93dce4051c6b92e6e2264552a92d5193cd7d4549fb |
File details
Details for the file vector_sdk-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: vector_sdk-0.1.1-py3-none-any.whl
- Upload date:
- Size: 16.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | afd203f9e5fa885c84e48022b9a40b76acf3a9f96d74127b68f9b6f4f220edde |
|
MD5 | bee0d25b3c7c775927b84a68ef9cf091 |
|
BLAKE2b-256 | 9dd327c11a84dc80e116b5646d9e726dc91e1df80575a01e7ddb2f5d0f0e1c85 |