klnote 0.1.0__tar.gz

klnote-0.1.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: klnote
+Version: 0.1.0
+Summary: Stock note management tool
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+
+# KLNote
+
+股票笔记管理工具，为专注股票投资的人群设计。
+
+## 背景
+
+投资股票时，每次决策都需要记录：为什么买、为什么卖、当时想到了什么。这些记录是后续复盘的核心素材。但普通笔记软件太通用，无法围绕"股票"这个实体组织信息——查一只股票的笔记，要翻半天。
+
+KLNote 的核心思路是：**先有股票，再有笔记**。每条笔记属于某只股票，每次查看都围绕股票展开。
+
+## 核心概念
+
+- **股票**：用 code（代码）或 name（名称）标识，如 `000001`、平安银行
+- **笔记**：附属于某只股票，每条包含 summary（摘要） 和 content（内容）
+- **标识符**：支持三种方式定位股票 — UUID、股票代码、股票名称
+
+## 安装
+
+```bash
+pip install klnote
+```
+
+## 使用
+
+```bash
+# 股票操作
+klnote stk ls              # 列出所有股票
+klnote stk add 000001 -n 平安银行    # 添加股票
+klnote stk get 000001       # 查看股票（支持 id/code/name）
+klnote stk delete 000001    # 删除股票
+
+# 笔记操作
+klnote note add 000001 -s "摘要" -c "内容"   # 添加笔记
+klnote note ls 000001       # 列出笔记
+klnote note delete 000001 0 # 删除第0条笔记
+```
+
+## 数据库
+
+默认路径: `~/.KLNote/KLNote.db`
+
+可通过环境变量 `KLNOTE_DB_PATH` 自定义路径。
+
+## 命令指南
+
+### 全局命令
+
+```
+klnote --help
+```
+
+### 股票操作 (stk)
+
+```
+klnote stk ls                       # 列出所有股票
+klnote stk add <code> [-n name] [-d desc]   # 添加股票
+klnote stk get <identifier>         # 查看股票详情
+klnote stk delete <identifier>      # 删除股票
+```
+
+### 笔记操作 (note)
+
+```
+klnote note add <stock_identifier> [-s 摘要] [-c 内容]   # 添加笔记
+klnote note ls <stock_identifier>     # 列出某只股票的所有笔记
+klnote note delete <stock_identifier> <index>   # 删除指定笔记
+```
+
+### 高级操作 (admin)
+
+```
+klnote admin match_and_read <value> <field>    # 按字段匹配读取
+klnote admin match_and_update <value> <field> <update_field>   # 按字段匹配更新（危险）
+```
+
+### 标识符说明
+
+所有 `<identifier>` 位置均支持三种写法：
+
+| 格式 | 示例 | 解析方式 |
+|------|------|---------|
+| UUID (32位十六进制) | `a1b2c3d4e5f6...` | 精确匹配 id |
+| 纯数字 | `000001` | 匹配 code |
+| 字母/中文混合 | `平安银行` | 先试 code，再试 name |
+
+## 环境变量
+
+| 变量 | 说明 | 默认值 |
+|------|------|--------|
+| `KLNOTE_DB_PATH` | 数据库文件路径 | `~/.KLNote/KLNote.db` |

klnote-0.1.0/README.md

