Skip to main content

Installation

This guide covers installing chaoscypher-core as a standalone Python library for use in your own applications.

Requirements​

  • Python 3.14 or later
  • SQLite 3.35+ (included with Python on most platforms)

Install from PyPI​

pip install chaoscypher-core

This installs the core library with all production dependencies, including:

  • SQLModel and Pydantic for data modeling
  • sqlite-vec for vector similarity search
  • LangChain ecosystem for LLM orchestration and workflows
  • LLM provider SDKs (Ollama, OpenAI, Anthropic, Gemini)
  • Document processing (PDF, OCR, audio transcription)
  • Content normalization (encoding fixes, deduplication)

Development Extras​

For testing, linting, and type checking:

pip install chaoscypher-core[dev]

The [dev] extra adds pytest, ruff, mypy, pre-commit, pip-audit, and related tooling.

What's Included​

chaoscypher-core is the framework-agnostic brain of Chaos Cypher. It provides:

CapabilityDescription
Graph CRUDCreate, read, update, delete nodes, edges, and templates
Storage adaptersSQLite adapter with full protocol coverage
Entity extractionLLM-powered extraction from documents
RAG pipelineChunking, embedding, and vector search
Workflow engineLangGraph-based workflow execution
Graph analyticsCentrality, clustering, path analysis
SearchKeyword, vector, semantic, and hybrid search
Quality scoringEntity and relationship quality metrics

What Requires the Full Stack​

Some features need the complete Chaos Cypher platform (Cortex API + Neuron workers + Valkey + Docker):

  • Background job queue -- async processing via Valkey
  • Web UI -- React interface for graph exploration
  • REST API -- FastAPI endpoints with authentication
  • Multi-user access -- concurrent access with proper locking
  • Queue monitoring -- real-time job status dashboard

See the Getting Started guide for deploying the full platform.

Verify the Installation​

import chaoscypher_core
print(chaoscypher_core.__version__)

Next Steps​