VitalGraph
VitalGraph is a high-performance knowledge graph database and client library built on PostgreSQL with full SPARQL 1.1 support.
Installation
VitalGraph offers flexible installation options depending on your use case:
Client Only (Default - Lightweight)
For applications that only need to connect to existing VitalGraph servers:
pip install vital-graph[client]
This installs dependencies for the VitalGraph client library:
- Basic RDF processing (rdflib, PyLD)
- Advanced graph processing (pyoxigraph)
- AI capabilities (openai)
- HTTP client (httpx, aiohttp)
- Configuration management (PyYAML, pydantic)
- CLI tools (click-repl, tabulate)
Server Installation
For running a complete VitalGraph server with database capabilities:
pip install vital-graph[server]
This includes all server dependencies:
- FastAPI web framework and uvicorn server
- PostgreSQL drivers (psycopg, asyncpg)
- Database ORM (SQLAlchemy, alembic)
- Vector database support (pgvector)
- Authentication (PyJWT, email-validator)
- ML/vectorization (torch, transformers, sentencepiece)
- Fuzzy search (rapidfuzz, jellyfish, datasketch)
Development Setup
For development with all tools:
pip install vital-graph[dev]
Includes pytest, black, mypy, and other development tools.
Full Installation
For everything:
pip install vital-graph[all]
Custom Combinations
You can combine multiple extras:
pip install vital-graph[client,dev]
pip install vital-graph[server,test,docs]
Quick Start
Client Usage
from vitalgraph.client import VitalGraphClient
# Initialize client with config file
client = VitalGraphClient("path/to/config.yaml")
# Connect to server
await client.open()
# Execute SPARQL queries
results = await client.sparql.query("SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 10")
# Close connection
await client.close()
Server Usage
# Start VitalGraph server
vitalgraphdb
# Or with custom config
vitalgraphdb --config /path/to/vitalgraphdb-config.yaml
Data Import/Export
# Import RDF data (N-Triples, N-Quads, Turtle, JSONL, VitalSigns Block)
vitalgraphimport -s my_space -f data.nt
vitalgraphimport -s my_space -f entities.vital --format vital
# Export RDF data
vitalgraphexport -s my_space -f backup.nq
vitalgraphexport -s my_space -f entities.vital --format vital --entity-type-uri urn:PersonEntity
# See all options
vitalgraphimport --help
vitalgraphexport --help
Import/export is also available via the REST API (/api/data/import, /api/data/export) and the frontend Data Management page.
Features
- Full SPARQL 1.1 Support: SELECT, CONSTRUCT, ASK, DESCRIBE, UPDATE operations
- High Performance: PostgreSQL-backed with optimized query translation
- RESTful API: Complete REST API for all operations
- Client Library: Python client with authentication and session management
- Docker Support: Ready-to-use Docker containers
- Knowledge Graph Types: Built-in support for VitalSigns ontologies
- Real-time Updates: WebSocket support for live data updates
Architecture
VitalGraph consists of:
- Client Library (
vitalgraph.client): Lightweight REST API client - Server (
vitalgraph.api): FastAPI-based graph database server - SPARQL-to-SQL Engine (
vitalgraph.db.sparql_sql): Translates SPARQL 1.1 to PostgreSQL - Jena Sidecar (
vitalgraph-jena-sidecar): Java service for SPARQL algebra compilation - React Admin UI (
frontend): Web interface for space/graph/entity management - Admin Tools (
vitalgraphadmin): Database administration utilities - Import/Export CLIs (
vitalgraphimport,vitalgraphexport): Standalone data import/export tools - TypeScript Client (
vitalgraph-client-ts): TypeScript/JS client SDK
Documentation
License
Apache License 2.0
1 maintainer
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 vital_graph-0.0.36.tar.gz.
File metadata
- Download URL: vital_graph-0.0.36.tar.gz
- Upload date:
- Size: 7.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.0.1 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c6590fb31ce52e695a4cd3808b6bca95a0fb08699898a714a7282d0d3c76c36c
|
|
| MD5 |
41b59ed029864e523e01777b9ee33fcb
|
|
| BLAKE2b-256 |
3db95b26929299f292535d5eaf5dfbdea455fae38003752b87ce7dd479a5c2f7
|
File details
Details for the file vital_graph-0.0.36-py3-none-any.whl.
File metadata
- Download URL: vital_graph-0.0.36-py3-none-any.whl
- Upload date:
- Size: 7.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.0.1 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
313ee59b79c39eb9d8109b8e0a078c3b41dc79fe77e9c22e99e3b7ea30a67d45
|
|
| MD5 |
782f8c04031d2d1d968f8a9cb9df7d3c
|
|
| BLAKE2b-256 |
d6f899be76ccf04731801a0526d3aa8552bf733b801fce9c32c046327ee4a546
|
