graphforge 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- graphforge-0.1.0/.github/workflows/publish.yaml +16 -0
- graphforge-0.1.0/.gitignore +10 -0
- graphforge-0.1.0/.python-version +1 -0
- graphforge-0.1.0/LICENSE +21 -0
- graphforge-0.1.0/PKG-INFO +126 -0
- graphforge-0.1.0/README.md +111 -0
- graphforge-0.1.0/docs/0-requirements.md +586 -0
- graphforge-0.1.0/docs/open_cypher_ast_logical_plan_spec_v_1.md +313 -0
- graphforge-0.1.0/docs/runtime_value_model_graph_execution_v_1.md +254 -0
- graphforge-0.1.0/pyproject.toml +29 -0
- graphforge-0.1.0/src/graphforge/__init__.py +0 -0
- graphforge-0.1.0/src/graphforge/main.py +6 -0
- graphforge-0.1.0/uv.lock +177 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.13
|
graphforge-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 David Spencer
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: graphforge
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Composable graph tooling for analysis, construction, and refinement
|
|
5
|
+
Project-URL: Homepage, https://github.com/your-org/graphforge
|
|
6
|
+
Project-URL: Repository, https://github.com/your-org/graphforge
|
|
7
|
+
Project-URL: Issues, https://github.com/your-org/graphforge/issues
|
|
8
|
+
Author: David Spencer
|
|
9
|
+
License: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: analysis,graph,opencypher,pydantic
|
|
12
|
+
Requires-Python: >=3.10
|
|
13
|
+
Requires-Dist: pydantic>=2.6
|
|
14
|
+
Description-Content-Type: text/markdown
|
|
15
|
+
|
|
16
|
+
<p align="center">
|
|
17
|
+
<img src="https://img.shields.io/pypi/v/graphforge?style=for-the-badge" alt="PyPI version" />
|
|
18
|
+
<img src="https://img.shields.io/badge/python-3.10+-3776ab?style=for-the-badge&logo=python&logoColor=white" alt="Python" />
|
|
19
|
+
<img src="https://img.shields.io/badge/license-MIT-22c55e?style=for-the-badge" alt="License" />
|
|
20
|
+
<img src="https://img.shields.io/badge/pydantic-2.6+-e92063?style=for-the-badge&logo=pydantic&logoColor=white" alt="Pydantic" />
|
|
21
|
+
<img src="https://img.shields.io/badge/openCypher%20TCK%20target-2024.2-6c4f7c?style=for-the-badge" alt="openCypher TCK target" />
|
|
22
|
+
</p>
|
|
23
|
+
|
|
24
|
+
<h1 align="center">GraphForge</h1>
|
|
25
|
+
<p align="center">
|
|
26
|
+
<strong>Composable graph tooling for analysis, construction, and refinement</strong>
|
|
27
|
+
</p>
|
|
28
|
+
|
|
29
|
+
<p align="center">
|
|
30
|
+
A lightweight, embedded, openCypher-compatible graph engine for research and investigative workflows
|
|
31
|
+
</p>
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## Why GraphForge?
|
|
36
|
+
|
|
37
|
+
Modern data science and ML workflows increasingly produce **graph-shaped data**—entities and relationships extracted from text, tables, and LLM outputs. Yet practitioners face a painful choice:
|
|
38
|
+
|
|
39
|
+
| | NetworkX | Production DBs (Neo4j, Memgraph) |
|
|
40
|
+
|:---|:---|:---|
|
|
41
|
+
| **Durability** | Manual serialization only | ✓ Persistent |
|
|
42
|
+
| **Query language** | None | Cypher |
|
|
43
|
+
| **Operational overhead** | Minimal | High (services, config) |
|
|
44
|
+
| **Notebook-friendly** | ✓ | ✗ |
|
|
45
|
+
| **Iterative analysis** | ✓ | Poor |
|
|
46
|
+
|
|
47
|
+
**GraphForge** fills the gap—embedded, durable, and declarative—without running external services.
|
|
48
|
+
|
|
49
|
+
> *We are not building a database for applications.*
|
|
50
|
+
> *We are building a graph execution environment for thinking.*
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Features
|
|
55
|
+
|
|
56
|
+
- **Embedded & local-first** — No server, no daemon. Runs entirely inside your Python process.
|
|
57
|
+
- **openCypher subset** — Declarative pattern matching with semantic correctness validated against the TCK.
|
|
58
|
+
- **Graph-native execution** — Adjacency-based traversal, not relational joins.
|
|
59
|
+
- **Durable but disposable** — Persist graphs across restarts; treat them as analytical artifacts.
|
|
60
|
+
- **Python-first** — Designed for notebooks, scripts, and agentic pipelines.
|
|
61
|
+
|
|
62
|
+
### Planned v1 Scope
|
|
63
|
+
|
|
64
|
+
- **MATCH** (nodes, relationships, directionality)
|
|
65
|
+
- **WHERE** (boolean logic, comparisons, property access)
|
|
66
|
+
- **RETURN**, **LIMIT**, **SKIP**
|
|
67
|
+
- Node and relationship materialization
|
|
68
|
+
- Optional Pydantic-backed data models for validation
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Installation
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
# Using uv (recommended)
|
|
76
|
+
uv add graphforge
|
|
77
|
+
|
|
78
|
+
# Using pip
|
|
79
|
+
pip install graphforge
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
**Requirements:** Python 3.10+
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## Quick Start
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
from graphforge import GraphForge
|
|
90
|
+
|
|
91
|
+
# Create a graph (API in development)
|
|
92
|
+
db = GraphForge("my-graph.db")
|
|
93
|
+
|
|
94
|
+
# Execute openCypher queries
|
|
95
|
+
rows = db.execute("""
|
|
96
|
+
MATCH (n:Person)
|
|
97
|
+
WHERE n.age > 30
|
|
98
|
+
RETURN n.name
|
|
99
|
+
LIMIT 5
|
|
100
|
+
""")
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
> **Note:** GraphForge is early in development. The core API and storage layer are being built out per the [requirements document](docs/0-requirements.md).
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## Design Principles
|
|
108
|
+
|
|
109
|
+
- **Spec-driven correctness** — openCypher semantics over performance.
|
|
110
|
+
- **Deterministic & reproducible** — Stable behavior across runs.
|
|
111
|
+
- **Inspectable** — Query plans, storage layout, and execution behavior are observable.
|
|
112
|
+
- **Replaceable internals** — Minimal operational overhead, stable APIs.
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## Links
|
|
117
|
+
|
|
118
|
+
- [Requirements document](docs/0-requirements.md) — Full scope, TCK strategy, and design rationale
|
|
119
|
+
- [openCypher AST spec](docs/open_cypher_ast_logical_plan_spec_v_1.md)
|
|
120
|
+
- [Runtime value model](docs/runtime_value_model_graph_execution_v_1.md)
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## License
|
|
125
|
+
|
|
126
|
+
MIT © David Spencer
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://img.shields.io/pypi/v/graphforge?style=for-the-badge" alt="PyPI version" />
|
|
3
|
+
<img src="https://img.shields.io/badge/python-3.10+-3776ab?style=for-the-badge&logo=python&logoColor=white" alt="Python" />
|
|
4
|
+
<img src="https://img.shields.io/badge/license-MIT-22c55e?style=for-the-badge" alt="License" />
|
|
5
|
+
<img src="https://img.shields.io/badge/pydantic-2.6+-e92063?style=for-the-badge&logo=pydantic&logoColor=white" alt="Pydantic" />
|
|
6
|
+
<img src="https://img.shields.io/badge/openCypher%20TCK%20target-2024.2-6c4f7c?style=for-the-badge" alt="openCypher TCK target" />
|
|
7
|
+
</p>
|
|
8
|
+
|
|
9
|
+
<h1 align="center">GraphForge</h1>
|
|
10
|
+
<p align="center">
|
|
11
|
+
<strong>Composable graph tooling for analysis, construction, and refinement</strong>
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
<p align="center">
|
|
15
|
+
A lightweight, embedded, openCypher-compatible graph engine for research and investigative workflows
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Why GraphForge?
|
|
21
|
+
|
|
22
|
+
Modern data science and ML workflows increasingly produce **graph-shaped data**—entities and relationships extracted from text, tables, and LLM outputs. Yet practitioners face a painful choice:
|
|
23
|
+
|
|
24
|
+
| | NetworkX | Production DBs (Neo4j, Memgraph) |
|
|
25
|
+
|:---|:---|:---|
|
|
26
|
+
| **Durability** | Manual serialization only | ✓ Persistent |
|
|
27
|
+
| **Query language** | None | Cypher |
|
|
28
|
+
| **Operational overhead** | Minimal | High (services, config) |
|
|
29
|
+
| **Notebook-friendly** | ✓ | ✗ |
|
|
30
|
+
| **Iterative analysis** | ✓ | Poor |
|
|
31
|
+
|
|
32
|
+
**GraphForge** fills the gap—embedded, durable, and declarative—without running external services.
|
|
33
|
+
|
|
34
|
+
> *We are not building a database for applications.*
|
|
35
|
+
> *We are building a graph execution environment for thinking.*
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Features
|
|
40
|
+
|
|
41
|
+
- **Embedded & local-first** — No server, no daemon. Runs entirely inside your Python process.
|
|
42
|
+
- **openCypher subset** — Declarative pattern matching with semantic correctness validated against the TCK.
|
|
43
|
+
- **Graph-native execution** — Adjacency-based traversal, not relational joins.
|
|
44
|
+
- **Durable but disposable** — Persist graphs across restarts; treat them as analytical artifacts.
|
|
45
|
+
- **Python-first** — Designed for notebooks, scripts, and agentic pipelines.
|
|
46
|
+
|
|
47
|
+
### Planned v1 Scope
|
|
48
|
+
|
|
49
|
+
- **MATCH** (nodes, relationships, directionality)
|
|
50
|
+
- **WHERE** (boolean logic, comparisons, property access)
|
|
51
|
+
- **RETURN**, **LIMIT**, **SKIP**
|
|
52
|
+
- Node and relationship materialization
|
|
53
|
+
- Optional Pydantic-backed data models for validation
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Installation
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
# Using uv (recommended)
|
|
61
|
+
uv add graphforge
|
|
62
|
+
|
|
63
|
+
# Using pip
|
|
64
|
+
pip install graphforge
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Requirements:** Python 3.10+
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## Quick Start
|
|
72
|
+
|
|
73
|
+
```python
|
|
74
|
+
from graphforge import GraphForge
|
|
75
|
+
|
|
76
|
+
# Create a graph (API in development)
|
|
77
|
+
db = GraphForge("my-graph.db")
|
|
78
|
+
|
|
79
|
+
# Execute openCypher queries
|
|
80
|
+
rows = db.execute("""
|
|
81
|
+
MATCH (n:Person)
|
|
82
|
+
WHERE n.age > 30
|
|
83
|
+
RETURN n.name
|
|
84
|
+
LIMIT 5
|
|
85
|
+
""")
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
> **Note:** GraphForge is early in development. The core API and storage layer are being built out per the [requirements document](docs/0-requirements.md).
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## Design Principles
|
|
93
|
+
|
|
94
|
+
- **Spec-driven correctness** — openCypher semantics over performance.
|
|
95
|
+
- **Deterministic & reproducible** — Stable behavior across runs.
|
|
96
|
+
- **Inspectable** — Query plans, storage layout, and execution behavior are observable.
|
|
97
|
+
- **Replaceable internals** — Minimal operational overhead, stable APIs.
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Links
|
|
102
|
+
|
|
103
|
+
- [Requirements document](docs/0-requirements.md) — Full scope, TCK strategy, and design rationale
|
|
104
|
+
- [openCypher AST spec](docs/open_cypher_ast_logical_plan_spec_v_1.md)
|
|
105
|
+
- [Runtime value model](docs/runtime_value_model_graph_execution_v_1.md)
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## License
|
|
110
|
+
|
|
111
|
+
MIT © David Spencer
|