Project Icon

github-stats

GitHub统计数据自动可视化工具

GitHub Stats Visualization是一个开源项目,可自动生成GitHub用户和仓库的统计数据图表。该工具利用GitHub Actions运行,无需额外服务器即可定期更新数据。它能够展示包括私有仓库在内的全面统计信息,支持明暗主题自动切换。用户通过个人访问令牌可获取私有仓库数据,从而在GitHub个人资料中展示更完整的贡献信息。这个项目为开发者提供了一种简便方法来可视化展示其GitHub活动统计。

GitHub 统计可视化

使用 GitHub Actions 生成 GitHub 用户和仓库统计的可视化。可视化内容可以包括私有仓库的数据,以及您贡献但不拥有的仓库数据。

生成的图像会自动在 GitHub 浅色主题和深色主题之间切换。

背景

当有人查看 GitHub 上的个人资料时,通常是因为他们对该用户的开源项目和贡献感兴趣。遗憾的是,用户的星标、分支和置顶仓库并不一定反映他们对私有仓库的贡献。同样,这些数据也无法全面展示用户在当前年度之外的总体贡献。

本项目旨在使用 GitHub API 收集各种个人资料和仓库统计数据。然后生成可以在仓库 README 或用户的个人资料 README 中显示的图像。

由于项目在 GitHub Actions 上运行,无需服务器即可定期重新生成带有更新统计数据的图像。同样,由于用户通过 GitHub Actions 自行运行分析代码,他们可以使用自己的 GitHub 访问令牌来收集外部服务无法访问的私有仓库的统计数据。

免责声明

如果项目使用具有足够权限读取私有仓库的访问令牌,可能会在错误消息中泄露这些仓库的详细信息。例如,用于异步 API 请求的 aiohttp 库可能会在异常中包含请求的 URL,这可能会泄露私有仓库的名称。如果 aiohttp 导致异常,该异常将可在仓库分支的 Actions 选项卡中查看,任何人都可能看到一个或多个私有仓库的名称。

由于 GitHub 统计 API 的一些问题,在某些情况下它会返回不准确的结果。具体来说,仓库浏览次数统计和修改的总代码行数可能会有些不准确。意外的是,随着时间的推移,随着 GitHub 缓存您仓库的统计数据,这些值会变得更加准确。此外,由于 API 返回结果的限制,最后一次贡献超过一年的仓库可能不会包含在统计数据中。

有关不准确性的更多信息,请参见问题 #2#3#13

安装

  1. 按照此处的说明创建个人访问令牌(不是默认的GitHub Actions令牌)。个人访问令牌必须具有以下权限:read:userrepo。生成令牌时请复制它——如果丢失,您将不得不重新生成令牌。

    • 一些用户报告说,个人访问令牌可能需要几分钟才能生效。更多信息请参见#30
  2. 点击这里创建此仓库的副本。注意:这与复刻副本不同,因为它会全新复制所有内容,不包含庞大的提交历史。

  3. 转到您复制的仓库的"Secrets"页面。如果这是您副本的README,点击此链接转到"Secrets"页面。否则,转到新创建仓库的"Settings"标签,然后转到"Secrets"页面(左下角)。

  4. 创建一个名为ACCESS_TOKEN的新密钥,并将复制的个人访问令牌粘贴为其值。

  5. 可以通过添加其他仓库密钥来更改报告的统计类型。

    • 要忽略某些仓库,将它们(以owner/name格式,如jstrieb/github-stats)以逗号分隔添加到一个新的密钥中,名称为EXCLUDED
    • 要忽略某些语言,将它们(以逗号分隔)添加到一个名为EXCLUDED_LANGS的新密钥中。例如,要排除HTML和TeX,可以将值设置为html,tex
    • 要仅显示"拥有"的仓库的统计信息而不包括有贡献的复刻,在主工作流程env头部下添加一个名为EXCLUDE_FORKED_REPOS的环境变量,值为true
    • 这些其他值默认作为密钥添加,以防止泄露私有仓库的信息。如果您不担心这一点,可以直接在Actions工作流程本身中更改这些值。
  6. 转到Actions页面,然后按屏幕右侧的"Run Workflow"首次生成图像。

    • 图像将每24小时自动重新生成,但也可以通过这种方式手动运行工作流程重新生成。
  7. 查看在generated文件夹中创建的图像。

  8. 要将您的统计信息添加到GitHub个人资料README中,请将以下代码行复制并粘贴到您的markdown内容中。将username值更改为您的GitHub用户名。

    ![](https://raw.githubusercontent.com/username/github-stats/master/generated/overview.svg#gh-dark-mode-only)
    ![](https://raw.githubusercontent.com/username/github-stats/master/generated/overview.svg#gh-light-mode-only)
    
    ![](https://raw.githubusercontent.com/username/github-stats/master/generated/languages.svg#gh-dark-mode-only)
    ![](https://raw.githubusercontent.com/username/github-stats/master/generated/languages.svg#gh-light-mode-only)
    
  9. 链接回此仓库,以便其他人也可以生成自己的统计图像。

  10. 如果您喜欢这个项目,请为它加星!

支持项目

您可以通过以下几种方式支持此项目:

  • 为仓库加星(并在GitHub上关注我以获取更多内容)
  • 在Twitter、Reddit和Hacker News等网站上分享和投票
  • 报告您发现的任何错误、故障或错误

这些行为激励我继续分享我的创作,并提供我的工作受到赞赏的验证!它们也帮助我改进项目。提前感谢!

如果您坚持要花钱表示支持,我鼓励您向以下组织之一慷慨捐赠。通过倡导互联网自由,这些组织帮助我感到舒适地在网上公开发布作品。

相关项目

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

白日梦AI

白日梦AI提供专注于AI视频生成的多样化功能,包括文生视频、动态画面和形象生成等,帮助用户快速上手,创造专业级内容。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

讯飞绘镜

讯飞绘镜是一个支持从创意到完整视频创作的智能平台,用户可以快速生成视频素材并创作独特的音乐视频和故事。平台提供多样化的主题和精选作品,帮助用户探索创意灵感。

Project Cover

讯飞文书

讯飞文书依托讯飞星火大模型,为文书写作者提供从素材筹备到稿件撰写及审稿的全程支持。通过录音智记和以稿写稿等功能,满足事务性工作的高频需求,帮助撰稿人节省精力,提高效率,优化工作与生活。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号