Pensieve项目教程

Pensieve项目教程

pensieve A passive recording project allows you to have complete control over your data. Automatically take screenshots of all your screens, index them, and save them locally. 项目地址: https://gitcode.com/gh_mirrors/pen/pensieve

1. 项目目录结构及介绍

Pensieve项目的目录结构如下：

pensieve/
├── .github/
├── docs/
├── memos/
│   ├── __init__.py
│   ├── app.py
│   ├── models.py
│   ├── forms.py
│   ├── tasks.py
│   └── utils.py
├── memos_ml_backends/
├── screen_recorder/
├── web/
│   ├── static/
│   ├── templates/
│   └── __init__.py
├── .gitignore
├── LICENSE
├── README.md
├── README.pypi.md
├── README_JP.md
├── README_ZH.md
├── build_executable.py
├── create_pensiev_toml.py
├── memos_app.py
├── pypi_md_generator.py
├── pyproject.toml
├── run_pg.sh
└── ...

• .github/: 存放与GitHub相关的配置文件，如issue模板等。
• docs/: 项目文档的存放位置。
• memos/: 核心应用代码目录，包含初始化文件、应用主体、模型、表单、任务和工具函数等。
• memos_ml_backends/: 机器学习后端相关的代码。
• screen_recorder/: 屏幕录制功能相关的代码。
• web/: 网页界面相关的静态文件和模板。
• .gitignore: 定义Git应该忽略的文件和目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文件，包含项目的简介、安装和使用方法等。
• README.pypi.md, README_JP.md, README_ZH.md: 项目的不同语言的说明文件。
• build_executable.py: 用于构建可执行文件的脚本。
• create_pensiev_toml.py: 用于创建Pensieve配置文件的脚本。
• memos_app.py: 应用的主入口文件。
• pypi_md_generator.py: 用于生成PyPI项目描述的脚本。
• pyproject.toml: 项目元数据和依赖关系的配置文件。
• run_pg.sh: 用于运行PostgreSQL的脚本。

2. 项目的启动文件介绍

项目的启动文件是memos_app.py。这个文件负责初始化应用、设置配置、连接数据库以及启动Web服务。

# memos_app.py 的简化代码示例

from flask import Flask
from memos import create_app

app = create_app()

if __name__ == "__main__":
    app.run()

在这个文件中，首先从flask库导入Flask类，然后从项目的memos模块中调用create_app函数来创建一个Flask应用实例。最后，如果该文件作为主程序运行，它将启动Flask内置的服务器。

3. 项目的配置文件介绍

项目的配置文件是pyproject.toml，它定义了项目的元数据以及依赖关系。以下是一个配置文件的示例：

[build-system]
requires = ["setuptools", "wheel"]

[tool.setuptools]
packages = find:
python-requires = ">=3.7"
install-requires = [
    "Flask",
    "SQLAlchemy",
    ...
]

[project]
name = "Pensieve"
version = "0.26.0"
description = "A privacy-focused passive recording project"
authors = ["Arkohut"]
license = { file = "LICENSE" }
readme = "README.md"
requires-python = ">=3.7"
classifiers = [
    "Programming Language :: Python :: 3",
    ...
]

在这个配置文件中，定义了如下内容：

• 项目的构建系统需要的依赖。
• setuptools工具的配置，包括自动发现项目包、Python版本要求、安装依赖等。
• 项目的元数据，包括名称、版本、描述、作者、许可证、自述文件、Python版本要求以及项目分类等。

这个文件是项目打包和分发的重要部分，确保了项目可以在不同的环境中正确安装和运行。

pensieve A passive recording project allows you to have complete control over your data. Automatically take screenshots of all your screens, index them, and save them locally. 项目地址: https://gitcode.com/gh_mirrors/pen/pensieve