GitHub Stats generates visualizations of GitHub user and repository statistics using the GitHub API. The project aims to provide a comprehensive overview of contributions, including data from private repositories and those contributed to but not owned. The images generated can be displayed in repository READMEs or user Profile READMEs, adapting automatically between light and dark themes.
The project's key features include automated image generation via GitHub Actions, support for private repository statistics using personal access tokens, and dynamic adaptation to GitHub's light/dark themes. It uniquely provides a more complete picture of contributions beyond public repositories and offers a serverless solution for regular updates. Flexible configuration allows users to exclude specific repositories or languages.
- Private Repository Stats: Collects data from private repositories using personal access tokens, providing a more complete contribution overview.
- Automated Image Generation: Uses GitHub Actions to regularly update statistics and generate images without requiring a dedicated server.
- Light/Dark Mode Support: Images automatically switch between GitHub's light and dark themes for optimal viewing experience.
- Customizable Exclusion: Allows users to exclude specific repositories or languages from the statistics.
- Profile README Integration: Generates images suitable for display in a GitHub user's profile README.
The project is actively maintained with regular updates and addresses reported issues. While the GitHub statistics API can occasionally return inaccurate results, the project aims to improve accuracy over time. The workflow is well-documented and provides clear instructions for setup and use. The project has a growing community and active issue tracking.
GitHub Stats benefits developers by providing a visually appealing and informative way to showcase their GitHub contributions. It is valuable for individuals and teams seeking to present a comprehensive view of their work and encourages greater transparency in open-source contributions. The project offers a valuable alternative to manually tracking statistics or relying on incomplete GitHub profile data.