anmol098/waka-readme-stats
Waka Readme Stats
waka-readme-stats is an automated profile README updater and developer statistics dashboard. It integrates with the WakaTime API and compatible self-hosted endpoints to synchronize time-tracking data, which it then transforms into a formatted display of coding hours, languages, and operating systems.
The tool operates as a GitHub Action that fetches metrics and automatically updates a profile README file by replacing marker comments with dynamic content via git commits. It allows for custom API endpoint integration to support self-hosted services.
The system provides capabilities for metrics rendering and data collection, including the ability to filter out specific repositories and control the visibility of individual data points. Visual styling is handled through configurable templates for progress bars and badges, while output localization supports multiple languages via locale codes.
Configuration options include commit identity settings for automated updates and customizable timestamp formatting for the statistics block.
Features
- GitHub Actions Workflows - Operates as a GitHub Action that automatically updates profile data via scheduled repository events.
- GitHub Profile Integrations - Integrates development metrics into a GitHub profile README to showcase skills and productivity.
- Dynamic README Updaters - Automates the replacement of marker comments in a Markdown file with dynamic development statistics.
- Developer Activity Reporting - Collects and formats coding statistics from an external API to provide a live summary of usage.
- README Section Injections - Injects dynamic coding activity and project statistics into specific sections of a README file.
- API Data Synchronization - Synchronizes coding activity data from external HTTP-based APIs to retrieve current statistics.
- DevOps Metric Collection - Gathers and aggregates activity data from software development tools for profile representation.
- Developer Experience Dashboards - Provides a visual interface displaying coding hours, languages, and operating systems.
- Time-Tracking API Integrations - Integrates with WakaTime and compatible APIs to synchronize coding time-tracking data.
- Marker-Based Injection Utilities - Updates Markdown files by injecting dynamic content between predefined marker comments.
- Profile Metric Generators - Converts user activity data into visual summaries and formatted text blocks for profiles.
- Rule-Based Data Filtering - Applies deterministic constraints to exclude specific repositories from activity metric calculations.
- Metric Source Filters - Allows the exclusion of specific repositories to ensure accuracy in the final activity statistics.
- Custom API Endpoints - Supports the use of custom API base URLs to connect with self-hosted time-tracking services.
- Visual Metric Templates - Transforms raw activity data into formatted visual progress bars and badges using configurable text templates.
- Developer Contribution Portfolios - Visualizes contribution history and coding activity to enhance a professional developer portfolio.
- Profile Enhancement Tools - Visualizes coding habits and language usage statistics
- Profile Readme Tools - Visualizes coding productivity and language usage.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
