pragmagraph 0.0.1__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.
Files changed (30) hide show
  1. pragmagraph-0.0.1/API_COMPATIBILITY.md +93 -0
  2. pragmagraph-0.0.1/LICENSE +201 -0
  3. pragmagraph-0.0.1/MANIFEST.in +10 -0
  4. pragmagraph-0.0.1/PKG-INFO +204 -0
  5. pragmagraph-0.0.1/README.md +177 -0
  6. pragmagraph-0.0.1/RELEASING.md +103 -0
  7. pragmagraph-0.0.1/examples/mvp_workflow.py +23 -0
  8. pragmagraph-0.0.1/examples/package_smoke.py +23 -0
  9. pragmagraph-0.0.1/fixtures/tiny_repo/README.md +5 -0
  10. pragmagraph-0.0.1/fixtures/tiny_repo/src/app.py +10 -0
  11. pragmagraph-0.0.1/handoff/capabilities.json +19 -0
  12. pragmagraph-0.0.1/handoff/expected_query_runtimegraph.json +10 -0
  13. pragmagraph-0.0.1/handoff/typed_errors.json +17 -0
  14. pragmagraph-0.0.1/pyproject.toml +49 -0
  15. pragmagraph-0.0.1/scripts/release_check.py +120 -0
  16. pragmagraph-0.0.1/setup.cfg +4 -0
  17. pragmagraph-0.0.1/src/pragmagraph/__init__.py +57 -0
  18. pragmagraph-0.0.1/src/pragmagraph/__main__.py +123 -0
  19. pragmagraph-0.0.1/src/pragmagraph/adapters/__init__.py +378 -0
  20. pragmagraph-0.0.1/src/pragmagraph/contracts/__init__.py +83 -0
  21. pragmagraph-0.0.1/src/pragmagraph/models/__init__.py +365 -0
  22. pragmagraph-0.0.1/src/pragmagraph/portability/__init__.py +41 -0
  23. pragmagraph-0.0.1/src/pragmagraph/query/__init__.py +235 -0
  24. pragmagraph-0.0.1/src/pragmagraph/storage/__init__.py +92 -0
  25. pragmagraph-0.0.1/src/pragmagraph.egg-info/SOURCES.txt +27 -0
  26. pragmagraph-0.0.1/tests/test_imports.py +83 -0
  27. pragmagraph-0.0.1/tests/test_package_metadata.py +44 -0
  28. pragmagraph-0.0.1/tests/test_release_check.py +15 -0
  29. pragmagraph-0.0.1/tests/test_semantic_mvp.py +203 -0
  30. pragmagraph-0.0.1/tests/test_standalone_smoke.py +48 -0
