mneme-cli 0.4.0__py3-none-any.whl
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.
- mneme/__init__.py +8 -0
- mneme/__main__.py +5 -0
- mneme/config.py +103 -0
- mneme/core.py +6526 -0
- mneme/profiles/eu-mdr.md +196 -0
- mneme/profiles/iso-13485.md +182 -0
- mneme/profiles/mappings/dds.json +21 -0
- mneme/profiles/mappings/requirements.json +22 -0
- mneme/profiles/mappings/risk-register.json +24 -0
- mneme/profiles/mappings/test-cases.json +21 -0
- mneme/profiles/mappings/user-needs.json +19 -0
- mneme/server.py +312 -0
- mneme/templates/workspace/.gitignore +9 -0
- mneme/templates/workspace/AGENTS.md +706 -0
- mneme/templates/workspace/README.md +33 -0
- mneme/templates/workspace/inbox/.gitkeep +0 -0
- mneme/templates/workspace/index.md +18 -0
- mneme/templates/workspace/log.md +6 -0
- mneme/templates/workspace/profiles/README.md +109 -0
- mneme/templates/workspace/profiles/mappings/.gitkeep +0 -0
- mneme/templates/workspace/schema/entities.json +5 -0
- mneme/templates/workspace/schema/graph.json +6 -0
- mneme/templates/workspace/schema/tags.json +5 -0
- mneme/templates/workspace/sources/.gitkeep +0 -0
- mneme/templates/workspace/wiki/_templates/page.md +31 -0
- mneme/ui.html +1520 -0
- mneme_cli-0.4.0.dist-info/METADATA +499 -0
- mneme_cli-0.4.0.dist-info/RECORD +32 -0
- mneme_cli-0.4.0.dist-info/WHEEL +5 -0
- mneme_cli-0.4.0.dist-info/entry_points.txt +2 -0
- mneme_cli-0.4.0.dist-info/licenses/LICENSE +21 -0
- mneme_cli-0.4.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# {{PROJECT_NAME}}
|
|
2
|
+
|
|
3
|
+
A Mnemosyne knowledge workspace.
|
|
4
|
+
|
|
5
|
+
## Quick start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# from inside this directory
|
|
9
|
+
mneme stats
|
|
10
|
+
mneme ingest path/to/document.md {{DEFAULT_CLIENT}}
|
|
11
|
+
mneme search "your query"
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Or from anywhere:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
mneme --workspace /path/to/{{PROJECT_SLUG}} stats
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Layout
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
{{PROJECT_SLUG}}/
|
|
24
|
+
wiki/{{DEFAULT_CLIENT}}/ structured markdown pages
|
|
25
|
+
sources/{{DEFAULT_CLIENT}}/ immutable source archive
|
|
26
|
+
schema/ entities, graph, tags, traceability
|
|
27
|
+
memvid/ semantic search archive (created on first sync)
|
|
28
|
+
inbox/ drop files here, run `mneme tornado`
|
|
29
|
+
index.md master catalog
|
|
30
|
+
log.md activity timeline
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Created with `mneme new` on {{CREATED_DATE}}.
|
|
File without changes
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} - Index
|
|
2
|
+
|
|
3
|
+
Last updated: {{CREATED_DATE}}
|
|
4
|
+
|
|
5
|
+
## Clients
|
|
6
|
+
|
|
7
|
+
### {{DEFAULT_CLIENT}}
|
|
8
|
+
(no pages yet)
|
|
9
|
+
|
|
10
|
+
## Shared Knowledge
|
|
11
|
+
(no pages yet)
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
| Metric | Count |
|
|
16
|
+
|---|---|
|
|
17
|
+
| Total pages | 0 |
|
|
18
|
+
| Total sources | 0 |
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# Workspace-local profiles
|
|
2
|
+
|
|
3
|
+
Drop a `<name>.md` file here to define a profile local to this workspace.
|
|
4
|
+
Workspace profiles **shadow** any bundled profile with the same name, so you
|
|
5
|
+
can either add a brand-new framework or override a bundled one with
|
|
6
|
+
project-specific tweaks.
|
|
7
|
+
|
|
8
|
+
## Format
|
|
9
|
+
|
|
10
|
+
A profile is a markdown file with YAML frontmatter for the structured fields
|
|
11
|
+
and recognized H1 headings for the writing-style prose. The simplest possible
|
|
12
|
+
profile:
|
|
13
|
+
|
|
14
|
+
```markdown
|
|
15
|
+
---
|
|
16
|
+
name: My Profile
|
|
17
|
+
description: A short description
|
|
18
|
+
version: 1.0
|
|
19
|
+
tone: formal
|
|
20
|
+
voice: passive-for-procedures
|
|
21
|
+
trace_types: [derived-from, implemented-by, verified-by]
|
|
22
|
+
requirement_levels:
|
|
23
|
+
shall: mandatory
|
|
24
|
+
should: recommended
|
|
25
|
+
vocabulary:
|
|
26
|
+
- use: medical device
|
|
27
|
+
reject: [product, unit, item]
|
|
28
|
+
- use: nonconformity
|
|
29
|
+
reject: [bug, defect]
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
# Principles
|
|
33
|
+
|
|
34
|
+
- Be specific.
|
|
35
|
+
- Cite everything.
|
|
36
|
+
|
|
37
|
+
# General Rules
|
|
38
|
+
|
|
39
|
+
- Avoid editorial language.
|
|
40
|
+
- Define every term at first use.
|
|
41
|
+
|
|
42
|
+
# Terminology
|
|
43
|
+
|
|
44
|
+
| Use | Instead of | Why |
|
|
45
|
+
|---|---|---|
|
|
46
|
+
| medical device | product, unit | The term is reserved by EU MDR. |
|
|
47
|
+
|
|
48
|
+
# Framing: Reporting a result
|
|
49
|
+
|
|
50
|
+
**Wrong:**
|
|
51
|
+
|
|
52
|
+
> The algorithm is highly accurate.
|
|
53
|
+
|
|
54
|
+
**Correct:**
|
|
55
|
+
|
|
56
|
+
> The algorithm achieved 0.91 MCC against the reference standard.
|
|
57
|
+
|
|
58
|
+
**Why:** state the number, not the editorial judgement.
|
|
59
|
+
|
|
60
|
+
# Document Type: design-validation-report
|
|
61
|
+
|
|
62
|
+
A description of this document type goes here as plain prose.
|
|
63
|
+
|
|
64
|
+
## Section: context
|
|
65
|
+
|
|
66
|
+
Per-section guidance for the `context` section of a design-validation-report
|
|
67
|
+
goes here. The agent will pull this in when reviewing a page whose
|
|
68
|
+
frontmatter says `type: design-validation-report`.
|
|
69
|
+
|
|
70
|
+
# Submission Checklist
|
|
71
|
+
|
|
72
|
+
- All references include ID and version
|
|
73
|
+
- No clinical claims
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Recognized H1 headings
|
|
77
|
+
|
|
78
|
+
| Heading | What it becomes |
|
|
79
|
+
|---|---|
|
|
80
|
+
| `# Principles` | `writing_style.principles` (each `-` bullet is one entry) |
|
|
81
|
+
| `# General Rules` | `writing_style.general_rules` (bullets) |
|
|
82
|
+
| `# Terminology` | `writing_style.terminology_guidance` (parsed from a 3-column table: Use / Instead of / Why) |
|
|
83
|
+
| `# Framing: <context>` | one entry in `writing_style.framing_examples` (parses **Wrong:**, **Correct:**, **Why:** blocks) |
|
|
84
|
+
| `# Document Type: <slug>` | `sections[<slug>]`. Body before any `## Section:` becomes the description |
|
|
85
|
+
| `## Section: <slug>` (under a `# Document Type:`) | `sections[<doc-type>].section_notes[<section-slug>]` |
|
|
86
|
+
| `# Submission Checklist` | `submission_checklist` (bullets) |
|
|
87
|
+
|
|
88
|
+
Unrecognized H1 headings are silently ignored - you can use them for
|
|
89
|
+
authoring notes that should not affect mneme's behavior.
|
|
90
|
+
|
|
91
|
+
## Activate it
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
mneme profile set my-profile # name without the .md extension
|
|
95
|
+
mneme profile show
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## Use it
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
mneme harmonize my-client # vocabulary check
|
|
102
|
+
mneme harmonize my-client --fix # auto-fix vocabulary
|
|
103
|
+
mneme validate writing-style my-client/some-page # build LLM review packet
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## CSV mappings
|
|
107
|
+
|
|
108
|
+
Workspace-local CSV column mappings (used by `mneme ingest-csv`) live in
|
|
109
|
+
`profiles/mappings/<name>.json`. The same shadowing rules apply.
|
|
File without changes
|
|
File without changes
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: [Page Title]
|
|
3
|
+
type: [overview|entity|concept|source-summary|comparison|deliverable]
|
|
4
|
+
client: {{DEFAULT_CLIENT}}
|
|
5
|
+
sources: []
|
|
6
|
+
tags: []
|
|
7
|
+
related: []
|
|
8
|
+
created: YYYY-MM-DD
|
|
9
|
+
updated: YYYY-MM-DD
|
|
10
|
+
confidence: medium
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Summary
|
|
14
|
+
|
|
15
|
+
[2-3 sentences. Specific. No abstractions.]
|
|
16
|
+
|
|
17
|
+
## Key Facts
|
|
18
|
+
|
|
19
|
+
- [Fact 1] (source: filename)
|
|
20
|
+
|
|
21
|
+
## Detail
|
|
22
|
+
|
|
23
|
+
[Main content]
|
|
24
|
+
|
|
25
|
+
## Open Questions
|
|
26
|
+
|
|
27
|
+
- [What we don't know yet]
|
|
28
|
+
|
|
29
|
+
## Cross-References
|
|
30
|
+
|
|
31
|
+
- [[related/page-1]]
|