StickyNotes 开源项目使用教程

StickyNotes 开源项目使用教程

StickyNotes一个便捷的Windows桌面便利贴/A convenitent Windows Notes 项目地址:https://gitcode.com/gh_mirrors/st/StickyNotes

1. 项目的目录结构及介绍

StickyNotes/
├── README.md
├── src/
│   ├── main.py
│   ├── config.py
│   ├── notes/
│   │   ├── __init__.py
│   │   ├── note.py
│   │   ├── manager.py
│   ├── ui/
│   │   ├── __init__.py
│   │   ├── main_window.py
│   │   ├── note_widget.py
├── tests/
│   ├── __init__.py
│   ├── test_note.py
│   ├── test_manager.py
├── requirements.txt

• README.md: 项目说明文件。
• src/: 源代码目录。
  • main.py: 项目启动文件。
  • config.py: 配置文件。
  • notes/: 笔记管理模块。
    • note.py: 笔记类定义。
    • manager.py: 笔记管理类。
  • ui/: 用户界面模块。
    • main_window.py: 主窗口类。
    • note_widget.py: 笔记显示组件类。
• tests/: 测试代码目录。
  • test_note.py: 笔记类测试。
  • test_manager.py: 笔记管理类测试。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

src/main.py 是项目的启动文件，负责初始化应用并启动主界面。以下是 main.py 的主要内容：

import sys
from PyQt5.QtWidgets import QApplication
from ui.main_window import MainWindow

def main():
    app = QApplication(sys.argv)
    window = MainWindow()
    window.show()
    sys.exit(app.exec_())

if __name__ == "__main__":
    main()

• QApplication: 初始化 PyQt5 应用。
• MainWindow: 创建主窗口实例。
• window.show(): 显示主窗口。
• sys.exit(app.exec_()): 启动应用主循环。

3. 项目的配置文件介绍

src/config.py 是项目的配置文件，包含应用的配置信息。以下是 config.py 的主要内容：

class Config:
    NOTE_SAVE_PATH = 'data/notes.json'
    DEFAULT_NOTE_COLOR = '#ffffff'
    DEFAULT_NOTE_SIZE = (200, 200)

config = Config()

• NOTE_SAVE_PATH: 笔记保存路径。
• DEFAULT_NOTE_COLOR: 默认笔记颜色。
• DEFAULT_NOTE_SIZE: 默认笔记大小。

通过这些配置，可以方便地修改应用的行为和外观。

StickyNotes一个便捷的Windows桌面便利贴/A convenitent Windows Notes 项目地址:https://gitcode.com/gh_mirrors/st/StickyNotes