@@ -0,0 +1,90 @@
+# KLNote
+
+股票笔记管理工具，为专注股票投资的人群设计。
+
+## 背景
+
+投资股票时，每次决策都需要记录：为什么买、为什么卖、当时想到了什么。这些记录是后续复盘的核心素材。但普通笔记软件太通用，无法围绕"股票"这个实体组织信息——查一只股票的笔记，要翻半天。
+
+KLNote 的核心思路是：**先有股票，再有笔记**。每条笔记属于某只股票，每次查看都围绕股票展开。
+
+## 核心概念
+
+- **股票**：用 code（代码）或 name（名称）标识，如 `000001`、平安银行
+- **笔记**：附属于某只股票，每条包含 summary（摘要） 和 content（内容）
+- **标识符**：支持三种方式定位股票 — UUID、股票代码、股票名称
+
+## 安装
+
+```bash
+pip install klnote
+```
+
+## 使用
+
+```bash
+# 股票操作
+klnote stk ls              # 列出所有股票
+klnote stk add 000001 -n 平安银行    # 添加股票
+klnote stk get 000001       # 查看股票（支持 id/code/name）
+klnote stk delete 000001    # 删除股票
+
+# 笔记操作
+klnote note add 000001 -s "摘要" -c "内容"   # 添加笔记
+klnote note ls 000001       # 列出笔记
+klnote note delete 000001 0 # 删除第0条笔记
+```
+
+## 数据库
+
+默认路径: `~/.KLNote/KLNote.db`
+
+可通过环境变量 `KLNOTE_DB_PATH` 自定义路径。
+
+## 命令指南
+
+### 全局命令
+
+```
+klnote --help
+```
+
+### 股票操作 (stk)
+
+```
+klnote stk ls                       # 列出所有股票
+klnote stk add <code> [-n name] [-d desc]   # 添加股票
+klnote stk get <identifier>         # 查看股票详情
+klnote stk delete <identifier>      # 删除股票
+```
+
+### 笔记操作 (note)
+
+```
+klnote note add <stock_identifier> [-s 摘要] [-c 内容]   # 添加笔记
+klnote note ls <stock_identifier>     # 列出某只股票的所有笔记
+klnote note delete <stock_identifier> <index>   # 删除指定笔记
+```
+
+### 高级操作 (admin)
+
+```
+klnote admin match_and_read <value> <field>    # 按字段匹配读取
+klnote admin match_and_update <value> <field> <update_field>   # 按字段匹配更新（危险）
+```
+
+### 标识符说明
+
+所有 `<identifier>` 位置均支持三种写法：
+
+| 格式 | 示例 | 解析方式 |
+|------|------|---------|
+| UUID (32位十六进制) | `a1b2c3d4e5f6...` | 精确匹配 id |
+| 纯数字 | `000001` | 匹配 code |
+| 字母/中文混合 | `平安银行` | 先试 code，再试 name |
+
+## 环境变量
+
+| 变量 | 说明 | 默认值 |
+|------|------|--------|
+| `KLNOTE_DB_PATH` | 数据库文件路径 | `~/.KLNote/KLNote.db` |

klnote-0.1.0/klnote/cli.py

