https://github.com/fleaz/hacktoberfest-tagger

Quickly add/remove the 'hacktoberfest' topic to all your public repositories
https://github.com/fleaz/hacktoberfest-tagger

hacktoberfest

Last synced: about 2 months ago
JSON representation

Quickly add/remove the 'hacktoberfest' topic to all your public repositories

• Host: GitHub
• URL: https://github.com/fleaz/hacktoberfest-tagger
• Owner: fleaz
• License: mit
• Created: 2020-10-04T14:50:58.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-12-10T23:30:04.000Z (about 3 years ago)
• Last Synced: 2023-04-05T15:15:28.214Z (over 1 year ago)
• Topics: hacktoberfest
• Language: Python
• Homepage:
• Size: 415 KB
• Stars: 16
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hacktoberfest-tagger

Quickly add/remove the 'hacktoberfest' topic to all your public repositories

![Screenshot of the programm output](screenshot.png)

## Motivation

Due to too much SPAM, participation in the Hacktoberfest is now opt-in. That means that you (as a maintainer) have to

add the "hacktoberfest" topic to your repositories before the PRs will count for contributors.  Because most private

accounts will probably not be affected this much by spam, I created this tool to quickly add/remove the topic to all

your public repositories on GitHub.

## Prerequisites

First you need to go to the [Github developer settings](https://github.com/settings/tokens) and create a personal

access token with the `public_repo` permission. The benefit of this in contrast to using your username&password is that

the script only has the permissions it needs, and it also works when you have 2FA enabled (which you definitely should! ;)

)

Provide this token to the script, for example by 

    export GITHUB_TOKEN="copy-your-token-here"

    

Then you need to install the "PyGithub" library. With pipenv installed you can run `pipenv install` in the repository

folder to create a new virtual environment with all dependencies. If you want to use **pip** you can run `pip install -r requirements.txt`.

## Usage

```

run.py [-h] [--organization ORGANIZATION] [--dry-run] {add,remove}

Quickly add/remove the 'hacktoberfest' topic to all of your public Github

projects

positional arguments:

  {add,remove}          'add' or 'remove' the topic

optional arguments:

  -h, --help            show this help message and exit

  --organization ORGANIZATION, -o ORGANIZATION

                        Modify topics for an organization, not your personal

                        projects

  --dry-run             Don't actually modify the topics

```