SmartKDB v5 Installation Guide

Quick Install

pip install smartkdb

That’s it! SmartKDB has zero dependencies and works on all platforms.

Detailed Installation

Requirements

Python 3.8 or higher
pip (Python package manager)

Verify Python Version

python --version
# Should show: Python 3.8.x or higher

Install from PyPI

pip install smartkdb

# Or upgrade existing installation
pip install --upgrade smartkdb

Install from Source (for developers)

git clone https://github.com/alhdrawi/smartkdb
cd smartkdb
pip install -e .

Verify Installation

Run this to confirm everything works:

from smartkdb import SmartKDB

db = SmartKDB("test.kdb")
users = db.create_table("users")
users.insert({"name": "Test User"})

print("✅ SmartKDB is working!")

Platform-Specific Notes

Windows

pip install smartkdb

macOS / Linux

pip3 install smartkdb

Virtual Environments (Recommended)

# Create virtual environment
python -m venv venv

# Activate (Windows)
venv\Scripts\activate

# Activate (macOS/Linux)
source venv/bin/activate

# Install
pip install smartkdb

IDE Setup

VS Code

Install Python extension
Open project folder
SmartKDB will provide full IntelliSense automatically!

PyCharm

Create new Python project
pip install smartkdb
Autocomplete works out of the box!

Troubleshooting

Issue: “Command not found: pip”

Solution: Install pip:

python -m ensurepip --upgrade

Issue: “Permission denied”

Solution: Use --user flag:

pip install --user smartkdb

Issue: “Module not found”

Solution: Make sure you’re using the right Python:

python -m pip install smartkdb

Next Steps

✅ Installation complete!

Now try:

Run python examples/quickstart.py
Read the User Guide
Explore the examples/ folder

Happy coding! 🚀