@@ -0,0 +1,188 @@
+import click
+from klnote.core.service import Service
+
+service = Service()
+
+
+@click.group()
+def cli():
+    """KLNote - 股票笔记管理"""
+    pass
+
+
+def search_by_identifier(identifier: str):
+    """
+    股票标识符解析，返回 stock id 列表
+
+    解析逻辑:
+      1. UUID格式(32位十六进制) → search(id=)
+      2. 纯数字               → search(code=)
+      3. 其他(字母/中文混合)   → search(code=) 优先，search(name=) 兜底
+    """
+    import re
+    # UUID → id
+    if re.fullmatch(r'[0-9a-f]{32}', identifier):
+        return service.search(id=identifier)
+
+    # 纯数字 → code
+    if identifier.isdigit():
+        return service.search(code=identifier)
+
+    # 其他（字母混合）→ 先试 code，再试 name
+    ids = service.search(code=identifier)
+    if not ids:
+        ids = service.search(name=identifier)
+    return ids
+
+
+# ============= stock 组 =============
+@cli.group()
+def stk():
+    """股票操作"""
+    pass
+
+
+@stk.command()
+def ls():
+    """列出所有股票"""
+    stocks = service.stock_list()
+    if not stocks:
+        click.echo("暂无股票")
+        return
+    for s in stocks:
+        click.echo(f"{s['id']}: {s['code']} {s.get('name', '')}")
+
+
+@stk.command()
+@click.argument('code')
+@click.option('-n', '--name', default='', help='股票名称')
+@click.option('-d', '--description', default='', help='描述')
+def add(code, name, description):
+    """新增股票"""
+    service.stock_add(code=code, name=name, description=description)
+    click.echo(f"已添加: {code}")
+
+
+@stk.command()
+@click.argument('identifier')
+def get(identifier):
+    """查看股票详情（支持 id/code/name）"""
+    stock_ids = search_by_identifier(identifier)
+    if not stock_ids:
+        click.echo("未找到")
+        return
+    for stock_id in stock_ids:
+        s = service.stock_show(stock_id)
+        click.echo(f"ID: {s['id']}")
+        click.echo(f"代码: {s['code']}")
+        click.echo(f"名称: {s.get('name', '')}")
+        click.echo(f"描述: {s.get('description', '')}")
+        notes = s.get('notes', [])
+        click.echo(f"笔记数: {len(notes)}")
+        click.echo("-"*50)
+
+
+@stk.command()
+@click.argument('identifier')
+def delete(identifier):
+    """删除股票（支持 id/code/name）"""
+    stock_ids = search_by_identifier(identifier)
+    if not stock_ids:
+        click.echo("未找到")
+        return
+    for stock_id in stock_ids:
+        service.stock_delete(stock_id)
+        click.echo(f"已删除: {stock_id}")
+        click.echo("-" * 50)
+
+# ============= note 组 =============
+@cli.group()
+def note():
+    """笔记操作"""
+    pass
+
+
+@note.command()
+@click.argument('stock_identifier')
+@click.option('-s', '--summary', default='', help='笔记摘要')
+@click.option('-c', '--content', default='', help='笔记内容')
+def add(stock_identifier, summary, content):
+    """添加笔记（支持 id/code/name）"""
+    stock_ids = search_by_identifier(stock_identifier)
+    if not stock_ids:
+        click.echo("未找到股票")
+        return
+    for stock_id in stock_ids:
+        service.note_add(stock_id, content=content, summary=summary)
+        click.echo(f"'id' = '{stock_id}' 笔记已添加")
+        click.echo("-" * 50)
+
+@note.command()
+@click.argument('stock_identifier')
+def ls(stock_identifier):
+    """列出股票的所有笔记（支持 id/code/name）"""
+    stock_ids = search_by_identifier(stock_identifier)
+    if not stock_ids:
+        click.echo("未找到股票")
+        return
+    for stock_id in stock_ids:
+        notes = service.note_read(stock_id)
+        if not notes:
+            click.echo(f"[{stock_id}] 暂无笔记")
+            continue
+        for i, n in enumerate(notes):
+            click.echo(f"[{i}] {n.get('summary', '')}")
+            click.echo(f"    {n.get('content', '')}")
+            click.echo(f"    created: {n.get('created_at', '')}")
+        click.echo("-"*50)
+
+
+@note.command()
+@click.argument('stock_identifier')
+@click.argument('index', type=int)
+def delete(stock_identifier, index):
+    """删除笔记（支持 id/code/name）"""
+    stock_ids = search_by_identifier(stock_identifier)
+    if not stock_ids:
+        click.echo("未找到股票")
+        return
+    for stock_id in stock_ids:
+        service.note_delete(stock_id, index)
+        click.echo(f"已删除第 {index} 条笔记")
+        click.echo("-" * 50)
+
+# ============= admin 组 =============
+@cli.group()
+def admin():
+    """高级操作（直接操作数据库字段）"""
+    pass
+
+
+@admin.command()
+@click.argument('value')
+@click.argument('field')
+def match_and_read(value, field):
+    """按字段匹配并读取所有匹配的股票"""
+    results = service.match_and_read(value, field)
+    if not results:
+        click.echo("未找到匹配结果")
+        return
+    for stock_id, data in results.items():
+        click.echo(f"ID: {stock_id}")
+        click.echo(f"  code: {data.get('code', '')}")
+        click.echo(f"  name: {data.get('name', '')}")
+        click.echo("-" * 50)
+
+
+@admin.command()
+@click.argument('value')
+@click.argument('field')
+@click.argument('update_field')
+def match_and_update(value, field, update_field):
+    """按字段匹配并更新（危险操作）"""
+    service.match_and_update(value, field, update_field)
+    click.echo(f"已更新 field={update_field} 的所有匹配记录")
+
+
+if __name__ == '__main__':
+    cli()

klnote-0.1.0/klnote/core/constants.py

@@ -0,0 +1,47 @@
+import os
+
+DEFAULT_METADATA_JSON = """{
+    "code":null,
+    "name":null,
+    "country":null,
+    "label":null,
+    "extra":null
+}"""
+DEFAULT_METADATA = {
+    "code":None,
+    "name":None,
+    "country":None,
+    "label":None,
+    "extra":None
+}
+
+def _get_db_path(debug_path:str=None):
+    """获取默认数据库路径，优先级: debug_path>/ KLNOTE_DB_PATH > ~/.KLNote/KLNote.db"""
+    if debug_path:
+        return os.path.abspath(debug_path)
+    env_path = os.environ.get("KLNOTE_DB_PATH")
+    if env_path:
+        return env_path
+    home = os.path.expanduser("~")
+    db_dir = os.path.join(home, ".KLNote")
+    os.makedirs(db_dir, exist_ok=True)
+    return os.path.join(db_dir, "KLNote.db")
+
+DB_PATH = _get_db_path()
+
+
+DEFAULT_TABLE_NAME = "klnote"
+
+
+NO_WAIT_EDITORS = {
+        "notepad",       # Windows 记事本
+        "vim", "vi",     # 终端 vim
+        "nano",          # 终端 nano
+        "gedit",         # Linux 编辑器
+        "textedit",      # macOS 编辑器
+        "edit",          # Windows 简易编辑
+    }
+
+
+
+ADD_NOTE_INIT_TEXT = ""

klnote-0.1.0/klnote/core/database.py

