Note Studio插件开源项目：增强个人知识管理-CSDN博客

本文链接：https://blog.csdn.net/weixin_35094083/article/details/141597481

简介：Note Studio插件开源项目旨在扩展NoteStudio应用程序的功能，增强其个人知识管理能力。通过Python脚本和Windows可执行文件，用户可以定制化NoteStudio，符合自己的工作流程，提升效率。该项目提供了实际应用示例，帮助用户学习Python编程，同时促进社区协作和创新。

1. Note Studio 插件开源项目简介

1. 项目概述

Note Studio 是一个开源的插件项目，旨在为流行的笔记软件 Obsidian 提供 GTD（Getting Things Done）功能。该项目由来自不同背景的开发人员和用户共同维护，致力于为 Obsidian 用户提供高效的个人任务管理解决方案。

2. GTD Plugin Config.ini 配置文件

2.1 配置文件结构

GTD Plugin Config.ini 配置文件是一个文本文件，用于存储插件的配置设置。它通常位于插件安装目录的根目录中。配置文件包含多个部分，每个部分包含一组相关的设置。

2.2 配置文件参数

配置文件包含以下部分和参数：

[General]
plugin_version : 插件版本号
default_task_list : 默认任务列表名称
default_context : 默认上下文名称
default_priority : 默认优先级
[Actions]
actions_list_file : 动作列表文件的路径
actions_list_format : 动作列表文件的格式（CSV 或 JSON）
actions_list_delimiter : 动作列表文件中的分隔符（对于 CSV 文件）
[Contexts]
contexts_file : 上下文文件的路径
contexts_format : 上下文文件的格式（CSV 或 JSON）
contexts_delimiter : 上下文文件中的分隔符（对于 CSV 文件）
[Projects]
projects_file : 项目文件的路径
projects_format : 项目文件的格式（CSV 或 JSON）
projects_delimiter : 项目文件中的分隔符（对于 CSV 文件）
[Priorities]
priorities_file : 优先级文件的路径
priorities_format : 优先级文件的格式（CSV 或 JSON）
priorities_delimiter : 优先级文件中的分隔符（对于 CSV 文件）

2.3 配置文件示例

以下是一个示例配置文件：

[General]
plugin_version=1.0
default_task_list=Inbox
default_context=Home
default_priority=Medium

[Actions]
actions_list_file=actions.csv
actions_list_format=CSV
actions_list_delimiter=,

[Contexts]
contexts_file=contexts.csv
contexts_format=CSV
contexts_delimiter=,

[Projects]
projects_file=projects.csv
projects_format=CSV
projects_delimiter=,

[Priorities]
priorities_file=priorities.csv
priorities_format=CSV
priorities_delimiter=,

2.4 配置文件解析

插件在启动时解析配置文件，并将其设置加载到内存中。这些设置用于配置插件的行为，例如默认任务列表、上下文和优先级。

2.5 配置文件修改

用户可以修改配置文件以自定义插件的行为。例如，用户可以更改默认任务列表、添加新的上下文或更改优先级顺序。但是，用户必须小心修改配置文件，因为错误的配置可能会导致插件无法正常工作。

3. create_actions_list.py Python 脚本

3.1 脚本概述

create_actions_list.py 脚本是 Note Studio GTD 插件中一个重要的组成部分，它负责从 Note Studio 中提取待办事项并将其转换为符合 GTD 方法的格式。该脚本提供了多种自定义选项，允许用户根据自己的喜好调整待办事项列表。

3.2 脚本参数

该脚本接受以下参数：

| 参数 | 描述 | 默认值 | |---|---|---| | -i | 输入文件 | actions.txt | | -o | 输出文件 | actions_list.txt | | -f | 过滤条件 | all | | -s | 排序方式 | priority | | -d | 日期格式 | %Y-%m-%d | | -c | 完成标志 | x | | -h | 帮助信息 | 无 |

3.3 脚本逻辑

该脚本的逻辑如下：

读取输入文件 actions.txt 。
过滤待办事项，根据 -f 参数指定条件（例如，仅显示未完成的待办事项）。
根据 -s 参数指定条件对待办事项进行排序（例如，按优先级排序）。
将待办事项转换为 GTD 格式，包括以下字段：
优先级
上下文
项目
截止日期
完成标志
将转换后的待办事项写入输出文件 actions_list.txt 。

3.4 代码示例

以下代码示例展示了如何使用 create_actions_list.py 脚本：

import sys
import os

