Reviving GitStats: Modernizing an Old Git History Statistics Tool
The author recounts reviving the dormant GitStats project by migrating it to Python 3, adding CI/CD pipelines, publishing it on PyPI, providing Docker images and an online preview, while outlining future improvements and inviting community contributions.
What is GitStats
GitStats is a Python‑written tool that analyses a Git repository’s history and generates an HTML report.
It only supports Python 2 and its original author stopped maintaining it nine years ago, which limits compatibility and ease of use in modern development environments, though its value remains.
Therefore, the author decided to modernize the project.
Work Completed So Far
Migration to Python 3.9+ : Refactored the code to support Python 3. ✅
Created a Modern CI/CD Pipeline : Added continuous integration and delivery tools for ongoing development and release. ✅
Published to PyPI : Users can now install the package via pip install gitstats . ✅
Provided Docker Image : Users can run GitStats without handling dependencies manually. ✅
Offered Online Preview : Created a web page to showcase the tool’s features. ✅
Special Thanks
The author thanks Sumin Byeon (@suminb), a Korean programmer who originally owned the PyPI name for GitStats. After contacting him, the author obtained permission to use the name, with the condition that it will be transferred if the project is ever abandoned.
Future Plans
Address Valuable Issues : Review unresolved issues in the original repository and fix the most valuable ones.
Review Existing Pull Requests : Evaluate and possibly merge upstream PRs.
Update Documentation : Improve the docs for clarity and ease of use.
Add New Features : Enhance the tool’s functionality.
Optimize UI : Improve visual appearance and user experience.
How to Contribute
If you are interested in improving GitStats, you are welcome to join the project by:
Suggesting Features : Propose ideas or feature requests to better meet user needs.
Contributing Code : Fix bugs or add functionality.
Sharing and Promoting : Recommend GitStats to friends or communities.
The author invites everyone to participate in open‑source development and hopes to revive GitStats together.
Written on November 28, 2024 at 02:50 AM
Thank you for likes, shares, and follows!
DevOps Engineer
DevOps engineer, Pythonista and FOSS contributor. Created cpp-linter, commit-check, etc.; contributed to PyPA.
How this landed with the community
Was this worth your time?
0 Comments
Thoughtful readers leave field notes, pushback, and hard-won operational detail here.