@@ -0,0 +1,262 @@
+import sqlite3
+from  pathlib import Path
+from uuid import uuid4
+import json
+
+from .constants import DEFAULT_METADATA,DB_PATH,DEFAULT_TABLE_NAME
+
+from .utils import get_iso_timestamp
+
+
+
+
+
+
+
+class Database:
+    def __init__(self, path:str, table_name:str=DEFAULT_TABLE_NAME):
+
+
+        self.path = path
+        self.table_name = table_name
+        self.init_db()
+
+        self.conn = sqlite3.connect(path)
+        self.cursor = self.conn.cursor()
+        self.cursor.row_factory = sqlite3.Row
+
+
+
+    def init_db(self):
+
+        conn = sqlite3.connect(self.path)
+        cursor = conn.cursor()
+        cursor.execute(f'''
+          CREATE TABLE IF NOT EXISTS {self.table_name} (
+              id TEXT PRIMARY KEY,
+              code TEXT NOT NULL,
+              name TEXT,
+              metadata TEXT NOT NULL,
+              description TEXT,
+              notes TEXT,
+              created_at TIMESTAMP NOT NULL,
+              updated_at TIMESTAMP
+          )
+          ''')
+        conn.close()
+        return self
+
+    def create_new_stock_row(
+
+            self,
+            code: str,
+            id: str = None,
+            name: str = None,
+            metadata: dict = DEFAULT_METADATA,
+            description: str = None,
+    ) -> dict:
+        """
+                :param code: 股票编号
+                :param id: uuid4().hex
+                :param name: 股票名称
+                :param metadata: ..constants.METADATA_DEFAULT_JSON
+                :param description: 对这只股票的简述
+
+                """
+        id = uuid4().hex if id is None else id
+        metadata = json.dumps(metadata)
+        notes = "[]"
+        created_at = get_iso_timestamp()
+        updated_at = None
+
+        return {
+            "id": id,
+            "code": code,
+            "name": name,
+            "metadata": metadata,
+            "description": description,
+            "notes": notes,
+            "created_at": created_at,
+            "updated_at": updated_at,
+        }
+    def add_new_stock_row(
+            self,
+            code: str,
+            id: str,
+            name: str = None,
+            metadata: str = None,
+            description: str = None,
+            notes: str = None,
+            created_at: str = None,
+            updated_at: str = None,
+    ):
+        """
+
+        :param kwargs: 为 create_new_stock_row 返回值
+        :return: self
+        """
+        kwargs = {
+            "id": id,
+            "code": code,
+            "name": name,
+            "metadata": metadata,
+            "description": description,
+            "notes": notes,
+            "created_at": created_at,
+            "updated_at": updated_at,
+        }
+
+        self.cursor.execute(
+            f'''INSERT INTO {self.table_name} (id, code, name, metadata, description, notes, created_at, updated_at) VALUES (?, ?, ?, ?, ?, ?, ?, ?)''',
+            (kwargs["id"], kwargs["code"], kwargs["name"], kwargs["metadata"], kwargs["description"], kwargs["notes"], kwargs["created_at"], kwargs["updated_at"]))
+        self.conn.commit()
+        return self
+
+    def create_and_add_new_stock_row(
+            self,
+            code: str,
+            id: str = None,
+            name: str = None,
+            metadata: dict = DEFAULT_METADATA,
+            description: str = None,
+    ):
+        kwargs = self.create_new_stock_row(code, id, name, metadata, description)
+        self.add_new_stock_row(**kwargs)
+        return self
+
+
+    def read(self,ids:  str|list[str]="*", fields_for_reading: str|list[str]="*") -> dict[dict[str, str]]:
+        """从数据库读取信息 ids、fields 但字段查询为字段名str，多字段查询为list，元素是字段名
+        :param ids 查询的row的id
+        :param fields 查询 需返回的字段名
+        :return
+            若 有结果， 返回字典：{"id":{"字段"："值"}}
+            若没有结果， 返回 {}
+        """
+
+        result_map = {}
+
+        # 把列表转化成 sql 可用的字符串
+
+        if ids == "*":
+            self.cursor.execute(f"""SELECT id FROM {self.table_name}""")
+            rows = list(self.cursor.fetchall())
+            ids_list = []
+            for row in rows:
+                ids_list.append(row["id"])
+            ids = ids_list
+        elif isinstance(ids, str):
+            ids = [ids]
+        elif isinstance(ids, list):
+            pass
+
+        for id in ids:
+            result = self.read_one(id, fields_for_reading)
+            result_map[id] = result
+
+        return result_map
+
+
+
+    def read_one(self,id:str, read_fields: str|list[str]="*"):
+
+        self.cursor.execute(f'''
+                                SELECT {read_fields} FROM {self.table_name} 
+                                WHERE id = ?
+                                ''', (id,))
+        row = self.cursor.fetchone()
+        if  row is None:
+            return {}
+        row = dict(row)
+
+        if row.get("metadata"):
+            row["metadata"] = json.loads(row["metadata"])
+        if row.get("notes"):
+            row["notes"] = json.loads(row["notes"])
+        result  = row
+        return result
+
+
+
+
+
+
+    def update(self,id: str,field_for_updating:str, content: str):
+        """覆写数据库
+        :param id 覆写 位置 所在 列的 id
+        :param field 覆写 的字段
+        :param content 覆写的内容
+        """
+        self.cursor.execute(f"""
+        UPDATE {self.table_name} SET {field_for_updating}=? WHERE id = ?
+        """,(content,id))
+        self.conn.commit()
+
+    def delete(self,id: str):
+        self.cursor.execute(f"""
+        DELETE FROM {self.table_name} WHERE id = ?
+        """,(id,))
+        self.conn.commit()
+        return self
+
+
+    def match(self, value,field_of_value: str ):
+        """匹配符合条件的 id
+        :return: list[id]"""
+        self.cursor.execute(f"""
+        SELECT id FROM {self.table_name} WHERE {field_of_value} = ?""",(value,))
+        ids  = []
+        for row in list(self.cursor.fetchall()):
+           ids.append(row["id"])
+
+
+        return ids
+
+
+
+
+
+    def match_and_read(self, value ,field_of_value: str ):
+
+        result_map = {}
+        ids = self.match(value,field_of_value)
+        for id in ids:
+            a_result_map = self.read(id)
+            result_map.update(a_result_map)
+        return result_map
+
+    def match_and_update(self, value ,field_of_value: str, field_for_updating: str ):
+
+        ids = self.match(value,field_of_value)
+        for id in ids:
+            self.update(id,field_for_updating)
+        return self
+
+
+
+
+
+
+if __name__ == "__main__":
+    db = Database(DB_PATH)
+    #
+    db.create_and_add_new_stock_row(
+        code="000001",id="1" )
+
+    # rows = db.read(ids="1",fields="code")
+    print(db.read())
+
+    # print(rows)
+
+
+
+
+
+
+
+
+
+
+
+
+

