urdyn-memory 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.
- urdyn_memory-0.1.0/LICENSE +201 -0
- urdyn_memory-0.1.0/PKG-INFO +236 -0
- urdyn_memory-0.1.0/README.md +209 -0
- urdyn_memory-0.1.0/pyproject.toml +59 -0
- urdyn_memory-0.1.0/pyproject.toml.orig +64 -0
- urdyn_memory-0.1.0/src/urdyn/__init__.py +53 -0
- urdyn_memory-0.1.0/src/urdyn/_attempt.py +41 -0
- urdyn_memory-0.1.0/src/urdyn/_cli.py +743 -0
- urdyn_memory-0.1.0/src/urdyn/_conflict.py +61 -0
- urdyn_memory-0.1.0/src/urdyn/_context.py +514 -0
- urdyn_memory-0.1.0/src/urdyn/_errors.py +44 -0
- urdyn_memory-0.1.0/src/urdyn/_event.py +46 -0
- urdyn_memory-0.1.0/src/urdyn/_evidence.py +97 -0
- urdyn_memory-0.1.0/src/urdyn/_gitignore.py +27 -0
- urdyn_memory-0.1.0/src/urdyn/_guard.py +164 -0
- urdyn_memory-0.1.0/src/urdyn/_manifest.py +72 -0
- urdyn_memory-0.1.0/src/urdyn/_memory.py +142 -0
- urdyn_memory-0.1.0/src/urdyn/_preflight.py +517 -0
- urdyn_memory-0.1.0/src/urdyn/_relevance.py +72 -0
- urdyn_memory-0.1.0/src/urdyn/_retrieval.py +128 -0
- urdyn_memory-0.1.0/src/urdyn/_semantic.py +816 -0
- urdyn_memory-0.1.0/src/urdyn/_semantic_store.py +410 -0
- urdyn_memory-0.1.0/src/urdyn/_skill.py +70 -0
- urdyn_memory-0.1.0/src/urdyn/_source.py +384 -0
- urdyn_memory-0.1.0/src/urdyn/_store.py +2104 -0
- urdyn_memory-0.1.0/src/urdyn/_terminal.py +143 -0
- urdyn_memory-0.1.0/src/urdyn/_watcher.py +1060 -0
- urdyn_memory-0.1.0/src/urdyn/_workspace.py +2206 -0
- urdyn_memory-0.1.0/src/urdyn/py.typed +0 -0
|
@@ -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 2026 Leonardo Panconi
|
|
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,236 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: urdyn-memory
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A standalone, local-first, persistent, model-independent memory engine
|
|
5
|
+
Keywords: memory,local-first,ai,agents,knowledge-management,cli
|
|
6
|
+
Author: Leonardo Panconi
|
|
7
|
+
Author-email: Leonardo Panconi <krankxxx0@proton.me>
|
|
8
|
+
License-Expression: Apache-2.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
17
|
+
Requires-Dist: onnxruntime>=1.17.0 ; extra == 'semantic'
|
|
18
|
+
Requires-Dist: tokenizers>=0.15,<1.0 ; extra == 'semantic'
|
|
19
|
+
Requires-Dist: huggingface-hub>=0.20,<2.0 ; extra == 'semantic'
|
|
20
|
+
Requires-Dist: numpy>=1.26 ; extra == 'semantic'
|
|
21
|
+
Requires-Python: >=3.12
|
|
22
|
+
Project-URL: Homepage, https://github.com/Pankrazio/urdyn-memory
|
|
23
|
+
Project-URL: Repository, https://github.com/Pankrazio/urdyn-memory
|
|
24
|
+
Project-URL: Issues, https://github.com/Pankrazio/urdyn-memory/issues
|
|
25
|
+
Provides-Extra: semantic
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
|
|
28
|
+
# ๐ง Urdyn
|
|
29
|
+
|
|
30
|
+
> **Models are replaceable. Memory should remain portable.**
|
|
31
|
+
|
|
32
|
+
Urdyn is a local-first, private-by-default memory engine for projects, people, and AI agents. It keeps durable decisions, evidence, attempts, lessons, and project context in `.urdyn/`, independently of any model or provider.
|
|
33
|
+
|
|
34
|
+
## โก Quick start
|
|
35
|
+
|
|
36
|
+
Install Urdyn from PyPI:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
pip install urdyn-memory
|
|
40
|
+
|
|
41
|
+
Or install it from a local source checkout:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
cd /path/to/urdyn-memory
|
|
45
|
+
python -m pip install .
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Then initialize Urdyn inside a project:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
cd my-project
|
|
52
|
+
urdyn init dev
|
|
53
|
+
urdyn status
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
The base engine requires Python 3.12+, declares zero mandatory runtime dependencies, and needs no model or API key.
|
|
57
|
+
|
|
58
|
+
## Why Urdyn?
|
|
59
|
+
|
|
60
|
+
Provider history belongs to a provider and a session. When the session ends, the model changes, or another tool takes over, the project's operational knowledge should not disappear with it.
|
|
61
|
+
|
|
62
|
+
**The model is replaceable. The memory is persistent.**
|
|
63
|
+
|
|
64
|
+
Urdyn is not a conversation archive. It stores explicit, structured records with provenance and current-state rules, then retrieves the material relevant to the task at hand. A new AI session can reconstruct useful project context without depending on a previous provider transcript.
|
|
65
|
+
|
|
66
|
+
## ๐ง What Urdyn remembers
|
|
67
|
+
|
|
68
|
+
Urdyn keeps different kinds of information separate instead of flattening everything into chat text:
|
|
69
|
+
|
|
70
|
+
| Concept | What it represents |
|
|
71
|
+
| --- | --- |
|
|
72
|
+
| **Memory** | Notes, decisions, root causes, pending work, questions, invariants, environment facts, and lessons |
|
|
73
|
+
| **Evidence** | User statements or confirmations, command/test/tool output, observed errors, file references, and document observations |
|
|
74
|
+
| **Attempt** | What was tried, how it was tried, and whether it succeeded, failed, or was partial |
|
|
75
|
+
| **Skill** | An ordered procedure deliberately promoted from a Lesson; never created automatically |
|
|
76
|
+
| **Source** | A project file identity with an append-only history of observations |
|
|
77
|
+
| **Current state** | The current projection of Memory after superseded records are excluded; full history remains available |
|
|
78
|
+
|
|
79
|
+
This preserves decisions, failures, provenance, and lessons as distinct records rather than pretending they all carry the same authority.
|
|
80
|
+
|
|
81
|
+
## ๐ Local-first and private by default
|
|
82
|
+
|
|
83
|
+
- Canonical data lives inside `.urdyn/` in your workspace.
|
|
84
|
+
- No account, cloud service, or API key is required for the base engine.
|
|
85
|
+
- Base operation does not automatically upload data or download a model.
|
|
86
|
+
- `urdyn init` adds `.urdyn/` to the project's `.gitignore` automatically.
|
|
87
|
+
- Seeding a document stores the observed document content locally in `.urdyn/`; it is not sent elsewhere.
|
|
88
|
+
|
|
89
|
+
The optional semantic extra is the explicit exception to zero downloads: its setup fetches a pinned embedding model from Hugging Face.
|
|
90
|
+
|
|
91
|
+
## ๐ค Works with AI tools
|
|
92
|
+
|
|
93
|
+
Any AI tool or coding agent with shell access can use Urdyn through its public CLI. Tools without shell access can consume context that you export and provide to them manually.
|
|
94
|
+
|
|
95
|
+
```text
|
|
96
|
+
AI / tool
|
|
97
|
+
โ
|
|
98
|
+
โผ
|
|
99
|
+
Urdyn public CLI / Python API
|
|
100
|
+
โ
|
|
101
|
+
โผ
|
|
102
|
+
validation ยท provenance ยท memory rules
|
|
103
|
+
โ
|
|
104
|
+
โผ
|
|
105
|
+
.urdyn/
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
This is a generic integration boundary, not an automatic provider integration. Urdyn 0.1.0 does not ship provider-specific adapters, MCP support, autonomous curation, or automatic invocation. AI tools should use the public CLI/API and never edit `.urdyn/` directly.
|
|
109
|
+
|
|
110
|
+
## Existing project files
|
|
111
|
+
|
|
112
|
+
Explicit file seeding works in every profile. In a `dev` workspace, `urdyn seed` with no paths lists conservative discovery candidates and records nothing. Name regular UTF-8 text files explicitly to observe them:
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
urdyn seed # list candidates; record nothing
|
|
116
|
+
urdyn seed README.md pyproject.toml # record specific files
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
Each seeded file becomes a Source with a document-observation Evidence record. Urdyn keeps the observed text, digest, size, and timestamp, but does not treat the document's claims as verified knowledge.
|
|
120
|
+
|
|
121
|
+
## ๐ Project watcher
|
|
122
|
+
|
|
123
|
+
The `dev` profile can keep project-document observations current in the background:
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
urdyn watch status
|
|
127
|
+
urdyn watch start
|
|
128
|
+
urdyn watch stop
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
`urdyn init dev` enables and starts the watcher. It watches only already tracked Sources plus the same conservative discovery allowlist used by `urdyn seed`; it never scans the whole project. Changes create Source/Observation/Evidence records, never automatic Memory or other canonical knowledge, and remain local. `urdyn watch stop` stops and persistently disables it.
|
|
132
|
+
|
|
133
|
+
The watcher is validated and supported on Linux in this release. Known 0.1.0 limits:
|
|
134
|
+
|
|
135
|
+
- Deletions and renames are not tracked. Existing history is retained, and a renamed file begins a new Source history.
|
|
136
|
+
- It is not a boot service. After a reboot, the next normal `urdyn` command restarts an enabled watcher and rechecks already tracked files.
|
|
137
|
+
- A file first created while the watcher is down is discovered only after it changes again, not retroactively at restart.
|
|
138
|
+
|
|
139
|
+
## Evidence โ Knowledge
|
|
140
|
+
|
|
141
|
+
**Evidence records what was observed. Memory records what the caller asks Urdyn to treat as knowledge, with an explicit epistemic state.**
|
|
142
|
+
|
|
143
|
+
Recording Evidence never creates a Memory, Lesson, or Skill automatically. A seeded README is faithful evidence of what that file said at that moment; it is not proof that the README is correct. A new Memory can be `user_asserted`, `inferred`, or `verified`, and `verified` requires explicitly designated supporting Evidence of a qualifying kind. Urdyn enforces that structural gate but does not claim to understand whether the evidence truly proves the conclusion.
|
|
144
|
+
|
|
145
|
+
## ๐งฉ Profiles
|
|
146
|
+
|
|
147
|
+
```bash
|
|
148
|
+
urdyn init [general|dev|lab]
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
| Profile | Implemented behavior |
|
|
152
|
+
| --- | --- |
|
|
153
|
+
| **`general`** | Core engine; explicit seed works, but no-path discovery and the watcher are unavailable |
|
|
154
|
+
| **`dev`** | Adds no-path project-file discovery and the Linux-validated background watcher |
|
|
155
|
+
| **`lab`** | Reserved canonical profile identifier; currently behaves like `general` |
|
|
156
|
+
|
|
157
|
+
All profiles share the same canonical store, retrieval, preflight, context, and export behavior. Today, the profile changes only no-path seed discovery and watcher availability.
|
|
158
|
+
|
|
159
|
+
## ๐ฆ Python API
|
|
160
|
+
|
|
161
|
+
The distribution is `urdyn-memory`, the import package is `urdyn`, and the public workspace class is `Urdyn`:
|
|
162
|
+
|
|
163
|
+
```python
|
|
164
|
+
from urdyn import Urdyn
|
|
165
|
+
|
|
166
|
+
ud = Urdyn.discover()
|
|
167
|
+
ud.remember("SQLite is the canonical project store.", kind="decision")
|
|
168
|
+
|
|
169
|
+
for memory in ud.recall("SQLite is the canonical project store"):
|
|
170
|
+
print(memory.content)
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
The Python API and the `urdyn` CLI share the core validation and persistence rules. This README shows only the essential entry points; use the public types exported from `urdyn` for library integration.
|
|
174
|
+
|
|
175
|
+
## Context compilation and export
|
|
176
|
+
|
|
177
|
+
Before starting work, ask Urdyn for relevant prior experience:
|
|
178
|
+
|
|
179
|
+
```bash
|
|
180
|
+
urdyn preflight "wrap a multi-step migration in one transaction"
|
|
181
|
+
urdyn context "wrap a multi-step migration in one transaction"
|
|
182
|
+
urdyn export "wrap a multi-step migration in one transaction"
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
`context` compiles a task-aware, character-budgeted working context. `export` renders the same kind of context as portable generic text suitable for redirection or piping:
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
urdyn export "<task description>" > context.txt
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
This export is task-scoped context, not a full backup or memory-archive export.
|
|
192
|
+
|
|
193
|
+
## Semantic retrieval
|
|
194
|
+
|
|
195
|
+
The base engine works offline with lexical/full-text retrieval. Semantic retrieval is optional:
|
|
196
|
+
|
|
197
|
+
```bash
|
|
198
|
+
pip install "urdyn-memory[semantic]"
|
|
199
|
+
urdyn semantic setup
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
Setup downloads a pinned embedding model and builds a derived local index next to the canonical store. The index is rebuildable; when semantic retrieval is unavailable, canonical data remains intact and Urdyn falls back to lexical retrieval.
|
|
203
|
+
|
|
204
|
+
## ๐ Current scope and limitations
|
|
205
|
+
|
|
206
|
+
Urdyn 0.1.0 is an alpha release. It does not currently include:
|
|
207
|
+
|
|
208
|
+
- cloud sync;
|
|
209
|
+
- a GUI or desktop application;
|
|
210
|
+
- native provider adapters or MCP integration;
|
|
211
|
+
- autonomous AI-driven memory curation;
|
|
212
|
+
- automatic conversation ingestion;
|
|
213
|
+
- full memory-archive import/export.
|
|
214
|
+
|
|
215
|
+
The CLI/API boundary is deliberate: Urdyn provides the memory engine and its rules, while a person or external tool decides what to record and when to consult it.
|
|
216
|
+
|
|
217
|
+
## Development
|
|
218
|
+
|
|
219
|
+
```bash
|
|
220
|
+
uv sync --extra semantic
|
|
221
|
+
uv run pytest
|
|
222
|
+
HF_HUB_OFFLINE=1 uv run pytest -m real_model
|
|
223
|
+
uv build
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
The full test suite exercises the optional semantic backend, so development setup installs the semantic extra. The base package still has no mandatory runtime dependencies.
|
|
227
|
+
|
|
228
|
+
Development requires Python 3.12+ and [uv](https://docs.astral.sh/uv/).
|
|
229
|
+
|
|
230
|
+
## License
|
|
231
|
+
|
|
232
|
+
Apache License 2.0. See [LICENSE](LICENSE).
|
|
233
|
+
|
|
234
|
+
## ๐ Languages
|
|
235
|
+
|
|
236
|
+
This document is in English. See [README.it.md](README.it.md) for the Italian version.
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
# ๐ง Urdyn
|
|
2
|
+
|
|
3
|
+
> **Models are replaceable. Memory should remain portable.**
|
|
4
|
+
|
|
5
|
+
Urdyn is a local-first, private-by-default memory engine for projects, people, and AI agents. It keeps durable decisions, evidence, attempts, lessons, and project context in `.urdyn/`, independently of any model or provider.
|
|
6
|
+
|
|
7
|
+
## โก Quick start
|
|
8
|
+
|
|
9
|
+
Install Urdyn from PyPI:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pip install urdyn-memory
|
|
13
|
+
|
|
14
|
+
Or install it from a local source checkout:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
cd /path/to/urdyn-memory
|
|
18
|
+
python -m pip install .
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Then initialize Urdyn inside a project:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
cd my-project
|
|
25
|
+
urdyn init dev
|
|
26
|
+
urdyn status
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The base engine requires Python 3.12+, declares zero mandatory runtime dependencies, and needs no model or API key.
|
|
30
|
+
|
|
31
|
+
## Why Urdyn?
|
|
32
|
+
|
|
33
|
+
Provider history belongs to a provider and a session. When the session ends, the model changes, or another tool takes over, the project's operational knowledge should not disappear with it.
|
|
34
|
+
|
|
35
|
+
**The model is replaceable. The memory is persistent.**
|
|
36
|
+
|
|
37
|
+
Urdyn is not a conversation archive. It stores explicit, structured records with provenance and current-state rules, then retrieves the material relevant to the task at hand. A new AI session can reconstruct useful project context without depending on a previous provider transcript.
|
|
38
|
+
|
|
39
|
+
## ๐ง What Urdyn remembers
|
|
40
|
+
|
|
41
|
+
Urdyn keeps different kinds of information separate instead of flattening everything into chat text:
|
|
42
|
+
|
|
43
|
+
| Concept | What it represents |
|
|
44
|
+
| --- | --- |
|
|
45
|
+
| **Memory** | Notes, decisions, root causes, pending work, questions, invariants, environment facts, and lessons |
|
|
46
|
+
| **Evidence** | User statements or confirmations, command/test/tool output, observed errors, file references, and document observations |
|
|
47
|
+
| **Attempt** | What was tried, how it was tried, and whether it succeeded, failed, or was partial |
|
|
48
|
+
| **Skill** | An ordered procedure deliberately promoted from a Lesson; never created automatically |
|
|
49
|
+
| **Source** | A project file identity with an append-only history of observations |
|
|
50
|
+
| **Current state** | The current projection of Memory after superseded records are excluded; full history remains available |
|
|
51
|
+
|
|
52
|
+
This preserves decisions, failures, provenance, and lessons as distinct records rather than pretending they all carry the same authority.
|
|
53
|
+
|
|
54
|
+
## ๐ Local-first and private by default
|
|
55
|
+
|
|
56
|
+
- Canonical data lives inside `.urdyn/` in your workspace.
|
|
57
|
+
- No account, cloud service, or API key is required for the base engine.
|
|
58
|
+
- Base operation does not automatically upload data or download a model.
|
|
59
|
+
- `urdyn init` adds `.urdyn/` to the project's `.gitignore` automatically.
|
|
60
|
+
- Seeding a document stores the observed document content locally in `.urdyn/`; it is not sent elsewhere.
|
|
61
|
+
|
|
62
|
+
The optional semantic extra is the explicit exception to zero downloads: its setup fetches a pinned embedding model from Hugging Face.
|
|
63
|
+
|
|
64
|
+
## ๐ค Works with AI tools
|
|
65
|
+
|
|
66
|
+
Any AI tool or coding agent with shell access can use Urdyn through its public CLI. Tools without shell access can consume context that you export and provide to them manually.
|
|
67
|
+
|
|
68
|
+
```text
|
|
69
|
+
AI / tool
|
|
70
|
+
โ
|
|
71
|
+
โผ
|
|
72
|
+
Urdyn public CLI / Python API
|
|
73
|
+
โ
|
|
74
|
+
โผ
|
|
75
|
+
validation ยท provenance ยท memory rules
|
|
76
|
+
โ
|
|
77
|
+
โผ
|
|
78
|
+
.urdyn/
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
This is a generic integration boundary, not an automatic provider integration. Urdyn 0.1.0 does not ship provider-specific adapters, MCP support, autonomous curation, or automatic invocation. AI tools should use the public CLI/API and never edit `.urdyn/` directly.
|
|
82
|
+
|
|
83
|
+
## Existing project files
|
|
84
|
+
|
|
85
|
+
Explicit file seeding works in every profile. In a `dev` workspace, `urdyn seed` with no paths lists conservative discovery candidates and records nothing. Name regular UTF-8 text files explicitly to observe them:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
urdyn seed # list candidates; record nothing
|
|
89
|
+
urdyn seed README.md pyproject.toml # record specific files
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Each seeded file becomes a Source with a document-observation Evidence record. Urdyn keeps the observed text, digest, size, and timestamp, but does not treat the document's claims as verified knowledge.
|
|
93
|
+
|
|
94
|
+
## ๐ Project watcher
|
|
95
|
+
|
|
96
|
+
The `dev` profile can keep project-document observations current in the background:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
urdyn watch status
|
|
100
|
+
urdyn watch start
|
|
101
|
+
urdyn watch stop
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
`urdyn init dev` enables and starts the watcher. It watches only already tracked Sources plus the same conservative discovery allowlist used by `urdyn seed`; it never scans the whole project. Changes create Source/Observation/Evidence records, never automatic Memory or other canonical knowledge, and remain local. `urdyn watch stop` stops and persistently disables it.
|
|
105
|
+
|
|
106
|
+
The watcher is validated and supported on Linux in this release. Known 0.1.0 limits:
|
|
107
|
+
|
|
108
|
+
- Deletions and renames are not tracked. Existing history is retained, and a renamed file begins a new Source history.
|
|
109
|
+
- It is not a boot service. After a reboot, the next normal `urdyn` command restarts an enabled watcher and rechecks already tracked files.
|
|
110
|
+
- A file first created while the watcher is down is discovered only after it changes again, not retroactively at restart.
|
|
111
|
+
|
|
112
|
+
## Evidence โ Knowledge
|
|
113
|
+
|
|
114
|
+
**Evidence records what was observed. Memory records what the caller asks Urdyn to treat as knowledge, with an explicit epistemic state.**
|
|
115
|
+
|
|
116
|
+
Recording Evidence never creates a Memory, Lesson, or Skill automatically. A seeded README is faithful evidence of what that file said at that moment; it is not proof that the README is correct. A new Memory can be `user_asserted`, `inferred`, or `verified`, and `verified` requires explicitly designated supporting Evidence of a qualifying kind. Urdyn enforces that structural gate but does not claim to understand whether the evidence truly proves the conclusion.
|
|
117
|
+
|
|
118
|
+
## ๐งฉ Profiles
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
urdyn init [general|dev|lab]
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
| Profile | Implemented behavior |
|
|
125
|
+
| --- | --- |
|
|
126
|
+
| **`general`** | Core engine; explicit seed works, but no-path discovery and the watcher are unavailable |
|
|
127
|
+
| **`dev`** | Adds no-path project-file discovery and the Linux-validated background watcher |
|
|
128
|
+
| **`lab`** | Reserved canonical profile identifier; currently behaves like `general` |
|
|
129
|
+
|
|
130
|
+
All profiles share the same canonical store, retrieval, preflight, context, and export behavior. Today, the profile changes only no-path seed discovery and watcher availability.
|
|
131
|
+
|
|
132
|
+
## ๐ฆ Python API
|
|
133
|
+
|
|
134
|
+
The distribution is `urdyn-memory`, the import package is `urdyn`, and the public workspace class is `Urdyn`:
|
|
135
|
+
|
|
136
|
+
```python
|
|
137
|
+
from urdyn import Urdyn
|
|
138
|
+
|
|
139
|
+
ud = Urdyn.discover()
|
|
140
|
+
ud.remember("SQLite is the canonical project store.", kind="decision")
|
|
141
|
+
|
|
142
|
+
for memory in ud.recall("SQLite is the canonical project store"):
|
|
143
|
+
print(memory.content)
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
The Python API and the `urdyn` CLI share the core validation and persistence rules. This README shows only the essential entry points; use the public types exported from `urdyn` for library integration.
|
|
147
|
+
|
|
148
|
+
## Context compilation and export
|
|
149
|
+
|
|
150
|
+
Before starting work, ask Urdyn for relevant prior experience:
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
urdyn preflight "wrap a multi-step migration in one transaction"
|
|
154
|
+
urdyn context "wrap a multi-step migration in one transaction"
|
|
155
|
+
urdyn export "wrap a multi-step migration in one transaction"
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
`context` compiles a task-aware, character-budgeted working context. `export` renders the same kind of context as portable generic text suitable for redirection or piping:
|
|
159
|
+
|
|
160
|
+
```bash
|
|
161
|
+
urdyn export "<task description>" > context.txt
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
This export is task-scoped context, not a full backup or memory-archive export.
|
|
165
|
+
|
|
166
|
+
## Semantic retrieval
|
|
167
|
+
|
|
168
|
+
The base engine works offline with lexical/full-text retrieval. Semantic retrieval is optional:
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
pip install "urdyn-memory[semantic]"
|
|
172
|
+
urdyn semantic setup
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
Setup downloads a pinned embedding model and builds a derived local index next to the canonical store. The index is rebuildable; when semantic retrieval is unavailable, canonical data remains intact and Urdyn falls back to lexical retrieval.
|
|
176
|
+
|
|
177
|
+
## ๐ Current scope and limitations
|
|
178
|
+
|
|
179
|
+
Urdyn 0.1.0 is an alpha release. It does not currently include:
|
|
180
|
+
|
|
181
|
+
- cloud sync;
|
|
182
|
+
- a GUI or desktop application;
|
|
183
|
+
- native provider adapters or MCP integration;
|
|
184
|
+
- autonomous AI-driven memory curation;
|
|
185
|
+
- automatic conversation ingestion;
|
|
186
|
+
- full memory-archive import/export.
|
|
187
|
+
|
|
188
|
+
The CLI/API boundary is deliberate: Urdyn provides the memory engine and its rules, while a person or external tool decides what to record and when to consult it.
|
|
189
|
+
|
|
190
|
+
## Development
|
|
191
|
+
|
|
192
|
+
```bash
|
|
193
|
+
uv sync --extra semantic
|
|
194
|
+
uv run pytest
|
|
195
|
+
HF_HUB_OFFLINE=1 uv run pytest -m real_model
|
|
196
|
+
uv build
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
The full test suite exercises the optional semantic backend, so development setup installs the semantic extra. The base package still has no mandatory runtime dependencies.
|
|
200
|
+
|
|
201
|
+
Development requires Python 3.12+ and [uv](https://docs.astral.sh/uv/).
|
|
202
|
+
|
|
203
|
+
## License
|
|
204
|
+
|
|
205
|
+
Apache License 2.0. See [LICENSE](LICENSE).
|
|
206
|
+
|
|
207
|
+
## ๐ Languages
|
|
208
|
+
|
|
209
|
+
This document is in English. See [README.it.md](README.it.md) for the Italian version.
|