sophiagraph 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.
- sophiagraph-0.0.1/API_COMPATIBILITY.md +119 -0
- sophiagraph-0.0.1/LICENSE +201 -0
- sophiagraph-0.0.1/MANIFEST.in +8 -0
- sophiagraph-0.0.1/PKG-INFO +340 -0
- sophiagraph-0.0.1/README.md +315 -0
- sophiagraph-0.0.1/RELEASING.md +86 -0
- sophiagraph-0.0.1/examples/basic_usage.py +89 -0
- sophiagraph-0.0.1/examples/obsidian_substrate.py +77 -0
- sophiagraph-0.0.1/pyproject.toml +45 -0
- sophiagraph-0.0.1/scripts/release_check.py +79 -0
- sophiagraph-0.0.1/setup.cfg +4 -0
- sophiagraph-0.0.1/src/sophiagraph/__init__.py +88 -0
- sophiagraph-0.0.1/src/sophiagraph/__main__.py +54 -0
- sophiagraph-0.0.1/src/sophiagraph/adapters/__init__.py +17 -0
- sophiagraph-0.0.1/src/sophiagraph/adapters/markdown.py +262 -0
- sophiagraph-0.0.1/src/sophiagraph/audit/__init__.py +3 -0
- sophiagraph-0.0.1/src/sophiagraph/audit/events.py +84 -0
- sophiagraph-0.0.1/src/sophiagraph/canvas.py +146 -0
- sophiagraph-0.0.1/src/sophiagraph/contracts/__init__.py +1 -0
- sophiagraph-0.0.1/src/sophiagraph/contracts/errors.py +47 -0
- sophiagraph-0.0.1/src/sophiagraph/contracts/provenance.py +110 -0
- sophiagraph-0.0.1/src/sophiagraph/contracts/types.py +91 -0
- sophiagraph-0.0.1/src/sophiagraph/extensions.py +58 -0
- sophiagraph-0.0.1/src/sophiagraph/models/__init__.py +117 -0
- sophiagraph-0.0.1/src/sophiagraph/models/candidate.py +155 -0
- sophiagraph-0.0.1/src/sophiagraph/models/constants.py +3 -0
- sophiagraph-0.0.1/src/sophiagraph/models/core.py +101 -0
- sophiagraph-0.0.1/src/sophiagraph/models/document.py +130 -0
- sophiagraph-0.0.1/src/sophiagraph/models/link.py +230 -0
- sophiagraph-0.0.1/src/sophiagraph/models/namespace.py +189 -0
- sophiagraph-0.0.1/src/sophiagraph/models/primitives.py +202 -0
- sophiagraph-0.0.1/src/sophiagraph/models/record.py +206 -0
- sophiagraph-0.0.1/src/sophiagraph/models/relation.py +43 -0
- sophiagraph-0.0.1/src/sophiagraph/models/tier.py +56 -0
- sophiagraph-0.0.1/src/sophiagraph/portability/__init__.py +4 -0
- sophiagraph-0.0.1/src/sophiagraph/portability/codec.py +406 -0
- sophiagraph-0.0.1/src/sophiagraph/portability/models.py +67 -0
- sophiagraph-0.0.1/src/sophiagraph/query/__init__.py +37 -0
- sophiagraph-0.0.1/src/sophiagraph/query/graph.py +124 -0
- sophiagraph-0.0.1/src/sophiagraph/query/options.py +62 -0
- sophiagraph-0.0.1/src/sophiagraph/query/structural.py +126 -0
- sophiagraph-0.0.1/src/sophiagraph/storage/__init__.py +21 -0
- sophiagraph-0.0.1/src/sophiagraph/storage/base.py +161 -0
- sophiagraph-0.0.1/src/sophiagraph/storage/constants.py +3 -0
- sophiagraph-0.0.1/src/sophiagraph/storage/factory.py +23 -0
- sophiagraph-0.0.1/src/sophiagraph/storage/graph_helpers.py +141 -0
- sophiagraph-0.0.1/src/sophiagraph/storage/helpers.py +49 -0
- sophiagraph-0.0.1/src/sophiagraph/storage/memory.py +709 -0
- sophiagraph-0.0.1/src/sophiagraph/storage/sqlite.py +1153 -0
- sophiagraph-0.0.1/src/sophiagraph/temporal/__init__.py +20 -0
- sophiagraph-0.0.1/src/sophiagraph/trust/__init__.py +3 -0
- sophiagraph-0.0.1/src/sophiagraph/trust/types.py +52 -0
- sophiagraph-0.0.1/src/sophiagraph/views.py +107 -0
- sophiagraph-0.0.1/src/sophiagraph.egg-info/SOURCES.txt +62 -0
- sophiagraph-0.0.1/tests/test_codec_hydration.py +50 -0
- sophiagraph-0.0.1/tests/test_imports.py +41 -0
- sophiagraph-0.0.1/tests/test_memory_store.py +151 -0
- sophiagraph-0.0.1/tests/test_namespace_models.py +131 -0
- sophiagraph-0.0.1/tests/test_obsidian_links_and_graph.py +145 -0
- sophiagraph-0.0.1/tests/test_obsidian_models_and_markdown.py +141 -0
- sophiagraph-0.0.1/tests/test_obsidian_search_views_canvas_extensions.py +123 -0
- sophiagraph-0.0.1/tests/test_package_metadata.py +29 -0
- sophiagraph-0.0.1/tests/test_quickstart_example.py +21 -0
- sophiagraph-0.0.1/tests/test_sqlite_store.py +432 -0
- sophiagraph-0.0.1/tests/test_standalone_smoke.py +25 -0
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# sophiagraph API Compatibility Policy
|
|
2
|
+
|
|
3
|
+
Owner: `sophiagraph`
|
|
4
|
+
Status: `active`
|
|
5
|
+
Scope: stable import-root and versioning policy for external `sophiagraph` consumers
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
|
|
9
|
+
Define what external consumers can rely on when they build against the
|
|
10
|
+
standalone `sophiagraph` package.
|
|
11
|
+
|
|
12
|
+
## Stable import roots
|
|
13
|
+
|
|
14
|
+
External consumers should treat these import roots as the supported public API:
|
|
15
|
+
|
|
16
|
+
- `sophiagraph`
|
|
17
|
+
- `sophiagraph.models`
|
|
18
|
+
- `sophiagraph.query`
|
|
19
|
+
- `sophiagraph.storage`
|
|
20
|
+
- `sophiagraph.portability`
|
|
21
|
+
- `sophiagraph.adapters`
|
|
22
|
+
- `sophiagraph.canvas`
|
|
23
|
+
- `sophiagraph.extensions`
|
|
24
|
+
- `sophiagraph.views`
|
|
25
|
+
- `sophiagraph.audit`
|
|
26
|
+
- `sophiagraph.trust`
|
|
27
|
+
- `sophiagraph.temporal`
|
|
28
|
+
- `sophiagraph.contracts`
|
|
29
|
+
|
|
30
|
+
The top-level `sophiagraph` package is the preferred entrypoint for common usage.
|
|
31
|
+
|
|
32
|
+
## Stable top-level exports
|
|
33
|
+
|
|
34
|
+
The following top-level exports are part of the current public contract:
|
|
35
|
+
|
|
36
|
+
- `sophiagraph.__version__`
|
|
37
|
+
- `sophiagraph.DEFAULT_DB_FILENAME`
|
|
38
|
+
- `sophiagraph.SophiaGraphSqliteStore`
|
|
39
|
+
- `sophiagraph.SophiaGraphMemoryStore`
|
|
40
|
+
- `sophiagraph.MemoryNamespace`
|
|
41
|
+
- `sophiagraph.MemoryNamespaceComponent`
|
|
42
|
+
- `sophiagraph.MemoryRecord`
|
|
43
|
+
- `sophiagraph.MemoryCandidate`
|
|
44
|
+
- `sophiagraph.MemoryRelation`
|
|
45
|
+
- `sophiagraph.KnowledgeDocument`
|
|
46
|
+
- `sophiagraph.KnowledgeDocumentBlock`
|
|
47
|
+
- `sophiagraph.StructuralLink`
|
|
48
|
+
- `sophiagraph.ExplicitLinkResolver`
|
|
49
|
+
- `sophiagraph.LinkResolution`
|
|
50
|
+
- `sophiagraph.LinkResolutionCandidate`
|
|
51
|
+
- `sophiagraph.ListQueryOptions`
|
|
52
|
+
- `sophiagraph.SearchQueryOptions`
|
|
53
|
+
- `sophiagraph.LinkQueryOptions`
|
|
54
|
+
- `sophiagraph.LocalGraphOptions`
|
|
55
|
+
- `sophiagraph.GraphSnapshotOptions`
|
|
56
|
+
- `sophiagraph.GraphSnapshot`
|
|
57
|
+
- `sophiagraph.StructuralSearchQuery`
|
|
58
|
+
- `sophiagraph.create_sqlite_store(...)`
|
|
59
|
+
- `sophiagraph.create_memory_store()`
|
|
60
|
+
- `sophiagraph.default_db_path(...)`
|
|
61
|
+
- `sophiagraph.audit`
|
|
62
|
+
- `sophiagraph.contracts`
|
|
63
|
+
- `sophiagraph.portability`
|
|
64
|
+
- `sophiagraph.trust`
|
|
65
|
+
- `sophiagraph.coerce_temporal_dt`
|
|
66
|
+
|
|
67
|
+
## Versioning posture
|
|
68
|
+
|
|
69
|
+
`sophiagraph` is currently `0.x` software.
|
|
70
|
+
|
|
71
|
+
That means:
|
|
72
|
+
|
|
73
|
+
1. additive API changes are preferred,
|
|
74
|
+
2. breaking changes are still possible,
|
|
75
|
+
3. breaking changes must be called out in release notes and package docs,
|
|
76
|
+
4. stable import roots should not be moved casually even during `0.x`.
|
|
77
|
+
|
|
78
|
+
## Deprecation policy
|
|
79
|
+
|
|
80
|
+
When a public symbol or import path needs to change:
|
|
81
|
+
|
|
82
|
+
1. prefer an additive replacement first,
|
|
83
|
+
2. document the new path in `README.md`,
|
|
84
|
+
3. keep the old path available for at least one `0.x` release when practical,
|
|
85
|
+
4. remove only after the deprecation is documented in release notes.
|
|
86
|
+
|
|
87
|
+
If a safety or correctness issue requires immediate removal, the release notes
|
|
88
|
+
must say so explicitly.
|
|
89
|
+
|
|
90
|
+
## Compatibility tests
|
|
91
|
+
|
|
92
|
+
Public-contract confidence should be enforced by tests that cover:
|
|
93
|
+
|
|
94
|
+
1. import-root availability,
|
|
95
|
+
2. public top-level export availability,
|
|
96
|
+
3. store-behavior regressions for package-owned backends,
|
|
97
|
+
4. portability round-trip expectations,
|
|
98
|
+
5. namespace-safe query/export/import boundaries,
|
|
99
|
+
6. explicit link/backlink/local-graph behavior across memory and SQLite stores,
|
|
100
|
+
7. Markdown/frontmatter structural import behavior with no prose rewrites,
|
|
101
|
+
8. release/install smoke for built artifacts.
|
|
102
|
+
|
|
103
|
+
## Internal compatibility shims
|
|
104
|
+
|
|
105
|
+
Underscore-prefixed model cast helpers and codec hydrator aliases may remain
|
|
106
|
+
available during `0.x` for OpenMinion compatibility, but they are not part of
|
|
107
|
+
`__all__` and should not be used by new external consumers. New code should use
|
|
108
|
+
public model imports and public codec helpers such as `record_from_dict`.
|
|
109
|
+
|
|
110
|
+
## Non-goals
|
|
111
|
+
|
|
112
|
+
This policy does not promise:
|
|
113
|
+
|
|
114
|
+
1. host-framework orchestration semantics,
|
|
115
|
+
2. an Obsidian editor, renderer, sync service, or plugin runtime,
|
|
116
|
+
3. semantic inference of tags, links, relation types, or summaries from prose,
|
|
117
|
+
4. compatibility for private helper modules,
|
|
118
|
+
5. long-term support for undocumented import paths,
|
|
119
|
+
6. compatibility with every possible third-party graph backend.
|
|
@@ -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,340 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: sophiagraph
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Standalone wisdom graph substrate for durable agent memory
|
|
5
|
+
Author: Sophiagraph Contributors
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Keywords: agent,wisdom,knowledge-graph,memory,sqlite,durable-memory
|
|
8
|
+
Classifier: Development Status :: 3 - Alpha
|
|
9
|
+
Classifier: Intended Audience :: Developers
|
|
10
|
+
Classifier: Operating System :: OS Independent
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
14
|
+
Classifier: Topic :: Database
|
|
15
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
16
|
+
Requires-Python: >=3.11
|
|
17
|
+
Description-Content-Type: text/markdown
|
|
18
|
+
License-File: LICENSE
|
|
19
|
+
Provides-Extra: dev
|
|
20
|
+
Requires-Dist: build<2,>=1; extra == "dev"
|
|
21
|
+
Requires-Dist: pytest<9,>=8; extra == "dev"
|
|
22
|
+
Requires-Dist: ruff<1,>=0.11; extra == "dev"
|
|
23
|
+
Requires-Dist: twine<7,>=5; extra == "dev"
|
|
24
|
+
Dynamic: license-file
|
|
25
|
+
|
|
26
|
+
# sophiagraph
|
|
27
|
+
|
|
28
|
+
Status: `publish-ready alpha`
|
|
29
|
+
Shape: standalone Python package
|
|
30
|
+
License: `Apache-2.0`
|
|
31
|
+
|
|
32
|
+
`sophiagraph` is a standalone wisdom graph substrate for durable agent memory.
|
|
33
|
+
The name comes from Greek `Sophia` (`Σοφία`), meaning wisdom; in this package it
|
|
34
|
+
frames durable knowledge as a graph of records, relations, provenance, trust,
|
|
35
|
+
and portable snapshots.
|
|
36
|
+
|
|
37
|
+
## What the package provides
|
|
38
|
+
|
|
39
|
+
`sophiagraph` currently provides:
|
|
40
|
+
|
|
41
|
+
- canonical durable-memory models
|
|
42
|
+
- contract and provenance helpers
|
|
43
|
+
- query DTOs
|
|
44
|
+
- portability bundle models and codec helpers
|
|
45
|
+
- audit-event schemas
|
|
46
|
+
- trust and temporal primitives
|
|
47
|
+
- typed namespace DTOs for explicit tenant/user/agent/session isolation
|
|
48
|
+
- directed relation APIs with explicit incoming/outgoing/bidirectional lookup
|
|
49
|
+
- Obsidian-style structural document/link DTOs, Markdown/frontmatter adapter,
|
|
50
|
+
backlinks, outgoing links, local graph traversal, graph snapshots, structural
|
|
51
|
+
search DTOs, saved view DTOs, JSON Canvas DTOs, and extension hooks
|
|
52
|
+
- a package-local SQLite durable engine
|
|
53
|
+
- a package-local in-memory backend for tests and ephemeral consumers
|
|
54
|
+
- a standalone smoke entrypoint for publish/install validation
|
|
55
|
+
|
|
56
|
+
## What the package does not provide
|
|
57
|
+
|
|
58
|
+
This package does **not** provide:
|
|
59
|
+
|
|
60
|
+
- application orchestration or gateway policy
|
|
61
|
+
- a full Obsidian clone, editor, sync service, or visual renderer
|
|
62
|
+
- provider/model routing
|
|
63
|
+
- session orchestration
|
|
64
|
+
- automatic link, tag, relation, entity, or summary inference from prose
|
|
65
|
+
- implicit imports back into any host framework
|
|
66
|
+
|
|
67
|
+
Host frameworks remain the orchestrators. `sophiagraph` owns reusable durable
|
|
68
|
+
wisdom graph primitives and the standalone durable engine.
|
|
69
|
+
|
|
70
|
+
## Install
|
|
71
|
+
|
|
72
|
+
Editable install during local development:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
python3.11 -m pip install -e .
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Wheel build:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
python3.11 -m build
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Fresh-wheel smoke:
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
TMP_VENV="$(mktemp -d)/sophiagraph-venv"
|
|
88
|
+
python3.11 -m venv "$TMP_VENV"
|
|
89
|
+
"$TMP_VENV/bin/pip" install dist/sophiagraph-*.whl
|
|
90
|
+
"$TMP_VENV/bin/sophiagraph-smoke" --root /tmp/sophiagraph-release-smoke --seed --json
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Standalone Smoke
|
|
94
|
+
|
|
95
|
+
Source-root smoke:
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
PYTHONPATH=src python3.11 -m sophiagraph --root /tmp/sophiagraph-smoke --seed --json
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Installed-console-script smoke:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
sophiagraph-smoke --root /tmp/sophiagraph-smoke --seed --json
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## External Consumer Quickstart
|
|
108
|
+
|
|
109
|
+
Minimal standalone flow for another framework or service:
|
|
110
|
+
|
|
111
|
+
```python
|
|
112
|
+
from sophiagraph.models import MemoryNamespace, MemoryRecord
|
|
113
|
+
from sophiagraph.portability.models import MemoryBundleExportOptions, MemoryBundleImportOptions
|
|
114
|
+
from sophiagraph.query import ListQueryOptions, SearchQueryOptions
|
|
115
|
+
from sophiagraph.storage import create_memory_store, create_sqlite_store
|
|
116
|
+
|
|
117
|
+
store = create_sqlite_store("/tmp/sophiagraph-demo")
|
|
118
|
+
namespace = MemoryNamespace(
|
|
119
|
+
tenant_id="tenant-demo",
|
|
120
|
+
user_id="user-demo",
|
|
121
|
+
agent_id="demo",
|
|
122
|
+
graph_id="main",
|
|
123
|
+
)
|
|
124
|
+
store.put_record(
|
|
125
|
+
MemoryRecord(
|
|
126
|
+
id="rec-1",
|
|
127
|
+
scope="agent:demo",
|
|
128
|
+
type="fact",
|
|
129
|
+
key="project:apollo",
|
|
130
|
+
title="Apollo launch date",
|
|
131
|
+
content={"text": "Apollo launched in Q2"},
|
|
132
|
+
created_at="2026-05-22T00:00:00+00:00",
|
|
133
|
+
updated_at="2026-05-22T00:00:00+00:00",
|
|
134
|
+
source="validated",
|
|
135
|
+
confidence=0.95,
|
|
136
|
+
event_time="2026-05-22T00:00:00+00:00",
|
|
137
|
+
namespace=namespace,
|
|
138
|
+
)
|
|
139
|
+
)
|
|
140
|
+
|
|
141
|
+
namespace_filter = MemoryNamespace(agent_id="demo")
|
|
142
|
+
records = store.list_records(
|
|
143
|
+
ListQueryOptions(scopes=["agent:demo"], namespaces=[namespace_filter])
|
|
144
|
+
)
|
|
145
|
+
search_hits = store.search_records(
|
|
146
|
+
SearchQueryOptions(query="Apollo", scopes=["agent:demo"], namespaces=[namespace_filter])
|
|
147
|
+
)
|
|
148
|
+
snapshot = store.export_snapshot(
|
|
149
|
+
MemoryBundleExportOptions(scopes=["agent:demo"], namespaces=[namespace_filter])
|
|
150
|
+
)
|
|
151
|
+
import_store = create_memory_store()
|
|
152
|
+
import_store.import_snapshot(snapshot, MemoryBundleImportOptions())
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Runnable example:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
PYTHONPATH=src python3.11 examples/basic_usage.py
|
|
159
|
+
PYTHONPATH=src python3.11 examples/obsidian_substrate.py
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## Typed Namespaces
|
|
163
|
+
|
|
164
|
+
Records still accept the legacy `scope` string for compatibility. New
|
|
165
|
+
integrations can also attach typed namespace DTOs to records and use the same
|
|
166
|
+
typed dimensions for query/export/import boundaries:
|
|
167
|
+
|
|
168
|
+
```python
|
|
169
|
+
from sophiagraph.models import MemoryNamespace
|
|
170
|
+
|
|
171
|
+
namespace = MemoryNamespace(
|
|
172
|
+
tenant_id="tenant-acme",
|
|
173
|
+
user_id="user-j",
|
|
174
|
+
agent_id="agent-codex",
|
|
175
|
+
session_id="session-123",
|
|
176
|
+
graph_id="main",
|
|
177
|
+
)
|
|
178
|
+
|
|
179
|
+
legacy_scope = namespace.to_scope("agent")
|
|
180
|
+
|
|
181
|
+
record = MemoryRecord(
|
|
182
|
+
id="rec-namespace",
|
|
183
|
+
scope=legacy_scope,
|
|
184
|
+
type="fact",
|
|
185
|
+
content={"text": "Namespace-safe records keep tenant and agent separate."},
|
|
186
|
+
created_at="2026-05-23T00:00:00+00:00",
|
|
187
|
+
updated_at="2026-05-23T00:00:00+00:00",
|
|
188
|
+
namespace=namespace,
|
|
189
|
+
)
|
|
190
|
+
|
|
191
|
+
records = store.list_records(
|
|
192
|
+
ListQueryOptions(scopes=[legacy_scope], namespaces=[MemoryNamespace(agent_id="agent-codex")])
|
|
193
|
+
)
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
Namespace values must be explicit caller-provided identifiers. `sophiagraph`
|
|
197
|
+
does not infer tenant, user, project, or agent identity from prose. Existing
|
|
198
|
+
SQLite rows without namespace columns are migrated from their explicit legacy
|
|
199
|
+
`scope` value only; no content or title text is inspected.
|
|
200
|
+
|
|
201
|
+
## Graph Relations
|
|
202
|
+
|
|
203
|
+
Relations are explicit, typed, directed edges between records. Consumers can
|
|
204
|
+
list outgoing, incoming, or bidirectional edges through the `direction` option:
|
|
205
|
+
|
|
206
|
+
```python
|
|
207
|
+
outgoing = store.list_relations("rec-1")
|
|
208
|
+
incoming = store.list_relations("rec-1", direction="in")
|
|
209
|
+
neighborhood = store.get_related_records(
|
|
210
|
+
"rec-1",
|
|
211
|
+
["agent:demo"],
|
|
212
|
+
direction="both",
|
|
213
|
+
)
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
The package does not infer relation types from prose. Callers must submit
|
|
217
|
+
relation records directly.
|
|
218
|
+
|
|
219
|
+
## Obsidian-Style Knowledge Graph Substrate
|
|
220
|
+
|
|
221
|
+
`sophiagraph` now has package-core surfaces for Obsidian-comparable structural
|
|
222
|
+
workflows:
|
|
223
|
+
|
|
224
|
+
- `KnowledgeDocument` wraps document-profile `MemoryRecord` nodes with path,
|
|
225
|
+
title, aliases, content hash, namespace, timestamps, and provenance.
|
|
226
|
+
- `StructuralLink` represents explicit wikilinks, Markdown links, embeds,
|
|
227
|
+
property links, external URLs, unresolved targets, headings, and block refs.
|
|
228
|
+
- `extract_markdown(...)` parses frontmatter, aliases, tags, and explicit link
|
|
229
|
+
syntax without modifying note prose.
|
|
230
|
+
- Store backends expose `put_link(...)`, `list_links(...)`,
|
|
231
|
+
`get_backlinks(...)`, `get_outgoing_links(...)`, `get_local_graph(...)`, and
|
|
232
|
+
`get_graph_snapshot(...)`.
|
|
233
|
+
- Structural search, saved views, JSON Canvas, and extension hooks are durable
|
|
234
|
+
DTO/helper surfaces. They do not require a UI renderer or OpenMinion import.
|
|
235
|
+
|
|
236
|
+
Example:
|
|
237
|
+
|
|
238
|
+
```python
|
|
239
|
+
from sophiagraph.adapters.markdown import extract_markdown
|
|
240
|
+
from sophiagraph.models import LinkResolutionCandidate, MemoryNamespace
|
|
241
|
+
from sophiagraph.query import LinkQueryOptions, LocalGraphOptions
|
|
242
|
+
|
|
243
|
+
namespace = MemoryNamespace(agent_id="demo", graph_id="main")
|
|
244
|
+
imported = extract_markdown(
|
|
245
|
+
"See [[Roadmap]].",
|
|
246
|
+
path="Index.md",
|
|
247
|
+
record_id="rec-index",
|
|
248
|
+
namespace=namespace,
|
|
249
|
+
resolver_candidates=[
|
|
250
|
+
LinkResolutionCandidate(
|
|
251
|
+
record_id="rec-roadmap",
|
|
252
|
+
path="Roadmap.md",
|
|
253
|
+
title="Roadmap",
|
|
254
|
+
namespace=namespace,
|
|
255
|
+
)
|
|
256
|
+
],
|
|
257
|
+
)
|
|
258
|
+
for link in imported.links:
|
|
259
|
+
store.put_link(link)
|
|
260
|
+
|
|
261
|
+
backlinks = store.list_links(LinkQueryOptions(record_id="rec-roadmap", direction="in"))
|
|
262
|
+
local_graph = store.get_local_graph(LocalGraphOptions(record_id="rec-index", depth=1))
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
The resolver contract is deliberately structural: explicit path first, then
|
|
266
|
+
case-insensitive title/alias matching inside the namespace. Unresolved and
|
|
267
|
+
ambiguous targets are preserved as first-class outcomes. Unlinked mentions are
|
|
268
|
+
not persisted as graph edges.
|
|
269
|
+
|
|
270
|
+
## Alpha-Scale Search and SQLite Connections
|
|
271
|
+
|
|
272
|
+
Current search is deterministic substring search over hydrated record payloads.
|
|
273
|
+
It is suitable for alpha-scale package use and tests, but it is not yet an
|
|
274
|
+
FTS5-backed or vector-backed retrieval engine. The hybrid retrieval roadmap owns
|
|
275
|
+
the future FTS/vector/rerank design.
|
|
276
|
+
|
|
277
|
+
`SophiaGraphSqliteStore` opens a short-lived SQLite connection per method call.
|
|
278
|
+
That keeps alpha behavior simple and avoids hidden shared connection state. A
|
|
279
|
+
pooled or long-lived connection strategy should be introduced only with a
|
|
280
|
+
separate lifecycle/concurrency contract.
|
|
281
|
+
|
|
282
|
+
## Cross-Package Compatibility DTOs
|
|
283
|
+
|
|
284
|
+
Some contract DTOs, including runtime snapshot/capsule/query shapes and
|
|
285
|
+
`MemoryPatchResult`, are retained for host-runtime adapters such as OpenMinion
|
|
286
|
+
and future service surfaces. They are compatibility contracts; package-local
|
|
287
|
+
stores are not required to instantiate every DTO.
|
|
288
|
+
|
|
289
|
+
## Import Boundary Rule
|
|
290
|
+
|
|
291
|
+
`sophiagraph` must never import from host frameworks such as OpenMinion.
|
|
292
|
+
|
|
293
|
+
Dependency direction is one-way:
|
|
294
|
+
|
|
295
|
+
- allowed: host framework -> `sophiagraph`
|
|
296
|
+
- forbidden: `sophiagraph` -> host framework
|
|
297
|
+
|
|
298
|
+
## Public API
|
|
299
|
+
|
|
300
|
+
Stable top-level exports for external consumers:
|
|
301
|
+
|
|
302
|
+
- `sophiagraph.SophiaGraphSqliteStore`
|
|
303
|
+
- `sophiagraph.SophiaGraphMemoryStore`
|
|
304
|
+
- `sophiagraph.create_sqlite_store(...)`
|
|
305
|
+
- `sophiagraph.create_memory_store()`
|
|
306
|
+
- `sophiagraph.default_db_path(...)`
|
|
307
|
+
- `sophiagraph.audit`
|
|
308
|
+
- `sophiagraph.contracts`
|
|
309
|
+
- `sophiagraph.portability`
|
|
310
|
+
- `sophiagraph.trust`
|
|
311
|
+
- `sophiagraph.coerce_temporal_dt`
|
|
312
|
+
|
|
313
|
+
Supported import roots:
|
|
314
|
+
|
|
315
|
+
- `sophiagraph`
|
|
316
|
+
- `sophiagraph.models`
|
|
317
|
+
- `sophiagraph.query`
|
|
318
|
+
- `sophiagraph.storage`
|
|
319
|
+
- `sophiagraph.portability`
|
|
320
|
+
- `sophiagraph.adapters`
|
|
321
|
+
- `sophiagraph.canvas`
|
|
322
|
+
- `sophiagraph.extensions`
|
|
323
|
+
- `sophiagraph.views`
|
|
324
|
+
- `sophiagraph.audit`
|
|
325
|
+
- `sophiagraph.trust`
|
|
326
|
+
- `sophiagraph.temporal`
|
|
327
|
+
- `sophiagraph.contracts`
|
|
328
|
+
|
|
329
|
+
## API Compatibility
|
|
330
|
+
|
|
331
|
+
Compatibility and deprecation policy:
|
|
332
|
+
|
|
333
|
+
- `API_COMPATIBILITY.md`
|
|
334
|
+
|
|
335
|
+
## Release Docs
|
|
336
|
+
|
|
337
|
+
Package-local release runbook:
|
|
338
|
+
|
|
339
|
+
- `RELEASING.md`
|
|
340
|
+
- `scripts/release_check.py`
|