klnote-0.1.0/klnote/core/exceptions.py

@@ -0,0 +1,5 @@
+class IsNotSqliteDBError(Exception):
+    pass
+
+class TableExistsError(Exception):
+    pass

klnote-0.1.0/klnote/core/schema/schame.py

@@ -0,0 +1,3 @@
+NOTES = [
+
+]

klnote-0.1.0/klnote/core/service.py

@@ -0,0 +1,104 @@
+import json
+
+from .database import Database
+from .constants import DB_PATH
+from .utils import get_iso_timestamp
+
+
+class Service:
+    def __init__(self, db: Database = None):
+        self.db = db or Database(DB_PATH)
+
+
+    def search(self,id:str=None, code:str=None, name:str=None):
+        """
+         id code name 三选一 查询,若多填， 优先 找 id 其次 code 最后 name
+
+        :return ids:  list[id]
+        """
+        if id:
+            ids = self.db.match(id, "id")
+        elif code:
+            ids = self.db.match(code,"code" )
+        elif name:
+            ids = self.db.match(name, "name" )
+
+
+        return ids
+
+    # stock
+    def stock_add(self, code: str, id: str = None, name: str = None, description: str = None):
+        """新建股票条目"""
+        self.db.create_and_add_new_stock_row(code=code, id=id, name=name, description=description)
+        return self
+
+    def stock_delete(self, id: str):
+        """删除股票"""
+        self.db.delete(id)
+        return self
+
+    def stock_show(self, id: str):
+        """展示单支股票完整信息"""
+        result = self.db.read(id)
+        return result.get(id, {})
+
+    def stock_list(self):
+        """列出所有股票"""
+        return list(self.db.read().values())
+
+    def _build_note(self, content: str, summary: str = None, extra: dict = None) -> dict:
+        """构建标准笔记结构"""
+        now = get_iso_timestamp()
+        return {
+            "summary": summary,
+            "content": content,
+            "created_at": now,
+            "updated_at": None,
+            "extra": extra or {}
+        }
+
+    def note_add(self, stock_id: str, content: str, summary: str = None, extra: dict = None):
+        """给股票添加一条笔记"""
+        stock = self.stock_show(stock_id)
+        notes = stock.get("notes", [])
+        note = self._build_note(content, summary, extra)
+        notes.append(note)
+        self.db.update(stock_id, "notes", json.dumps(notes))
+        return self
+
+    def note_delete(self, stock_id: str, index: int):
+        """删除股票指定索引的笔记"""
+        stock = self.stock_show(stock_id)
+        notes = stock.get("notes", [])
+        notes.pop(index)
+        self.db.update(stock_id, "notes", json.dumps(notes))
+        return self
+
+    def _read_notes(self, stock_id: str) -> list:
+        """读取股票所有笔记（内部用）"""
+        stock = self.stock_show(stock_id)
+        return stock.get("notes", [])
+
+    def note_read(self, stock_id: str, indices: list[int] = None):
+        """读取股票笔记，默认读全部，可指定索引列表"""
+        note_list = self._read_notes(stock_id)
+        if indices is None:
+            return note_list
+        return [note_list[i] for i in indices if 0 <= i < len(note_list)]
+
+    # admin
+    def match_and_read(self, value, field_of_value: str):
+        """按字段匹配并读取"""
+        return self.db.match_and_read(value, field_of_value)
+
+    def match_and_update(self, value, field_of_value: str, field_for_updating: str):
+        """按字段匹配并更新"""
+        self.db.match_and_update(value, field_of_value, field_for_updating)
+        return self
+
+
+if __name__ == "__main__":
+    service = Service()
+    # 测试
+    service.stock_add(code="000001", name="平安银行", description="银行股")
+    print(service.stock_list())

