cf-stats 项目使用教程

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

cf-stats/
├── github/
│   └── workflows/
├── app/
├── assets/
├── config/
├── docs/
├── output/
├── template/
├── tests/
├── .gitignore
├── LICENSE
├── Pipfile
├── Pipfile.lock
├── README.md
├── pyproject.toml
├── requirements.txt
└── setup.cfg

• github/workflows/: 包含 GitHub Actions 的工作流文件，用于自动化生成统计卡片。
• app/: 应用程序的主要代码文件夹。
• assets/: 项目所需的静态资源文件。
• config/: 配置文件夹，包含项目的配置文件。
• docs/: 项目文档文件夹。
• output/: 生成的统计卡片输出文件夹。
• template/: 模板文件夹，包含用于生成统计卡片的模板文件。
• tests/: 测试文件夹，包含项目的测试代码。
• .gitignore: Git 忽略文件，指定哪些文件或文件夹不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件。
• Pipfile: Pipenv 的依赖管理文件。
• Pipfile.lock: Pipenv 的锁定文件，包含所有依赖的精确版本。
• README.md: 项目的说明文档。
• pyproject.toml: Python 项目的配置文件。
• requirements.txt: 项目的依赖列表。
• setup.cfg: 项目的配置文件。

2. 项目的启动文件介绍

项目的主要启动文件位于 github/workflows/ 目录下。这些文件定义了 GitHub Actions 的工作流，用于自动化生成 Codeforces 的统计卡片。

• github/workflows/main.yml: 定义了 GitHub Actions 的工作流，包括如何触发工作流、如何安装依赖、如何运行生成统计卡片的脚本等。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下。

• config/env_template: 这是一个模板文件，用于配置 Codeforces 的用户名。你需要将 CF_HANDLE 键的值替换为你的 Codeforces 用户名。

CF_HANDLE=your_codeforces_handle

• setup.cfg: 项目的配置文件，包含项目的元数据和配置信息。

[metadata]
name = cf-stats
version = 0.1.0
description = A github action based realtime Codeforces activity statistics card and badge generator for github readme
author = sudiptob2
license = GPL-3.0

[options]
packages = find:
include_package_data = True

通过以上配置文件，你可以自定义项目的运行环境和生成统计卡片的用户信息。