Setup

Requirements

You'll require:

• Git
• Python 3 environment
• A personal access token

Environment Setup

• Python Setup
  • Python usually comes with almost all *nix distributions, additionally if you use Windows, you can take a look here.
• Getting a personal access token
  • A personal access token is required to perform actions on your behalf via the API. It provides your identity to the API.
  • Go to Settings > Developer settings > Personal access tokens.
  • Generate a new token with the following scopes - delete_repo, repo, user and workflow.

Setting the tool up

Once you've got basic environment ready:

1. Clone the repository

git clone https://github.com/0xInfection/Bludger.git 
cd Bludger/

2. Installing a few dependencies

Bludger requires a few libraries to work with. They are:

• requests
• gitpython

Simply run the command to get your setup up and running:

python3 -m pip install -r requirements.txt

3. Setup the access token

Copy the access token from GitHub and paste it in the ACCESS_TOKEN field Line 17 in config.py. It should look like:

ACCESS_TOKEN = '234234bc234245345a1232342345b5989cba989000a'

4. That's it you're all set! You can create a symlink to your $PATH for easier access to the tool.

Now, take a look at the Usage section for more info on how to use this tool.