ChromaDB Admin Management System - A web-based admin dashboard for ChromaDB
Project description
ChromaDB Admin - Python Package
A comprehensive admin dashboard and CLI tool for managing ChromaDB vector databases.
🚀 Quick Start
Installation
pip install chromadb-admin
Usage
CLI Usage
# Start with default settings (port 3434)
chromadb-admin
# Custom port
chromadb-admin --port 8080
# Custom ChromaDB URL
chromadb-admin --chromadb-url http://localhost:8000
# Full customization
chromadb-admin --port 5000 --host 0.0.0.0 --chromadb-url http://chroma:8000
# Enable auto-reload (development)
chromadb-admin --reload
Python API Usage
from chromadb_admin import start_server
# Start with defaults
start_server()
# Custom configuration
start_server(
chromadb_url="http://localhost:8000",
host="0.0.0.0",
port=3434,
reload=False
)
Using the Client Library
from chromadb_admin import ChromaDBAdminClient
# Connect to the admin API
client = ChromaDBAdminClient("http://localhost:3434")
# Get server health
health = client.health()
print(health)
# List collections
collections = client.list_collections()
print(collections)
📋 Features
- ✅ Web Dashboard - Modern React-based UI
- ✅ CLI Tool - Easy command-line interface
- ✅ Python API - Programmatic access
- ✅ Collection Management - Create, view, delete collections
- ✅ Document Operations - Add, query, update, delete documents
- ✅ Query Interface - Advanced similarity search
- ✅ Metadata Filtering - Filter by metadata
- ✅ Batch Operations - Bulk upload and export
- ✅ Multi-tenant Support - Manage multiple databases
🔧 Configuration
Environment Variables
Create a .env file:
CHROMADB_URL=http://localhost:8000
PORT=3434
HOST=0.0.0.0
CLI Arguments
chromadb-admin --help
Options:
--chromadb-url TEXT ChromaDB server URL (default: http://localhost:8000)
--port INTEGER Server port (default: 3434)
--host TEXT Server host (default: 0.0.0.0)
--reload Enable auto-reload (development)
--help Show this message and exit
📦 Installation Methods
From PyPI (Recommended)
pip install chromadb-admin
From Source
git clone https://github.com/neetpalsingh/ChromaDB-Admin-managment.git
cd ChromaDB-Admin-managment/python-package
pip install -e .
🐳 Docker Alternative
If you prefer Docker:
docker pull neetpalsingh/chromadb-admin
docker run -p 3434:3434 neetpalsingh/chromadb-admin
📚 Documentation
- GitHub Repository: https://github.com/neetpalsingh/ChromaDB-Admin-managment
- Full Documentation: See repository README
- Issues: https://github.com/neetpalsingh/ChromaDB-Admin-managment/issues
🔗 Related Packages
- NPM Package:
npm install -g chromadb-admin - Docker Image:
neetpalsingh/chromadb-admin
📄 License
MIT License - see LICENSE file for details
👤 Author
Neetpal Singh
- Email: neetpalsingh750@gmail.com
- GitHub: @neetpalsingh
🤝 Contributing
Contributions welcome! Please see CONTRIBUTING.md in the repository.
⭐ Support
If you find this useful, please star the repository!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file chromadb_admin-1.0.6.tar.gz.
File metadata
- Download URL: chromadb_admin-1.0.6.tar.gz
- Upload date:
- Size: 119.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f282a48f9cac0436d81b8c8b57729c48b24a3cad02296ad9e0d4644f7b7c4193
|
|
| MD5 |
383a44508da595735ed7ea8cfcc79994
|
|
| BLAKE2b-256 |
4d0446a54596f8ddd8f768a41ce51cd9632eb93bf2eb38e52ed9d4466061d9da
|
File details
Details for the file chromadb_admin-1.0.6-py3-none-any.whl.
File metadata
- Download URL: chromadb_admin-1.0.6-py3-none-any.whl
- Upload date:
- Size: 119.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
17a271468a77d48f78ee14884142edaf909f2d49608073b764dcbfe3e74638b0
|
|
| MD5 |
ef6d51ff8dd3107557e18dd0fa96e8f7
|
|
| BLAKE2b-256 |
9ec40b7e2d7905febf130137b1c15700e702e2889daacd0c8da4e41e9f62efff
|