github-random-star 1.0.0

Simple CLI tool to fetch random starred repositories from a users GitHub profile.

⭐️ GitHub Random Star ⭐️

If you have starred way too many GitHub repositories and need a way of keeping track of them. This simple CLI tool throws you quasi random starred repos at you to look at and explore.

Installation

Preferred

Install with Pipx or Pip.

pipx install github-random-star

Install with GitHub CLI.

gh extension install ddkasa/github-random-star

Usage

• Setup GitHub API token as the GITHUB_ACCESS_TOKEN environment variable. If this is not setup it will use the public access point with lower rates.

PyPi

• Run the script through gh-star star <account> <flags>.
• Run gh-star help star to get help.

GitHub CLI

• Run the script through gh random-star star <account> <flags>.
• Run gh random-star help star to get help.

Arguments

• <account> Username of the GitHub account to retrieve the starred items from. Required

Flags

• -t, --total Total amount of random items you want to pick from. Defaults to 3.
• -r, --refresh Whether to fetch new cached data or not. Will re fetch all starred items instead of using cache.
• --max-history The amount of historic choices to cache. Defaults to 100. Set to -1 to keep history unlimited. GH_STAR_MAX_HISTORY environment variable can be used to override this value.
• -i, --ignore If to use a list of repositories to ignore. Defaults to true.
• --max_results The amount of starred items to retrieve from GitHub. Defaults to all.

Examples

• gh-star star ddkasa
• gh-star star ddkasa -t 5
• gh-star star ddkasa -r -t 5
• gh random-star star ddkasa

Development

Development is run through Poetry.

Basic Setup

1. git clone https://github.com/ddkasa/github-random-star
2. cd github-random-star
3. poetry shell
4. poetry install

Testing

• Use pytest for all tests.
• Use pytest -m unit for unit tests.
• Use pytest -m integration for integration tests.

License

MIT. Look at the LICENSE for details.