@@ -0,0 +1,93 @@
1
+ # pragmagraph API Compatibility Policy
2
+
3
+ Owner: `pragmagraph`
4
+ Status: `alpha`
5
+ Scope: stable import-root and versioning policy for external `pragmagraph`
6
+ consumers during the semantic-alpha phase
7
+
8
+ ## Purpose
9
+
10
+ Define what external consumers can rely on while `pragmagraph` is a small
11
+ semantic alpha.
12
+
13
+ ## Stable import roots
14
+
15
+ External consumers should treat these import roots as the supported public API:
16
+
17
+ - `pragmagraph`
18
+ - `pragmagraph.contracts`
19
+ - `pragmagraph.models`
20
+ - `pragmagraph.query`
21
+ - `pragmagraph.storage`
22
+ - `pragmagraph.adapters`
23
+ - `pragmagraph.portability`
24
+
25
+ The top-level `pragmagraph` package is the preferred entrypoint for package
26
+ metadata and smoke validation.
27
+
28
+ ## Stable top-level exports
29
+
30
+ The following top-level exports are part of the current public contract:
31
+
32
+ - `pragmagraph.__version__`
33
+ - `pragmagraph.PACKAGE_STATUS`
34
+ - `pragmagraph.STABLE_IMPORT_ROOTS`
35
+ - semantic DTOs such as `GraphNode`, `GraphEdge`, `GraphSnapshot`,
36
+ `SourceRef`, `QueryRequest`, and `QueryResult`
37
+ - snapshot helpers `load_snapshot`, `save_snapshot`, and `stable_dumps`
38
+ - local indexer helper `index_path`
39
+
40
+ Query helpers live under `pragmagraph.query`; they are intentionally not
41
+ re-exported as top-level names so the `pragmagraph.query` import root remains a
42
+ module.
43
+
44
+ ## Snapshot contract
45
+
46
+ `SCHEMA_VERSION = "pragmagraph.snapshot.v1alpha1"` is the current JSON snapshot
47
+ schema. The schema is alpha but deterministic: snapshots are JSON objects with
48
+ stable `nodes`, `edges`, `omitted`, and `stats` fields. Future schema changes
49
+ must either preserve load compatibility or fail with typed package errors.
50
+
51
+ ## Versioning posture
52
+
53
+ `pragmagraph` is currently `0.x` software.
54
+
55
+ That means:
56
+
57
+ 1. additive API changes are preferred,
58
+ 2. breaking changes are still possible,
59
+ 3. breaking changes must be called out in release notes and package docs,
60
+ 4. stable import roots should not be moved casually even during `0.x`.
61
+
62
+ ## Deprecation policy
63
+
64
+ When a public symbol or import path needs to change:
65
+
66
+ 1. prefer an additive replacement first,
67
+ 2. document the new path in `README.md`,
68
+ 3. keep the old path available for at least one `0.x` release when practical,
69
+ 4. remove only after the deprecation is documented in release notes.
70
+
71
+ If a safety or correctness issue requires immediate removal, the release notes
72
+ must say so explicitly.
73
+
74
+ ## Compatibility tests
75
+
76
+ Public-contract confidence should be enforced by tests that cover:
77
+
78
+ 1. import-root availability,
79
+ 2. public top-level export availability,
80
+ 3. version agreement between `pyproject.toml` and `pragmagraph.__version__`,
81
+ 4. package independence from OpenMinion imports,
82
+ 5. semantic smoke behavior,
83
+ 6. release/install smoke for built artifacts.
84
+
85
+ ## Non-goals
86
+
87
+ This policy does not promise:
88
+
89
+ 1. host-framework orchestration semantics,
90
+ 2. graph-database storage behavior,
91
+ 3. Graphify artifact mapping,
92
+ 6. semantic inference of facts, labels, relations, or summaries from prose,
93
+ 7. compatibility for undocumented import paths.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,10 @@
1
+ include LICENSE
2
+ recursive-include scripts *.py
3
+ recursive-include examples *.py
4
+ recursive-include fixtures *.md *.py
5
+ recursive-include handoff *.json
6
+ include API_COMPATIBILITY.md
7
+ include README.md
8
+ include RELEASING.md
9
+ recursive-exclude * __pycache__ *.py[cod]
10
+ prune src/*.egg-info
@@ -0,0 +1,204 @@
1
+ Metadata-Version: 2.4
2
+ Name: pragmagraph
3
+ Version: 0.0.1
4
+ Summary: Standalone observed-fact graph substrate for code and document structure
5
+ Author: PragmaGraph Contributors
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Repository, https://github.com/openminion/pragmagraph
8
+ Project-URL: Download, https://pypi.org/project/pragmagraph/
9
+ Keywords: agent,knowledge-graph,code-intelligence,documents,observed-facts
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3 :: Only
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Topic :: Database
17
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
18
+ Requires-Python: >=3.11
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Provides-Extra: dev
22
+ Requires-Dist: build<2,>=1; extra == "dev"
23
+ Requires-Dist: pytest<9,>=8; extra == "dev"
24
+ Requires-Dist: ruff<1,>=0.11; extra == "dev"
25
+ Requires-Dist: twine<7,>=5; extra == "dev"
26
+ Dynamic: license-file
27
+
28
+ # PragmaGraph
29
+
30
+ **Standalone observed-fact graph substrate for code and document structure.**
31
+
32
+ `pragmagraph` is the future native third-brain package for OpenMinion-style
33
+ code and document graphs. The name comes from Greek `pragma`, meaning a deed,
34
+ matter, or thing done. In this package, the name frames the third brain as the
35
+ place for observed structure: files, symbols, documents, artifacts, references,
36
+ commits, and other reproducible facts.
37
+
38
+ This `0.0.1` semantic alpha provides a small local source-graph MVP:
39
+ deterministic DTOs, JSON snapshots, a local code/document indexer, lexical and
40
+ structural query helpers, CLI commands, and fixture handoff artifacts for
41
+ future OpenMinion adapter work.
42
+
43
+ ## Boundary
44
+
45
+ - **Sophiagraph** owns inferred, judged, lossy durable memory.
46
+ - **PragmaGraph** owns observed, indexer-extracted, reproducible facts and
47
+ deeds.
48
+ - **Graphify** remains the first third-brain adapter. PragmaGraph is the future
49
+ native package, not a relabeling of Graphify.
50
+
51
+ The boundary discussion lives in the host repository at
52
+ `docs/discussions/sophiagraph-pragmagraph-boundary-2026-05-27.md`.
53
+ The shortest future-agent reference is
54
+ `docs/reference/second-vs-third-brain-quick-reference.md`.
55
+
56
+ Practical rule: if a parser, static analyzer, doc walker, git reader, or shell
57
+ command can reproduce the fact without an LLM, it belongs in PragmaGraph. If it
58
+ depends on a preference, operator pin, summary, design judgment, or memory
59
+ consolidation decision, it belongs in Sophiagraph. Sophiagraph may cite
60
+ PragmaGraph with `pragma://...` evidence references; PragmaGraph never stores
61
+ Sophiagraph's judgments.
62
+
63
+ ## Trust and Brand Safety
64
+
65
+ `pragmagraph` has no official token, coin, NFT, airdrop, staking program,
66
+ treasury product, or investment offering. Any claim otherwise is unauthorized
67
+ and should be treated as a scam.
68
+
69
+ ## License and brand-use boundary
70
+
71
+ - Source code license: `Apache-2.0`
72
+ - Brand/trademark grant: `none`
73
+
74
+ The software license grants rights to use, modify, and redistribute the code.
75
+ It does **not** grant rights to use the PragmaGraph, Sophiagraph, or OpenMinion
76
+ names, logos, branding, website identity, or social identity except for
77
+ truthful attribution. Forks, clones, and derivative distributions must not
78
+ present themselves as the official PragmaGraph project or imply affiliation,
79
+ endorsement, or maintenance by PragmaGraph or OpenMinion contributors unless
80
+ that is actually true.
81
+
82
+ ## What the package provides
83
+
84
+ The package currently provides:
85
+
86
+ - package metadata and Apache-2.0 release files
87
+ - stable alpha import roots:
88
+ - `pragmagraph`
89
+ - `pragmagraph.contracts`
90
+ - `pragmagraph.models`
91
+ - `pragmagraph.query`
92
+ - `pragmagraph.storage`
93
+ - `pragmagraph.adapters`
94
+ - `pragmagraph.portability`
95
+ - immutable DTOs for source refs, graph nodes, graph edges, snapshots, query
96
+ hits, omitted diagnostics, path results, and health summaries
97
+ - deterministic JSON snapshot load/save helpers
98
+ - a local indexer for directories, files, Markdown headings, Python AST
99
+ definitions/imports, and lexical snippets
100
+ - query, neighborhood, path, and health helpers over loaded snapshots
101
+ - CLI commands for `index`, `query`, `neighborhood`, `path`, and `health`
102
+ - a semantic smoke entrypoint for install validation
103
+ - package-local tests, lint, and release-check workflow
104
+ - API compatibility and release docs
105
+
106
+ ## What the package does not provide yet
107
+
108
+ This package does **not** currently provide:
109
+
110
+ - SQLite, KuzuDB, Neo4j, hosted, vector, or typed-edge storage
111
+ - Graphify runtime API wrapping or Graphify replacement behavior
112
+ - file watchers, git hooks, daemons, or scheduled refresh
113
+ - OpenMinion runtime provider wiring
114
+ - prompt context merging
115
+ - semantic inference from prose or model output
116
+ - automatic Sophiagraph memory writes or promotion
117
+
118
+ Those features belong to follow-on releases or to OpenMinion's provider
119
+ adapter layer.
120
+
121
+ ## Install
122
+
123
+ Editable install during local development:
124
+
125
+ ```bash
126
+ python3.11 -m pip install -e .
127
+ ```
128
+
129
+ Install with development tools:
130
+
131
+ ```bash
132
+ python3.11 -m pip install -e ".[dev]"
133
+ ```
134
+
135
+ Wheel build:
136
+
137
+ ```bash
138
+ python3.11 -m build
139
+ ```
140
+
141
+ ## Standalone Smoke
142
+
143
+ Source-root smoke:
144
+
145
+ ```bash
146
+ PYTHONPATH=src python3.11 -m pragmagraph --json
147
+ ```
148
+
149
+ Installed-console-script smoke:
150
+
151
+ ```bash
152
+ pragmagraph-smoke --json
153
+ ```
154
+
155
+ Expected output is deterministic JSON with the package name, version, status,
156
+ stable import roots, and `semantic_contract: true`.
157
+
158
+ ## CLI Quickstart
159
+
160
+ Index a local code/docs root into a deterministic JSON snapshot:
161
+
162
+ ```bash
163
+ pragmagraph index . --out .pragmagraph/snapshot.json --namespace my-project --json
164
+ ```
165
+
166
+ Query the snapshot:
167
+
168
+ ```bash
169
+ pragmagraph query .pragmagraph/snapshot.json "RuntimeGraph" --json
170
+ ```
171
+
172
+ Inspect nearby graph facts:
173
+
174
+ ```bash
175
+ pragmagraph neighborhood .pragmagraph/snapshot.json \
176
+ "pragma://my-project/file/src/app.py" --json
177
+ ```
178
+
179
+ Check health:
180
+
181
+ ```bash
182
+ pragmagraph health .pragmagraph/snapshot.json --json
183
+ ```
184
+
185
+ ## External Consumer Quickstart
186
+
187
+ Minimal standalone flow for another framework or service:
188
+
189
+ ```python
190
+ import pragmagraph
191
+
192
+ snapshot = pragmagraph.index_path(".", namespace="example")
193
+ pragmagraph.save_snapshot(snapshot, ".pragmagraph/snapshot.json")
194
+ print(pragmagraph.PACKAGE_STATUS)
195
+ ```
196
+
197
+ The package can also be checked from a shell:
198
+
199
+ ```bash
200
+ python3.11 -m pragmagraph --json
201
+ ```
202
+
203
+ See [API_COMPATIBILITY.md](API_COMPATIBILITY.md) for the public import-root
204
+ policy and [RELEASING.md](RELEASING.md) for package-local release checks.
@@ -0,0 +1,177 @@
1
+ # PragmaGraph
2
+
3
+ **Standalone observed-fact graph substrate for code and document structure.**
4
+
5
+ `pragmagraph` is the future native third-brain package for OpenMinion-style
6
+ code and document graphs. The name comes from Greek `pragma`, meaning a deed,
7
+ matter, or thing done. In this package, the name frames the third brain as the
8
+ place for observed structure: files, symbols, documents, artifacts, references,
9
+ commits, and other reproducible facts.
10
+
11
+ This `0.0.1` semantic alpha provides a small local source-graph MVP:
12
+ deterministic DTOs, JSON snapshots, a local code/document indexer, lexical and
13
+ structural query helpers, CLI commands, and fixture handoff artifacts for
14
+ future OpenMinion adapter work.
15
+
16
+ ## Boundary
17
+
18
+ - **Sophiagraph** owns inferred, judged, lossy durable memory.
19
+ - **PragmaGraph** owns observed, indexer-extracted, reproducible facts and
20
+ deeds.
21
+ - **Graphify** remains the first third-brain adapter. PragmaGraph is the future
22
+ native package, not a relabeling of Graphify.
23
+
24
+ The boundary discussion lives in the host repository at
25
+ `docs/discussions/sophiagraph-pragmagraph-boundary-2026-05-27.md`.
26
+ The shortest future-agent reference is
27
+ `docs/reference/second-vs-third-brain-quick-reference.md`.
28
+
29
+ Practical rule: if a parser, static analyzer, doc walker, git reader, or shell
30
+ command can reproduce the fact without an LLM, it belongs in PragmaGraph. If it
31
+ depends on a preference, operator pin, summary, design judgment, or memory
32
+ consolidation decision, it belongs in Sophiagraph. Sophiagraph may cite
33
+ PragmaGraph with `pragma://...` evidence references; PragmaGraph never stores
34
+ Sophiagraph's judgments.
35
+
36
+ ## Trust and Brand Safety
37
+
38
+ `pragmagraph` has no official token, coin, NFT, airdrop, staking program,
39
+ treasury product, or investment offering. Any claim otherwise is unauthorized
40
+ and should be treated as a scam.
41
+
42
+ ## License and brand-use boundary
43
+
44
+ - Source code license: `Apache-2.0`
45
+ - Brand/trademark grant: `none`
46
+
47
+ The software license grants rights to use, modify, and redistribute the code.
48
+ It does **not** grant rights to use the PragmaGraph, Sophiagraph, or OpenMinion
49
+ names, logos, branding, website identity, or social identity except for
50
+ truthful attribution. Forks, clones, and derivative distributions must not
51
+ present themselves as the official PragmaGraph project or imply affiliation,
52
+ endorsement, or maintenance by PragmaGraph or OpenMinion contributors unless
53
+ that is actually true.
54
+
55
+ ## What the package provides
56
+
57
+ The package currently provides:
58
+
59
+ - package metadata and Apache-2.0 release files
60
+ - stable alpha import roots:
61
+ - `pragmagraph`
62
+ - `pragmagraph.contracts`
63
+ - `pragmagraph.models`
64
+ - `pragmagraph.query`
65
+ - `pragmagraph.storage`
66
+ - `pragmagraph.adapters`
67
+ - `pragmagraph.portability`
68
+ - immutable DTOs for source refs, graph nodes, graph edges, snapshots, query
69
+ hits, omitted diagnostics, path results, and health summaries
70
+ - deterministic JSON snapshot load/save helpers
71
+ - a local indexer for directories, files, Markdown headings, Python AST
72
+ definitions/imports, and lexical snippets
73
+ - query, neighborhood, path, and health helpers over loaded snapshots
74
+ - CLI commands for `index`, `query`, `neighborhood`, `path`, and `health`
75
+ - a semantic smoke entrypoint for install validation
76
+ - package-local tests, lint, and release-check workflow
77
+ - API compatibility and release docs
78
+
79
+ ## What the package does not provide yet
80
+
81
+ This package does **not** currently provide:
82
+
83
+ - SQLite, KuzuDB, Neo4j, hosted, vector, or typed-edge storage
84
+ - Graphify runtime API wrapping or Graphify replacement behavior
85
+ - file watchers, git hooks, daemons, or scheduled refresh
86
+ - OpenMinion runtime provider wiring
87
+ - prompt context merging
88
+ - semantic inference from prose or model output
89
+ - automatic Sophiagraph memory writes or promotion
90
+
91
+ Those features belong to follow-on releases or to OpenMinion's provider
92
+ adapter layer.
93
+
94
+ ## Install
95
+
96
+ Editable install during local development:
97
+
98
+ ```bash
99
+ python3.11 -m pip install -e .
100
+ ```
101
+
102
+ Install with development tools:
103
+
104
+ ```bash
105
+ python3.11 -m pip install -e ".[dev]"
106
+ ```
107
+
108
+ Wheel build:
109
+
110
+ ```bash
111
+ python3.11 -m build
112
+ ```
113
+
114
+ ## Standalone Smoke
115
+
116
+ Source-root smoke:
117
+
118
+ ```bash
119
+ PYTHONPATH=src python3.11 -m pragmagraph --json
120
+ ```
121
+
122
+ Installed-console-script smoke:
123
+
124
+ ```bash
125
+ pragmagraph-smoke --json
126
+ ```
127
+
128
+ Expected output is deterministic JSON with the package name, version, status,
129
+ stable import roots, and `semantic_contract: true`.
130
+
131
+ ## CLI Quickstart
132
+
133
+ Index a local code/docs root into a deterministic JSON snapshot:
134
+
135
+ ```bash
136
+ pragmagraph index . --out .pragmagraph/snapshot.json --namespace my-project --json
137
+ ```
138
+
139
+ Query the snapshot:
140
+
141
+ ```bash
142
+ pragmagraph query .pragmagraph/snapshot.json "RuntimeGraph" --json
143
+ ```
144
+
145
+ Inspect nearby graph facts:
146
+
147
+ ```bash
148
+ pragmagraph neighborhood .pragmagraph/snapshot.json \
149
+ "pragma://my-project/file/src/app.py" --json
150
+ ```
151
+
152
+ Check health:
153
+
154
+ ```bash
155
+ pragmagraph health .pragmagraph/snapshot.json --json
156
+ ```
157
+
158
+ ## External Consumer Quickstart
159
+
160
+ Minimal standalone flow for another framework or service:
161
+
162
+ ```python
163
+ import pragmagraph
164
+
165
+ snapshot = pragmagraph.index_path(".", namespace="example")
166
+ pragmagraph.save_snapshot(snapshot, ".pragmagraph/snapshot.json")
167
+ print(pragmagraph.PACKAGE_STATUS)
168
+ ```
169
+
170
+ The package can also be checked from a shell:
171
+
172
+ ```bash
173
+ python3.11 -m pragmagraph --json
174
+ ```
175
+
176
+ See [API_COMPATIBILITY.md](API_COMPATIBILITY.md) for the public import-root
177
+ policy and [RELEASING.md](RELEASING.md) for package-local release checks.