GraphCast 
A framework for transforming tabular (CSV, SQL) and hierarchical data (JSON, XML) into property graphs and ingesting them into graph databases (ArangoDB, Neo4j).
Core Concepts
Property Graphs
GraphCast works with property graphs, which consist of:
- Vertices: Nodes with properties and optional unique identifiers
- Edges: Relationships between vertices with their own properties
- Properties: Both vertices and edges may have properties
Schema
The Schema defines how your data should be transformed into a graph and contains:
- Vertex Definitions: Specify vertex types, their properties, and unique identifiers
- Edge Definitions: Define relationships between vertices and their properties
- Resource Mapping: describe how data sources map to vertices and edges
- Transforms: Modify data during the casting process
Resources
Resources are your data sources that can be:
- Table-like: CSV files, database tables
- JSON-like: JSON files, nested data structures
Features
- Graph Transformation Meta-language: A powerful declarative language to describe how your data becomes a property graph:
- Define vertex and edge structures
- Set compound indexes for vertices and edges
- Use blank vertices for complex relationships
- Specify edge constraints and properties
- Apply advanced filtering and transformations
- Parallel processing: Use as many cores as you have
- Database support: Ingest into ArangoDB and Neo4j using the same API (database agnostic)
Documentation
Full documentation is available at: growgraph.github.io/graphcast
Installation
pip install graphcast
Usage Examples
Simple ingest
from suthing import ConfigFactory, FileHandle
from graphcast import Schema, Caster, Patterns
schema = Schema.from_dict(FileHandle.load("schema.yaml"))
conn_conf = ConfigFactory.create_config({
"protocol": "http",
"hostname": "localhost",
"port": 8535,
"username": "root",
"password": "123",
"database": "_system",
}
)
patterns = Patterns.from_dict(
{
"patterns": {
"work": {"regex": "\Sjson$"},
}
}
)
schema.fetch_resource()
caster = Caster(
schema,
)
caster.ingest_files(
path="./data",
conn_conf=conn_conf,
patterns=patterns,
)
Development
To install requirements
git clone git@github.com:growgraph/graphcast.git && cd graphcast
uv sync --dev
Tests
Test databases
Spin up Arango from arango docker folder by
docker-compose --env-file .env up arango
and Neo4j from neo4j docker folder by
docker-compose --env-file .env up neo4j
To run unit tests
pytest test
Requirements
- Python 3.11+
- python-arango
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Metadata
Release files for graphcast 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| graphcast-1.0.0.tar.gz | 67.1 kB | Without provenance | Details for graphcast-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| graphcast-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for graphcast-1.0.0-py3-none-any.whl |
Total release size: 154.7 kB
Release files / graphcast-1.0.0.tar.gz
| Download URL | graphcast-1.0.0.tar.gz |
|---|---|
| Size | 67.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c8e3eb184cb5825e74b0361ff4477ae04df51c6db227041bb9df7aefafc90ffb
|
|
BLAKE2b-256 checksum How to use checksums |
f745044eef7598335876c950063519ce3e2c860e26e8e20cc115089347d3ffa6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.11
|
Release files / graphcast-1.0.0-py3-none-any.whl
| Download URL | graphcast-1.0.0-py3-none-any.whl |
|---|---|
| Size | 87.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b74f3014e10c6819528020033b5cb146bd61999bb3a193f3dc0c96416bb44419
|
|
BLAKE2b-256 checksum How to use checksums |
6eff3ca6e55fd3e483a481438690b577ef03fe4396bc15e4724e81c26026dfa9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.11
|
Security for graphcast 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.