Github-Readme-Stats 简明教程|天天快播
时间:2023-07-04 16:34:55来源:博客园
1. 更新 Readme 文件

在你想要放置 Readme-WakaTime 的位置中放置以下注释,这将作为程序的入口


(相关资料图)

2. 注册 WakaTime 账户

访问 WakaTime 官方网站注册并登录,你需要找到对应的 IDE/编辑器 插件,目前(2023.7.3)官方插件支持以下软件

3. 在工作软件中安装 WakaTime 插件

本篇教程以 VS Code 为例

在 VS Code 主界面按下 Ctrl+Shift+P调出命令面板,输入Install,选择Install Extension选项并回车

之后在扩展界面中输入 WakaTime并安装该插件

安装完成之后,再次按下 Ctrl+Shift+P调出命令面板,输入 WakaTime api并回车在浏览器中打开WakaTime的账户设置页面 Settings | Account - WakaTime,找到 Secret API Key选项复制API复制的 API key 粘贴到 VS Code 里,按下回车完成设置在 VS Code 中写入一些代码,观察插件是否能够正常工作。同时打开 Plugin Status - WakaTime 查看插件状态(图中的New Cli Version available是正常的,也代表插件正常工作,只是提醒你插件版本需要更新)4. 配置 WakaTime API Key 和 Github 访问令牌在你的个人仓库中点击 Settings\(\rightarrow\)Secretes and variables\(\rightarrow\)New repository secret填入 WakaTime 的 API Key,设置完成后点击 Add Secret,设置完成后如第二张图所示点击你的 Github头像 调出侧边栏点击 Settings在页面中往下滑,找到 Developer Settings在 Developer Settings 页面中找到 Persional access tokens\(\rightarrow\)点击 Tokens(classic)\(\rightarrow\)点击Generate a personal access token简单填写一下相关信息,勾选权限 repo和user,并设置令牌过期时间(建议>30天),设置好后就点击 Generate Token生成访问令牌访问令牌已经生成好了,我们把它复制下来备用之后再次回到个人主页的仓库设置,还是一样,新建一个仓库密钥填入我们刚才申请的 Github 个人访问令牌,配置好后点击 Add Secret

配置好后这样的,如图所示

5. 配置 Actions进入个人主页仓库,切换为英文键盘并按下英文输入状态下的句号,即可唤起Github远程VS Code 工作流如果访问成功,你会看到如下界面在工作目录下点击新建文件夹,建立一个 .github/workflows结构的文件夹在 workflows文件夹下新建一个yml文件,注意不要建错了,很多人都会建错将模板写入文件里
name: Waka Readmeon:  schedule:    # Runs at 12am IST    - cron: "30 18 * * *"  workflow_dispatch:jobs:  update-readme:    name: Update Readme with Metrics    runs-on: ubuntu-latest    steps:      - uses: anmol098/waka-readme-stats@master        with:          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}          GH_TOKEN: ${{ secrets.GH_TOKEN }}
之后在 Git 中提交更改,点击 Commit&Push

如果出现该对话框,那么请点击Pull后再次Commit&Push

之后到仓库的 Actions 中查看文件的上传结果,如图所示,文件成功上传到仓库中之后我们需要在 workflow中 手动运行yml文件,如图所示。点击\(\rightarrow\)WakaReadme\(\rightarrow\)点击右侧的Run workflow\(\rightarrow\)点击Run workflow刷新浏览器,执行完毕后会出现一个蓝色的\(\checkmark\)

注:如果出现如下错误,那么你需要检查README.md文件是否写入了那两行注释,错误信息如下

