anipy-cli 项目安装与使用教程

anipy-cli 项目安装与使用教程

anipy-cli Little tool in python to watch and download anime from the terminal (the better way to watch anime). Also applicable as an API 项目地址: https://gitcode.com/gh_mirrors/an/anipy-cli

1. 项目目录结构及介绍

anipy-cli 项目的目录结构如下：

anipy-cli/
├── api/
├── cli/
├── docs/
├── scripts/
├── .envrc
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── flake.lock
├── flake.nix
├── mkdocs.yml
├── poetry.lock
├── pyproject.toml
└── shell.nix

目录结构介绍

• api/: 包含项目的 API 相关代码。
• cli/: 包含命令行界面（CLI）的实现代码。
• docs/: 包含项目的文档文件。
• scripts/: 包含一些辅助脚本。
• .envrc: 环境配置文件。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• flake.lock: Nix 包管理器的锁定文件。
• flake.nix: Nix 包管理器的配置文件。
• mkdocs.yml: MkDocs 文档生成器的配置文件。
• poetry.lock: Poetry 包管理器的锁定文件。
• pyproject.toml: Poetry 包管理器的配置文件。
• shell.nix: Nix 包管理器的 shell 配置文件。

2. 项目的启动文件介绍

anipy-cli 项目的启动文件是 cli/main.py。这个文件是整个项目的入口点，负责处理命令行参数并启动相应的功能模块。

启动文件介绍

• cli/main.py: 这是项目的启动文件，包含了主要的命令行逻辑。用户通过命令行输入的参数会在这里被解析和处理，然后调用相应的功能模块。

3. 项目的配置文件介绍

anipy-cli 项目的配置文件是 config.yaml。这个文件包含了项目的各种配置选项，用户可以根据需要修改这些配置来定制项目的行为。

配置文件介绍

• config.yaml: 项目的配置文件，包含了以下配置选项：
  • video_quality: 视频质量设置，支持 best、worst 或具体的分辨率（如 360、720 等）。
  • download_location: 下载文件的存储路径。
  • player: 视频播放器的路径或名称。
  • auto_update: 是否自动更新。
  • discord_presence: 是否启用 Discord 状态显示。

通过修改 config.yaml 文件，用户可以自定义 anipy-cli 的行为，以满足个人需求。

anipy-cli Little tool in python to watch and download anime from the terminal (the better way to watch anime). Also applicable as an API 项目地址: https://gitcode.com/gh_mirrors/an/anipy-cli