GraphIO
OGM and data loader for Neo4j with two main approaches:
- OGM (Object Graph Mapper): Pydantic-based models with Neo4j integration for complex data models and applications
- Datasets (NodeSet/RelationshipSet): Bulk data containers optimized for fast data loading and testing
- Multi-Database Support: Full support for Neo4j Enterprise Edition multi-database feature
Documentation
Docs available at: https://graphio.readthedocs.io
Quick Start
Installation
Install graphio from PyPI:
pip install graphio
Install the latest version from GitHub:
pip install git+https://github.com/kaiserpreusse/graphio.git
Example
from graphio import NodeModel, Base
from neo4j import GraphDatabase
# Set up connection
driver = GraphDatabase.driver('neo4j://localhost:7687', auth=('neo4j', 'password'))
Base.set_driver(driver)
# Optional: Set target database (Enterprise Edition)
# Base.set_database('production')
# Define OGM model for structure and validation
class Person(NodeModel):
_labels = ['Person']
_merge_keys = ['email']
name: str
email: str
# Get bulk container directly from OGM model
people = Person.dataset() # Automatically uses Person's labels and merge_keys
for person_data in large_dataset:
# Create validated OGM instance and add directly
person = Person(**person_data) # Pydantic validation happens here
people.add(person) # Add validated instance to bulk dataset
people.create(driver) # Bulk create with validation benefits
# Use OGM for application logic
alice = Person.match(Person.email == 'alice@example.com').first()
Development
Prerequisites
- Python 3.10+
- uv (recommended) or pip
- Docker for running test databases
Setup
# Clone the repository
git clone https://github.com/kaiserpreusse/graphio.git
cd graphio
# Install dependencies
uv sync --extra dev
# Start Neo4j test databases
make localdb
Common Commands
# Run tests
make test
# Check code style
make lint
# Format code
make format
# Fix linting issues and format
make fix
# Run all checks (lint + test)
make check
# Serve documentation locally
make docs
# See all available commands
make help
Testing
The test suite requires Docker containers running Neo4j. Start them with:
make localdb
Then run tests with:
make test
# or directly:
uv run pytest
All tests using the graph fixture will run against both Neo4j Community and Enterprise editions.
Feedback
Please provide feedback, ideas and bug reports through GitHub issues.
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 graphio-0.22.tar.gz.
File metadata
- Download URL: graphio-0.22.tar.gz
- Upload date:
- Size: 97.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6ed578ddfa4daaed368bf7c54a099ae2df2962fb0a3639251248d2f04f1a9bdf
|
|
| MD5 |
ea0a79bbcc809d4440a9e01225513aca
|
|
| BLAKE2b-256 |
bf7eea9127fa66a25348522b8d744dce62d455959596fe8dab5c86cf048c674c
|
File details
Details for the file graphio-0.22-py3-none-any.whl.
File metadata
- Download URL: graphio-0.22-py3-none-any.whl
- Upload date:
- Size: 27.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
524e4606f1ef40575a53a8f7bc4d5e86bfc8ce20db64c95c37ebb06280c21f1e
|
|
| MD5 |
7d014c128bef463e253472bbb679b348
|
|
| BLAKE2b-256 |
c1ce6cec8bebe25ffbc576e3ac648531c6a7f96e65d30399ad5440cf145bd93b
|