def main():
    # 获取脚本参数
    args = sys.argv[1:]
    input_file = args[args.index('-i') + 1]
    output_file = args[args.index('-o') + 1]
    filter = args[args.index('-f') + 1]
    sort = args[args.index('-s') + 1]
    date_format = args[args.index('-d') + 1]
    completion_flag = args[args.index('-c') + 1]

    # 读取输入文件
    with open(input_file, 'r') as f:
        actions = f.readlines()

    # 过滤待办事项
    if filter == 'completed':
        actions = [action for action in actions if completion_flag in action]
    elif filter == 'uncompleted':
        actions = [action for action in actions if completion_flag not in action]

    # 排序待办事项
    if sort == 'priority':
        actions.sort(key=lambda action: action[0])
    elif sort == 'context':
        actions.sort(key=lambda action: action[1])
    elif sort == 'project':
        actions.sort(key=lambda action: action[2])
    elif sort == 'due date':
        actions.sort(key=lambda action: action[3])

    # 转换为 GTD 格式
    actions_list = []
    for action in actions:
        priority, context, project, due_date, completed = action.split(',')
        actions_list.append({
            'priority': priority,
            'context': context,
            'project': project,
            'due_date': due_date,
            'completed': completed
        })

    # 写入输出文件
    with open(output_file, 'w') as f:
        for action in actions_list:
            f.write(','.join([action['priority'], action['context'], action['project'], action['due_date'], action['completed']]) + '\n')

if __name__ == '__main__':
    main()

3.5 脚本应用

create_actions_list.py 脚本可用于以下应用场景：

从 Note Studio 中提取待办事项并将其转换为 GTD 格式。
根据用户自定义的过滤和排序条件定制待办事项列表。
将待办事项列表导出到其他应用程序或服务中。

4. readme.txt 项目说明文件

readme.txt 文件是 Note Studio 插件开源项目的说明文件，它提供了有关项目目的、安装、使用和贡献的宝贵信息。

4.1 项目简介

readme.txt 文件的开头部分概述了 Note Studio 插件开源项目的目的是帮助用户通过 GTD 方法管理任务和项目。它强调了该插件与 Note Studio 集成的优势，以及它如何增强应用程序的功能。

4.2 安装说明

readme.txt 文件提供了详细的安装说明，指导用户如何将 Note Studio 插件添加到他们的 Note Studio 安装中。说明包括下载插件文件、将其复制到适当的目录以及配置 Note Studio 以识别和使用插件的步骤。

4.3 使用指南

readme.txt 文件包含了使用 Note Studio 插件的指南。它介绍了插件的界面、功能和工作流程。指南还提供了有关如何创建和管理任务、项目和上下文的信息，以及如何使用插件的其他功能。

4.4 贡献指南

readme.txt 文件鼓励用户为 Note Studio 插件开源项目做出贡献。它提供了有关如何报告问题、提交功能请求和提交代码更改的指南。指南还强调了社区协作和创新在项目发展中的重要性。

4.5 许可证信息

readme.txt 文件包含有关 Note Studio 插件开源项目许可证的信息。它指定了项目受哪个许可证的约束，并概述了用户使用和分发插件的条款和条件。

4.6 联系信息

readme.txt 文件提供了联系项目维护者和社区成员的信息。它包括电子邮件地址、社交媒体链接和讨论论坛，用户可以在其中获得支持、提出问题和参与社区讨论。

5. Python 编程应用示例

5.1 create_actions_list.py 脚本解析

5.1.1 脚本功能简介

create_actions_list.py 脚本是 Note Studio GTD 插件中一个重要的工具，它用于从文本文件中提取操作项并将其添加到 Note Studio 数据库中。该脚本允许用户轻松地将待办事项列表导入 GTD 插件，从而简化任务管理流程。

5.1.2 脚本参数

该脚本接受以下参数：

| 参数 | 描述 | |---|---| | -f | 输入文本文件路径 | | -d | Note Studio 数据库路径 | | -t | 操作项类型（可选，默认为 "Task"） |

5.1.3 脚本逻辑分析

该脚本的逻辑流程如下：

解析命令行参数。
打开输入文本文件和 Note Studio 数据库。
逐行读取文本文件，提取操作项文本。
根据操作项类型（ Task 、 Project 或 Context ）创建相应的 Note Studio 对象。
将对象添加到 Note Studio 数据库。
关闭输入文本文件和 Note Studio 数据库。

5.1.4 代码示例

import argparse
import os

from note_studio_gtd.database import Database
from note_studio_gtd.models import Task, Project, Context

def main():
    # 解析命令行参数
    parser = argparse.ArgumentParser()
    parser.add_argument("-f", "--file", help="输入文本文件路径")
    parser.add_argument("-d", "--database", help="Note Studio 数据库路径")
    parser.add_argument("-t", "--type", help="操作项类型（可选，默认为 \"Task\"）")
    args = parser.parse_args()

    # 打开输入文本文件和 Note Studio 数据库
    with open(args.file, "r") as f:
        with Database(args.database) as db:
            # 逐行读取文本文件，提取操作项文本
            for line in f:
                action_text = line.strip()

                # 根据操作项类型创建相应的 Note Studio 对象
                if args.type == "Task":
                    action = Task(action_text)
                elif args.type == "Project":
                    action = Project(action_text)
                elif args.type == "Context":
                    action = Context(action_text)
                else:
                    action = Task(action_text)

                # 将对象添加到 Note Studio 数据库
                db.add(action)

# 脚本入口
if __name__ == "__main__":
    main()