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

1. 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
   

2. Install Development Tools:

   pip install -U uv pre-commit
   

3. 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

1. Create a new branch for your feature/fix
2. Make your changes
3. Commit your changes (pre-commit hooks will run automatically)
4. 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

1. Bump version using bump_version.py
2. Run release script: (Only for Windows PowerShell)

   .\release.ps1 <rc|release>
   

Documentation

Detailed documentation is available in the docs/ directory:

• Installation Guide
• Usage Instructions
• Telemetry Information
• Versioning Information

License

MIT License - see LICENSE file for details