Skip to main content

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

🔗 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

🤝 Contributing

Contributions welcome! Please see CONTRIBUTING.md in the repository.

⭐ Support

If you find this useful, please star the repository!

https://github.com/neetpalsingh/ChromaDB-Admin-managment

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

chromadb_admin-1.0.4.tar.gz (119.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chromadb_admin-1.0.4-py3-none-any.whl (118.8 kB view details)

Uploaded Python 3

File details

Details for the file chromadb_admin-1.0.4.tar.gz.

File metadata

  • Download URL: chromadb_admin-1.0.4.tar.gz
  • Upload date:
  • Size: 119.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.4

File hashes

Hashes for chromadb_admin-1.0.4.tar.gz
Algorithm Hash digest
SHA256 6312ac25d2e0dcb4a47e08c76eb797600c44cf38e23d3adfc9923400cf63c316
MD5 bf860939a4d5c257d86321ff39ea447d
BLAKE2b-256 5518557a384859d0d6ec8cf3e6b2b1a96779f65f8d343d8d80a10ac3505d68dd

See more details on using hashes here.

File details

Details for the file chromadb_admin-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: chromadb_admin-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 118.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.4

File hashes

Hashes for chromadb_admin-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 440e03892b3d944a8a010a327082029610505684e0077a81d7764ccfd08a0d7c
MD5 abbdba48fa90959a1a63d798fafd0068
BLAKE2b-256 7c9ac6d64fe80c63ca1f709c3c1d0775c7ee72e33e88a009948f0d1a43706f33

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page