🛡️ GitHub Protector

github-protector is a lightweight, efficient CLI tool designed for developers and DevOps engineers to instantly secure their GitHub repository branches. With a single command, you can enforce industry-standard protection rules, ensuring your codebase remains robust and stable.

---

🚀 Key Features

• ⚡ Instant Protection: Apply branch protection rules in seconds.
• 🛠️ Zero Config: Automatically detects your repository, owner, and current user.
• 🛡️ Secure Defaults: Enforces Pull Request reviews and minimum approval counts.
• 🔗 Flexible API: Seamlessly integrates into your CI/CD pipelines.

---

📦 Installation

Install github-protector directly from PyPI using pip:

pip install github-protector

For local development and testing:

git clone https://github.com/ishandutta2007/github-protector.git
cd github-protector
pip install -e .

---

🛠️ Usage

1. Simple Mode (Auto-detection)

Run this inside any git repository. It will automatically detect the owner, repo, and target main branch.

github-protect

2. Explicit Mode

Provide specific details for fine-grained control:

github-protect --token YOUR_GITHUB_TOKEN --username ishandutta2007 --repo MyRepo --branch develop

3. Help & Options

Explore all available flags:

github-protect --help

---

⚙️ Configuration

You can set up a .env file in your project root to avoid passing tokens every time:

ADMIN_TOKEN=your_personal_access_token_here

---

🗺️ Project Structure

github-protector/
├── assets/                  # Visual assets and banners
├── github_protector/
│   ├── __init__.py
│   └── cli.py               # Core CLI logic
├── pyproject.toml           # Package metadata
└── README.md                # Documentation

---

🤝 Contributing

Contributions are welcome! If you have ideas for new features or find a bug, please open an issue or submit a pull request.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

---

📄 License

Distributed under the MIT License. See LICENSE (if available) or the badge above for more information.

---

📈 Star History

---

Developed with ❤️ by Ishan Dutta