klnote-0.1.0/klnote/core/utils/__init__.py

@@ -0,0 +1,14 @@
+from .db import is_sqlite_db, table_exists, check_file_and_table
+from .time_1 import get_iso_timestamp
+from .editor import edit_in_editor
+
+
+
+__all__ = [
+    "is_sqlite_db",
+    "table_exists",
+    "check_file_and_table",
+    'get_iso_timestamp',
+    'edit_in_editor'
+
+]

klnote-0.1.0/klnote/core/utils/db.py

@@ -0,0 +1,38 @@
+import os
+
+from ..exceptions import IsNotSqliteDBError, TableExistsError
+
+def is_sqlite_db(file_path):
+    """判断文件是否为 SQLite 数据库文件
+    :param file_path:
+    return:若是，则返回Ture，若不是则返回
+    """
+    if not os.path.isfile(file_path):
+        raise FileExistsError(f"文件不存在：{file_path}")
+
+
+def table_exists(path:str,  table_name:str) -> bool:
+    """判断 文件内是否存在指定表名, 存在-> Ture 不存在-> False"""
+    import sqlite3
+    conn = sqlite3.connect(path)
+    cursor = conn.cursor()
+    cursor.execute("SELECT name FROM sqlite_master WHERE type=table AND name=?", (table_name,))
+    return cursor.fetchone()
+
+def check_file_and_table(self, path: str, table_name: str = "kl-note"):
+    # 确保db文件存在
+    if not is_sqlite_db(path):
+        raise FileExistsError(f"文件 '{path}' 不存在")
+
+    # 检查是否是sql文件
+    if not is_sqlite_db(path):
+        raise IsNotSqliteDBError(f"'{path}' 不是 sql数据库 文件")
+
+    # 检查 是否存在 指定表
+    if not table_exists(path, table_name):
+        raise TableExistsError(f"文件 '{path}' 内 不存在 表 '{table_name}'")
+
+
+
+
+

klnote-0.1.0/klnote/core/utils/editor.py

@@ -0,0 +1,41 @@
+
+import tkinter as tk
+from tkinter import scrolledtext
+
+
+
+def edit_in_editor(initial_content: str) -> str | None:
+    """内置编辑器，返回编辑后内容。用户点 X 视为取消，返回 None"""
+
+    result = [None]  # 闭包用
+
+    def on_save():
+        result[0] = text_area.get('1.0', 'end-1c')
+        window.destroy()
+
+    def on_cancel():
+        window.destroy()
+
+    window = tk.Tk()
+    window.title("编辑器 - KLNote")
+
+    text_area = scrolledtext.ScrolledText(window, width=80, height=24, font=(' Consolas ', 10))
+    text_area.insert('1.0', initial_content)
+    text_area.pack(fill='both', expand=True)
+
+    btn_frame = tk.Frame(window)
+    btn_frame.pack(fill='x')
+    tk.Button(btn_frame, text="保存 (Ctrl+S)", command=on_save).pack(side='left', padx=5, pady=5)
+    tk.Button(btn_frame, text="取消", command=on_cancel).pack(side='right', padx=5, pady=5)
+
+    window.bind('<Control-s>', lambda e: on_save())  # Ctrl+S 保存
+    window.protocol("WM_DELETE_WINDOW", on_cancel)  # 点 X 视为取消
+    window.mainloop()
+
+    return result[0]
+
+
+
+if __name__ == "__main__":
+    cont = edit_in_editor(initial_content="你好")
+    print(cont)

