GitHub Unfollow Tool - Version 1.0.0 Release Notes
I am excited to announce the initial release of the GitHub Unfollow Tool! This Python-based utility helps you manage your GitHub following list by identifying and unfollowing users who are not following you back. Designed with respect for GitHub's API rate limits and Terms of Service, this tool provides a safe and efficient way to curate your network.
Key Features
- Intelligent Unfollowing: Automatically identifies users you follow who do not follow you back.
- GitHub API Rate Limit Awareness: Built-in mechanisms to monitor and respect GitHub's API rate limits, ensuring responsible usage.
- Persistent Data Tracking: Utilizes an SQLite database to keep track of your following, followers, and previously unfollowed users, preventing accidental re-following.
- Configurable Batch Processing: Unfollow users in manageable batches, with adjustable settings for batch size and delays between requests.
- Comprehensive Logging: Detailed INFO, WARNING, and ERROR logs are generated to
github_unfollow.log
for easy monitoring and troubleshooting. - Real-time Statistics: View current statistics on your following count, follower count, users to unfollow, and already unfollowed users.
- Dry Run Mode: Safely preview which users would be unfollowed without making any actual changes to your GitHub account.
- Safety Measures: Includes double-checking mechanisms to verify a user is not following back before unfollowing, and tracks unfollowed users to avoid repeated actions.
Getting Started
To begin using the GitHub Unfollow Tool, please follow the installation and setup instructions in the README.md file. You will need Python 3.7+ and a GitHub Personal Access Token with user:follow
and read:user
scopes.
Usage Examples
- Sync your data:
python main.py --sync
- Perform a dry run:
python main.py --unfollow --dry-run
- Unfollow a batch of users:
python main.py --unfollow
- View statistics:
python main.py --stats
- Sync and then unfollow:
python main.py --sync --unfollow
Configuration
Customize the tool's behavior using the .env
file, where you can set your GITHUB_TOKEN
, GITHUB_USERNAME
, MAX_UNFOLLOWS_PER_RUN
, and DELAY_BETWEEN_REQUESTS
.
Disclaimer
This tool is provided for educational and personal use. Users are responsible for complying with GitHub's Terms of Service and API usage policies. Please use it responsibly.