Metadata-Version: 2.4
Name: daybook-suite
Version: 3.0.0rc1
Summary: DAYBOOK 起居注：纯文本、零依赖、只增不改的长期记忆账本（pip 发行版）
Author-email: 手艺人老宋 <songliansheng@vip.sina.com>
License-Expression: MIT
Project-URL: Homepage, https://daybooksuite.com
Project-URL: Repository, https://github.com/songliansheng1972/daybook-suite
Keywords: daybook,append-only,plain-text,long-term-memory,llm-memory,journal,zero-dependency
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Office/Business
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# DAYBOOK 起居注

**纯文本 · 零依赖 · 只增不改**的长期记忆账本。一个人一本账，卷为纯文本，索引可随时重算。

> ⚠ 本发行版为**预发布 `3.0.0rc1`**（发布通道演练件）。安装需加 `--pre`：
> `pip install --pre daybook-suite`

## 安装

```bash
pip install --pre daybook-suite
```

装完即可用（`daybook` 命令）：

```bash
daybook index                 # 生成/刷新索引
daybook query 类=实验 时间=2026-10   # 按字段精确查条目原文
daybook backup                # 手动备份
daybook watch 30              # 监视各卷，变动即重算索引 + 自动备份
```

## 你的数据放在哪（重要）

第一次运行会在**运行目录**就位 `daybook.conf` 与 `sample/`（示例三卷），
账本、索引、备份**全部落在该目录**，不会写进 Python 安装目录。

运行目录的挑选次序：

1. `--home=/path`（当次指定）
2. 环境变量 `DAYBOOK_HOME`
3. **当前目录**（仅当它已含 `daybook.conf` —— 即"用我自己那本账"）
4. 默认 `~/.daybook`（首次自动创建）

代码本体留在包内并以软链接入，`pip install -U` 升级代码时**不会动你的账本**。
要用自己的账本：把 `daybook.conf` 里的 `[卷]` 路径改成你自己的纯文本卷即可（相对该目录或绝对路径都行）。

## 八件要紧的事

1. **纯文本** —— 卷是纯文本，任何编辑器、任何年代都能打开。
2. **零依赖** —— 只用 Python 标准库，不装任何第三方包。
3. **只增不改** —— 追加写，旧的条目不删不改（append-only 纪律）。
4. **够快** —— 索引随取随算，日常规模下即时完成。
5. **多写者安全** —— 带锁写入，多人/多进程同时记不会互相踩。
6. **图是引用** —— 结构以引用表达，不复制正文。
7. **可挂长期记忆** —— 可作为 AI 智能体的可读长期记忆底座。
8. **跨年代** —— 不依赖特定工具链，十年后仍读得出。

## 三件套

| 件 | 名 | 作用 | 许可 |
|---|---|---|---|
| `daybook-suite` | 起居注 | 账本本体：索引 / 查询 / 备份 / 监视 | MIT |
| `daybook-mcp` | 璇玑 | MCP 接口（resources / tools / prompts） | MIT |
| `daybook-orch` | 司南 | 智能体编排中心 | AGPL-3.0-or-later |

本包是**起居注**一件；另两件另行发布。整装 zip 见 GitHub Release。

## 许可

MIT License · Copyright (c) 2026 手艺人老宋 &lt;songliansheng@vip.sina.com&gt;

- 官网：<https://daybooksuite.com>
- 仓库：<https://github.com/songliansheng1972/daybook-suite>