klnote-0.1.0/klnote/core/utils/time_1.py

@@ -0,0 +1,8 @@
+import os
+from datetime import datetime, timezone
+def get_iso_timestamp(microseconds=True):
+    """自定义是否包含微秒"""
+    if microseconds:
+        return datetime.now(timezone.utc).isoformat(timespec='microseconds').replace('+00:00', 'Z')
+    else:
+        return datetime.now(timezone.utc).isoformat(timespec='seconds').replace('+00:00', 'Z')

klnote-0.1.0/klnote.egg-info/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: klnote
+Version: 0.1.0
+Summary: Stock note management tool
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+
+# KLNote
+
+股票笔记管理工具，为专注股票投资的人群设计。
+
+## 背景
+
+投资股票时，每次决策都需要记录：为什么买、为什么卖、当时想到了什么。这些记录是后续复盘的核心素材。但普通笔记软件太通用，无法围绕"股票"这个实体组织信息——查一只股票的笔记，要翻半天。
+
+KLNote 的核心思路是：**先有股票，再有笔记**。每条笔记属于某只股票，每次查看都围绕股票展开。
+
+## 核心概念
+
+- **股票**：用 code（代码）或 name（名称）标识，如 `000001`、平安银行
+- **笔记**：附属于某只股票，每条包含 summary（摘要） 和 content（内容）
+- **标识符**：支持三种方式定位股票 — UUID、股票代码、股票名称
+
+## 安装
+
+```bash
+pip install klnote
+```
+
+## 使用
+
+```bash
+# 股票操作
+klnote stk ls              # 列出所有股票
+klnote stk add 000001 -n 平安银行    # 添加股票
+klnote stk get 000001       # 查看股票（支持 id/code/name）
+klnote stk delete 000001    # 删除股票
+
+# 笔记操作
+klnote note add 000001 -s "摘要" -c "内容"   # 添加笔记
+klnote note ls 000001       # 列出笔记
+klnote note delete 000001 0 # 删除第0条笔记
+```
+
+## 数据库
+
+默认路径: `~/.KLNote/KLNote.db`
+
+可通过环境变量 `KLNOTE_DB_PATH` 自定义路径。
+
+## 命令指南
+
+### 全局命令
+
+```
+klnote --help
+```
+
+### 股票操作 (stk)
+
+```
+klnote stk ls                       # 列出所有股票
+klnote stk add <code> [-n name] [-d desc]   # 添加股票
+klnote stk get <identifier>         # 查看股票详情
+klnote stk delete <identifier>      # 删除股票
+```
+
+### 笔记操作 (note)
+
+```
+klnote note add <stock_identifier> [-s 摘要] [-c 内容]   # 添加笔记
+klnote note ls <stock_identifier>     # 列出某只股票的所有笔记
+klnote note delete <stock_identifier> <index>   # 删除指定笔记
+```
+
+### 高级操作 (admin)
+
+```
+klnote admin match_and_read <value> <field>    # 按字段匹配读取
+klnote admin match_and_update <value> <field> <update_field>   # 按字段匹配更新（危险）
+```
+
+### 标识符说明
+
+所有 `<identifier>` 位置均支持三种写法：
+
+| 格式 | 示例 | 解析方式 |
+|------|------|---------|
+| UUID (32位十六进制) | `a1b2c3d4e5f6...` | 精确匹配 id |
+| 纯数字 | `000001` | 匹配 code |
+| 字母/中文混合 | `平安银行` | 先试 code，再试 name |
+
+## 环境变量
+
+| 变量 | 说明 | 默认值 |
+|------|------|--------|
+| `KLNOTE_DB_PATH` | 数据库文件路径 | `~/.KLNote/KLNote.db` |

klnote-0.1.0/klnote.egg-info/SOURCES.txt

@@ -0,0 +1,23 @@
+README.md
+pyproject.toml
+klnote/__init__.py
+klnote/cli.py
+klnote.egg-info/PKG-INFO
+klnote.egg-info/SOURCES.txt
+klnote.egg-info/dependency_links.txt
+klnote.egg-info/entry_points.txt
+klnote.egg-info/requires.txt
+klnote.egg-info/top_level.txt
+klnote/core/__init__.py
+klnote/core/constants.py
+klnote/core/database.py
+klnote/core/exceptions.py
+klnote/core/service.py
+klnote/core/schema/__init__.py
+klnote/core/schema/schame.py
+klnote/core/utils/__init__.py
+klnote/core/utils/db.py
+klnote/core/utils/editor.py
+klnote/core/utils/time_1.py
+tests/test_cli.py
+tests/test_service.py

klnote-0.1.0/klnote.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

