README.md

Overview

The GitHub Token Validator is a command-line tool that validates a GitHub personal access token and displays its associated information, such as token scopes, rate limits, and the time remaining until the rate limit reset. This tool helps users to easily check the status and details of their GitHub tokens.

Features

• Validate GitHub personal access tokens.
• Display token scopes and rate limit information.
• Show time remaining until the rate limit reset.
• Handle various error scenarios gracefully.

Installation

pip install wolfsoftware.github-token-validator

Usage

To run the GitHub Token Validator, use the following command:

gtv [OPTIONS]

Command-Line Options

• -h, --help: Show the help message and exit.
• -v, --version: Show the program's version number and exit.
• -t, --token TOKEN: Specify the GitHub personal access token. (required)
• -T, --timeout TIMEOUT: Specify the request timeout in seconds. (default: 10)

Example Output

+----------------------+-----------------------------+
| Name                 | Value                       |
+----------------------+-----------------------------+
| Token Scope          | read:org, repo, workflow    |
| Rate Limit           | 5000                        |
| Rate Limit Used      | 717                         |
| Rate Limit Remaining | 4283                        |
| Time Till Reset      | 0 hour, 38 minute, 9 second |
+----------------------+-----------------------------+