RecoverPy 项目教程

RecoverPy 项目教程

RecoverPyInteractively find and recover deleted or :point_right: overwritten :point_left: files from your terminal项目地址:https://gitcode.com/gh_mirrors/re/RecoverPy

目录结构及介绍

RecoverPy 项目的目录结构如下：

RecoverPy/
├── docs/
│   └── assets/
├── recoverpy/
├── tests/
├── flake8
├── .gitignore
├── .pre-commit-config.yaml
├── .whitesource
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── poetry.lock
└── pyproject.toml

主要目录和文件介绍

• docs/: 包含项目文档的资源文件。
• recoverpy/: 项目的主要代码目录。
• tests/: 包含项目的测试代码。
• flake8: 用于代码风格检查的配置文件。
• .gitignore: Git 忽略文件配置。
• .pre-commit-config.yaml: 预提交钩子配置文件。
• .whitesource: Whitesource 配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证（GPL-3.0）。
• README.md: 项目说明文档。
• poetry.lock: Poetry 依赖锁定文件。
• pyproject.toml: 项目配置文件。

项目的启动文件介绍

RecoverPy 项目的启动文件位于 recoverpy/ 目录下。主要的启动文件是 recoverpy/__main__.py，该文件负责启动整个应用程序。

# recoverpy/__main__.py
from recoverpy import main

if __name__ == "__main__":
    main()

项目的配置文件介绍

RecoverPy 项目的配置文件主要是 pyproject.toml，该文件使用 Poetry 进行依赖管理和项目配置。

[tool.poetry]
name = "recoverpy"
version = "1.0.3"
description = "Interactively find and recover deleted or overwritten files from your terminal"
authors = ["PabloLec"]
license = "GPL-3.0"

[tool.poetry.dependencies]
python = "^3.6"

[tool.poetry.dev-dependencies]
pytest = "^5.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

主要配置项

• [tool.poetry]: 项目的基本信息，包括名称、版本、描述、作者和许可证。
• [tool.poetry.dependencies]: 项目的主要依赖。
• [tool.poetry.dev-dependencies]: 开发依赖。
• [build-system]: 构建系统的要求和后端。

以上是 RecoverPy 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

RecoverPyInteractively find and recover deleted or :point_right: overwritten :point_left: files from your terminal项目地址:https://gitcode.com/gh_mirrors/re/RecoverPy