klnote-0.1.0/klnote.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+klnote = klnote.cli:cli

klnote-0.1.0/klnote.egg-info/requires.txt

@@ -0,0 +1,4 @@
+click>=8.0.0
+
+[dev]
+pytest>=8.0.0

klnote-0.1.0/klnote.egg-info/top_level.txt

@@ -0,0 +1 @@
+klnote

klnote-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "klnote"
+version = "0.1.0"
+description = "Stock note management tool"
+requires-python = ">=3.10"
+dependencies = [
+    "click>=8.0.0",
+]
+readme = "README.md"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+]
+
+[project.scripts]
+klnote = "klnote.cli:cli"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["klnote*"]

klnote-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

klnote-0.1.0/tests/test_cli.py

@@ -0,0 +1,20 @@
+import pytest
+from click.testing import CliRunner
+from klnote.cli import cli
+
+
+@pytest.fixture
+def runner():
+    return CliRunner()
+
+
+def test_cli_help(runner):
+    result = runner.invoke(cli, ["--help"])
+    assert result.exit_code == 0
+    assert "KLNote" in result.output
+
+
+def test_stock_ls_empty(runner):
+    result = runner.invoke(cli, ["stk", "ls"])
+    assert result.exit_code == 0
+    assert "暂无股票" in result.output

klnote-0.1.0/tests/test_service.py

@@ -0,0 +1,100 @@
+import pytest
+import os
+import tempfile
+from klnote.core.database import Database
+from klnote.core.service import Service
+
+
+@pytest.fixture
+def tmp_db():
+    path = tempfile.mktemp(suffix=".db")
+    db = Database(path)
+    yield db
+    db.conn.close()
+    try:
+        os.unlink(path)
+    except OSError:
+        pass
+
+
+@pytest.fixture
+def service(tmp_db):
+    return Service(db=tmp_db)
+
+
+class TestStock:
+    def test_add(self, service):
+        service.stock_add(code="000001", name="平安银行")
+        stocks = service.stock_list()
+        assert len(stocks) == 1
+        assert stocks[0]["code"] == "000001"
+        assert stocks[0]["name"] == "平安银行"
+
+    def test_list_empty(self, service):
+        assert service.stock_list() == []
+
+    def test_show(self, service):
+        service.stock_add(code="000001", name="平安银行")
+        stock = service.stock_show(service.stock_list()[0]["id"])
+        assert stock["code"] == "000001"
+
+    def test_delete(self, service):
+        service.stock_add(code="000001")
+        stocks = service.stock_list()
+        service.stock_delete(stocks[0]["id"])
+        assert service.stock_list() == []
+
+    def test_search_by_code(self, service):
+        service.stock_add(code="000001", name="平安银行")
+        ids = service.search(code="000001")
+        assert len(ids) == 1
+
+    def test_search_by_name(self, service):
+        service.stock_add(code="000001", name="平安银行")
+        ids = service.search(name="平安银行")
+        assert len(ids) == 1
+
+    def test_search_by_id(self, service):
+        service.stock_add(code="000001")
+        stock_id = service.stock_list()[0]["id"]
+        ids = service.search(id=stock_id)
+        assert len(ids) == 1
+        assert ids[0] == stock_id
+
+
+class TestNote:
+    def test_add(self, service):
+        service.stock_add(code="000001")
+        stock_id = service.stock_list()[0]["id"]
+        service.note_add(stock_id, content="测试内容", summary="测试摘要")
+        notes = service.note_read(stock_id)
+        assert len(notes) == 1
+        assert notes[0]["content"] == "测试内容"
+        assert notes[0]["summary"] == "测试摘要"
+
+    def test_delete(self, service):
+        service.stock_add(code="000001")
+        stock_id = service.stock_list()[0]["id"]
+        service.note_add(stock_id, content="内容1")
+        service.note_add(stock_id, content="内容2")
+        service.note_delete(stock_id, 0)
+        notes = service.note_read(stock_id)
+        assert len(notes) == 1
+        assert notes[0]["content"] == "内容2"
+
+    def test_read_empty(self, service):
+        service.stock_add(code="000001")
+        stock_id = service.stock_list()[0]["id"]
+        notes = service.note_read(stock_id)
+        assert notes == []
+
+    def test_read_by_indices(self, service):
+        service.stock_add(code="000001")
+        stock_id = service.stock_list()[0]["id"]
+        service.note_add(stock_id, content="0")
+        service.note_add(stock_id, content="1")
+        service.note_add(stock_id, content="2")
+        notes = service.note_read(stock_id, indices=[0, 2])
+        assert len(notes) == 2
+        assert notes[0]["content"] == "0"
+        assert notes[1]["content"] == "2"