A CLI tool that emails a friend when you create a new GitHub repo
Project description
📦 Repo Notifier
A simple Python CLI tool that monitors your GitHub account and sends you an email whenever a new repository is created.
✨ Features
- ✅ Detects newly created public repositories
- 📧 Sends email notifications
- 🔐 Uses environment variables for secure credentials
- 🧪 Easy to test and extend
- 💻 Usable from terminal via
repo-notifiercommand
📥 Installation
pip install repo-notifier
⚙️ Setup
- Create a
.envfile in your working directory with the following variables:
GITHUB_USERNAME=your_github_username
GITHUB_TOKEN=your_github_token
SENDER_EMAIL=your_email@gmail.com
APP_PASSWORD=your_gmail_app_password
RECEIVER_EMAIL=recipient_email@gmail.com
⚠️ Make sure to generate a GitHub Personal Access Token (classic) with
repoandread:userscopes.
⚠️ For Gmail, use an App Password (not your actual password).
🚀 Usage
Run the tool using:
repo-notifier
If a new repo is detected, you’ll receive an email with a link to the new repository.
📂 File Structure
repo-notifier/
├── notifier/
│ ├── __init__.py
│ └── notifier.py
├── .env # Your secrets (not committed)
├── README.md
├── setup.py
├── pyproject.toml
└── MANIFEST.in
🛠 Example Email
Subject: New GitHub Repo: my-new-project
Hey! 👋
A new GitHub repository was just created:
🔗 https://github.com/your_username/my-new-project
Check it out!
– Your GitHub Notifier Bot
📃 License
MIT © 2025 Priyanshu Raj
Project 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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file repo_notifier-0.1.2.tar.gz.
File metadata
- Download URL: repo_notifier-0.1.2.tar.gz
- Upload date:
- Size: 3.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6c32f5ede90b79c62c8dddf9a5782285e362d08b187ccc1b03ab00f6674ff7f6
|
|
| MD5 |
344b15d11a6b65ab928ab8df903dc283
|
|
| BLAKE2b-256 |
79cd4caa0ad6dde0d63e4f8f263e39c803c89e91dc27d46e81929ef73c5498db
|
File details
Details for the file repo_notifier-0.1.2-py3-none-any.whl.
File metadata
- Download URL: repo_notifier-0.1.2-py3-none-any.whl
- Upload date:
- Size: 3.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cf4bddf40908fd2ee83d78a2237096f0a6bd13d3f935adf5e9e1ed1891eab1f8
|
|
| MD5 |
4bc9090c0e40958061d81999f0439313
|
|
| BLAKE2b-256 |
60a3b5aa41542327be1834b56f21214a89ec60413a5a6a1d6034413801943d26
|