Skip to content

ishandutta2007/add-github-topics

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Add GitHub Topics Banner

πŸš€ Add GitHub Topics CLI 🏷️

Automate your GitHub repository tagging process with a single command!

PyPI version Python versions License: MIT GitHub stars GitHub followers


🌟 Overview

add-github-topics is a powerful and lightweight Python CLI tool designed to help developers and maintainers programmatically manage their GitHub repository topics. Whether you are managing a single project or automating a large-scale migration, this tool simplifies the process of adding descriptive tags to your repositories.

Topics are essential for SEO on GitHub, making your projects more discoverable to the community! πŸ”

✨ Key Features

  • βœ… Smart Appending: Fetches existing topics first to avoid accidental overwrites.
  • βœ… Zero Config Defaults: Automatically detects username and repository name from your local git environment.
  • βœ… Secure Token Handling: Supports .env files for managing your GitHub Personal Access Token (PAT).
  • βœ… Global CLI: Once installed, use it from any directory in your terminal.
  • βœ… Cross-Platform: Works seamlessly on Windows, macOS, and Linux.

πŸš€ Quick Start

1. Installation πŸ“¦

Install the tool directly from PyPI:

pip install add-github-topics

2. Configuration βš™οΈ

Create a .env file in your project root or home directory to store your GitHub token:

ADMIN_TOKEN=your_personal_access_token_here

3. Basic Usage πŸ› οΈ

Run the command from within any git repository:

add-github-topic python

πŸ“– Detailed Usage Guide

add-github-topic <topic> [options]

Options Explained

Option Shortcut Description Default
topic - (Mandatory) The topic string to add. -
--token - Your GitHub Personal Access Token. ADMIN_TOKEN from .env
--username - Your GitHub username. Detected from git config
--reponame - Target repository name. Current folder name

Examples πŸ“

Add multiple tags sequentially:

add-github-topic automation
add-github-topic cli-tool

Target a specific repository and user:

add-github-topic machine-learning --username ishandutta2007 --reponame awesome-ml-project

πŸ› οΈ Development & Contributions

Contributions are welcome! If you'd like to improve this tool:

  1. Clone the repo: git clone https://github.com/ishandutta2007/add-github-topics.git
  2. Install in editable mode: pip install -e .
  3. Submit a Pull Request!

πŸ“ˆ Star History


Made with ❀️ by Ishan Dutta

About

add GitHub Topics 🌟 Star if you like it! 🌟

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages