Please CLI 项目安装与使用教程

Please CLI 项目安装与使用教程

please 🙏 Please CLI - Minimalistic New Tab Page CLI Tool with a greeting, date and time, inspirational quotes and your personal tasks and to-do list 项目地址: https://gitcode.com/gh_mirrors/ple/please

1. 项目目录结构及介绍

please/
├── dist/
├── please/
│   ├── __init__.py
│   ├── please.py
│   └── tests/
│       ├── __init__.py
│       └── test_please.py
├── .gitignore
├── LICENSE.md
├── README.md
├── illustration1.jpg
├── please.gif
├── poetry.lock
├── pyproject.toml

目录结构说明

• dist/: 存放构建的WHL包文件。
• please/: 项目的主要代码目录，包含启动文件please.py和测试文件。
• tests/: 包含项目的测试文件。
• .gitignore: Git忽略文件配置。
• LICENSE.md: 项目许可证文件。
• README.md: 项目说明文件。
• illustration1.jpg: 项目插图文件。
• please.gif: 项目演示GIF文件。
• poetry.lock: Poetry依赖锁定文件。
• pyproject.toml: Poetry项目配置文件。

2. 项目启动文件介绍

please/please.py

这是项目的启动文件，负责显示问候语、日期时间、激励性引言以及个人任务和待办事项列表。以下是该文件的主要功能：

• 显示时间、引言和任务: 每次打开终端时，显示格式化的问候语、日期时间、激励性引言以及个人任务和待办事项列表。
• 添加任务: 通过命令please add "TASK NAME"添加新任务。
• 删除任务: 通过命令please delete <TASK NUMBER>删除指定任务。
• 标记任务完成: 通过命令please do <TASK NUMBER>标记任务为已完成。
• 编辑任务名称: 通过命令please edit <TASK NUMBER> <NEW NAME>编辑任务名称。
• 显示所有任务: 通过命令please showtasks显示所有任务，即使所有任务都已标记为完成。
• 移动任务位置: 通过命令please move <OLD NUMBER> <NEW NUMBER>移动任务到指定位置。
• 切换时间格式: 通过命令please changetimeformat在24小时和12小时格式之间切换。
• 更改用户名: 通过命令please callme "NAME"更改用户名。
• 清理已完成任务: 通过命令please clean删除所有已完成的任务。
• 重置所有设置和任务: 通过命令please setup重置所有设置和任务。

3. 项目配置文件介绍

config/please/config.json

该配置文件位于用户主目录下的config/please文件夹中，用于自定义please CLI的输出。以下是配置文件的主要选项：

• diable_greeting: 是否禁用问候语。默认值为false，设置为true可禁用问候语。
• diable_line: 是否禁用水平线。默认值为false，设置为true可禁用水平线。
• diable_quotes: 是否禁用引言。默认值为false，设置为true可禁用引言。

配置文件示例

{
    "diable_greeting": false,
    "diable_line": false,
    "diable_quotes": false
}

通过修改这些配置项，用户可以自定义please CLI的输出内容，以满足个人需求。

please 🙏 Please CLI - Minimalistic New Tab Page CLI Tool with a greeting, date and time, inspirational quotes and your personal tasks and to-do list 项目地址: https://gitcode.com/gh_mirrors/ple/please