Waka-Readme-Stats 项目教程

Waka-Readme-Stats 项目教程

waka-readme-statsThis GitHub action helps to add cool dev metrics to your github profile Readme项目地址:https://gitcode.com/gh_mirrors/wa/waka-readme-stats

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

waka-readme-stats/
├── .github/
│   └── workflows/
│       └── waka-readme.yml
├── .gitignore
├── LICENSE
├── README.md
├── app.py
├── config.yml
├── requirements.txt
└── utils/
    └── stats.py

• .github/workflows/waka-readme.yml: GitHub Actions 的工作流配置文件，用于自动化更新 README.md。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的开源许可证。
• README.md: 项目的主要说明文档。
• app.py: 项目的启动文件。
• config.yml: 项目的配置文件。
• requirements.txt: 项目依赖的 Python 包列表。
• utils/stats.py: 包含生成统计数据的相关函数。

2. 项目的启动文件介绍

app.py 是项目的启动文件，主要负责读取配置、调用统计函数并更新 README.md 文件。以下是 app.py 的主要代码结构：

import yaml
from utils.stats import get_stats

def main():
    with open('config.yml', 'r') as file:
        config = yaml.safe_load(file)
    
    stats = get_stats(config)
    update_readme(stats)

def update_readme(stats):
    # 更新 README.md 的逻辑
    pass

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

config.yml 是项目的配置文件，包含必要的配置项，如 WakaTime API 密钥、GitHub 用户名等。以下是一个示例配置文件的内容：

wakatime:
  api_key: "your_wakatime_api_key"
github:
  username: "your_github_username"

• wakatime.api_key: 你的 WakaTime API 密钥，用于获取编程统计数据。
• github.username: 你的 GitHub 用户名，用于更新 README.md 文件。

通过以上配置，项目可以自动获取你的编程统计数据并更新到你的 GitHub 仓库的 README.md 文件中。

waka-readme-statsThis GitHub action helps to add cool dev metrics to your github profile Readme项目地址:https://gitcode.com/gh_mirrors/wa/waka-readme-stats