A package to update GitHub README with user stats
Project description
GitHub README Stats
A Python package to update your GitHub README with your latest stats.
Installation
pip install github-readme-stats
Usage
from github_readme_stats import GitHubStats, ReadmeUpdater
# Initialize GitHubStats
stats = GitHubStats(github_token, username)
# Get stats
user_stats = stats.get_stats()
# Update README
updater = ReadmeUpdater('path/to/your/README.md')
updater.update(user_stats)
Make sure to include a <!-- GITHUB_STATS --> placeholder in your README where you want the stats to appear.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file github_readme_stats-0.1.0.tar.gz.
File metadata
- Download URL: github_readme_stats-0.1.0.tar.gz
- Upload date:
- Size: 5.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c0564b9c88f3855985880d6a98eb9ea81420c05ffe6adf314f7cf4054f878956 |
|
| MD5 | f379bebea1e105cef5d212e5946173a6 |
|
| BLAKE2b-256 | 7b6ceedaa9fdd74e7c10e3a66e3cf388197096abedfaf423020e4cd2025a2616 |
File details
Details for the file github_readme_stats-0.1.0-py3-none-any.whl.
File metadata
- Download URL: github_readme_stats-0.1.0-py3-none-any.whl
- Upload date:
- Size: 5.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b49617816c5f0bfc2dd1b93c62f161b4afc7f3b0f0f88fa5364f13dbda82c067 |
|
| MD5 | 397319ebbe2a7d510002fd2a82fe8c0b |
|
| BLAKE2b-256 | 20500c935dbb2f112d15ad7cdb3873358d635da9a4ebe1bf573ad2a20bde642b |