File "/waka-readme-stats/main.py", line 221, in [29](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:30) run(main())[30](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:31) File "/usr/local/lib/python3.11/asyncio/runners.py", line 190, in run[31](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:32) return runner.run(main)[32](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:33) ^^^^^^^^^^^^^^^^[33](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:34) File "/usr/local/lib/python3.11/asyncio/runners.py", line 118, in run[34](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:35) return self._loop.run_until_complete(task)[35](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:36) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[36](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:37) File "/usr/local/lib/python3.11/asyncio/base_events.py", line 653, in run_until_complete[37](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:38) return future.result()[38](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:39) ^^^^^^^^^^^^^^^[39](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:40) File "/waka-readme-stats/main.py", line 208, in main[40](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:41) stats = await get_stats()[41](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:42) ^^^^^^^^^^^^^^^^^[42](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:43) File "/waka-readme-stats/main.py", line 163, in get_stats[43](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:44) data = await DM.get_remote_json("waka_all")[44](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:45) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[45](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:46) File "/waka-readme-stats/manager_download.py", line 202, in get_remote_json[46](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:47) return await DownloadManager._get_remote_resource(resource, None)[47](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:48) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[48](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:49) File "/waka-readme-stats/manager_download.py", line 193, in _get_remote_resource[49](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:50) raise Exception(f"Query "{res.url}" failed to run by returning code of {res.status_code}: {res.json()}")[50](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:51)Exception: Query "[https://wakatime.com/api/v1/users/current/all_time_since_today?api_key=***](https://wakatime.com/api/v1/users/current/all_time_since_today?api_key=***)" failed to run by returning code of 202: {"data": {"is_up_to_date": False, "range": {"start": "2023-07-01T16:00:00Z", "start_date": "2023-07-02", "start_text": "Yesterday", "end": "2023-07-03T15:59:59Z", "end_date": "2023-07-03", "end_text": "Today", "timezone": "Asia/Shanghai"}, "timeout": 15, "percent_calculated": 0, "total_seconds": 0, "text": "0 secs", "decimal": "0.00", "digital": "0:00"}, "message": "Calculating stats for this user. Check back later."}[51](https://github.com/MagicCD/MagicCD/actions/runs/5444806464/jobs/9903159455#step:3:52)sys:1: RuntimeWarning: coroutine "AsyncClient.get" was never awaited

解决方法:在README.md文件中的合适位置写入这两行注释

设置完成并执行成功后,回到你的个人仓库主页,你就会发现!我去,真甜蜜炫酷啊啊啊啊啊!!!!对不起,请允许我发电一下(深情~:D)

至此,所有的设置我们都做完了。如果你想对这些进行扩展,那么你可以参考我翻译的文档,里面记录了各个标志字段的作用和显示与否,也欢迎专业翻译人员对文档翻译进行语言改进,非常感谢!

翻译文档地址

WakaTime Readme Stats-开源项目翻译 - sarexpine - 博客园 (cnblogs.com)

标签:

生活指南
  • 两台苹果手机如何同步通讯录?怎么把两个苹果手机的数据同步?

    两台苹果手机如何同步通讯录?同步两台苹果手机的通讯录方法:1 使

  • 茶文化遇到高科技,西城区建设“马连道•茶•中国数据街”

    北京日报客户端|记者张骜方非通讯员杜颖7月3日,2023全球数字经济大会

  • 假日暖洋洋2孔令麒爸是好是坏?假日暖洋洋2剧情介绍

    假日暖洋洋2孔令麒爸是好是坏:孔令麒爸曾经是一个温馨的家庭,但父

  • 当前时讯:带圆圈的数字11 怎么打?圈里带数字的序号怎么复制?

    带圆圈的数字11 怎么打?1 打开Word空白文档,输入数字11。 2 选中

  • 唐山八中录取分数线2019_唐山八中录取分数线 每日视点

    1、唐山一中:公助生560分,择校生554分。2、唐山二中:公助生542分,

  • 《幽灵诡计幻影侦探》诡异密室之谜成就攻略 诡异密室之谜怎么解锁?

    诡异密室之谜是幽灵诡计幻影侦探需要收集的成就之一,想要解锁这个成就

  • 蓉港直达高铁开通 将给四川带来哪些发展机遇? 快资讯

    蓉港直达高铁开通将给四川带来哪些发展机遇?戴宾介绍,香港一直是四川

  • 唯美文学专家为你带来的热门生日祝福语-每日短讯

    祝福幸福快乐。亲爱的XXX,在这个特殊的日子里,愿你拥有一个充满欢

  • 公文的页眉页脚设置(页眉页脚设置)

    导读1、具体步骤如下:首先在电脑中打开所要设置的excel表,点击菜单栏

  • 「中国财富报道」27.77万亿元!历史新高

    6月29日,中国基金业协会公布2023年5月公募基金市场数据。数据显示,截

  • 今日热讯:一个月怎么理财?短期理财要怎么买比较好?

    一个月怎么理财?如果资金只闲置一个月的话,那么可以采用以下几种方

  • 每日快讯!新铁锅用之前做什么处理才耐用_新铁锅使用前的妙招

    1、我们买新锅的时候,一定要先在里外涂上一层洗洁精,再用抹布仔细擦

  • 讯息:6月28日金象珠宝黄金570元/克 相比昨日下跌了3元/克

    2023年6月28日,实物黄金金象珠宝黄金报价570元 克,相比上一个交易日

  • 英典&秋禾俪人||2023全国代理商年中总结会暨新产品新技术研讨会隆重开幕! 环球新消息

    2023年6月27日,这是一个特别的日子,这一天,我们英典&秋禾俪人所

  • 从L2到L2.9,我们和L3的距离就像是拼多多的“最后一刀”_今日最新

    在星爷的电影《国产凌凌漆》里面,有这样一个名场面。达文西发明了一个

  • 百胜这个平台是做什么的 百胜yum统一认证平台 观察

    1、win10附带edge和IE两种浏览器,它们两个以及本地视频、游戏都用系统

  • 民生
    • 信用卡数量限制是多少?信用卡不要超过几张?

    • 环球微速讯:新时代中国调研行·长江篇丨呵护“微笑天使”——长江鄂皖赣段打造江豚“最佳栖息地”

    • 余额宝收益怎么算?余额宝存100元一天多少钱? 每日看点

    • 环球微速讯:庆祝香港回归祖国26周年 深港学校校长体育交流活动举行