https://github.com/ddkasa/gh-random-star
Simple CLI tool to fetch random starred repositories from a users GitHub profile.
https://github.com/ddkasa/gh-random-star
cli github random
Last synced: 5 months ago
JSON representation
Simple CLI tool to fetch random starred repositories from a users GitHub profile.
- Host: GitHub
- URL: https://github.com/ddkasa/gh-random-star
- Owner: ddkasa
- License: mit
- Created: 2024-01-30T20:56:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-16T07:41:39.000Z (about 1 year ago)
- Last Synced: 2025-08-19T01:17:43.870Z (10 months ago)
- Topics: cli, github, random
- Language: Python
- Homepage: https://pypi.org/project/github-random-star/
- Size: 215 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ⭐️ 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.
> If you are struggling with selection paralysis; it also allows for selecting random repositories from a GitHub user.
## Installation
#### Install with [Pipx](https://github.com/pypa/pipx) or Pip.
```
pipx install github-random-star
```
#### Install with [GitHub CLI](https://github.com/cli/cli).
```
gh extension install ddkasa/gh-random-star
```
## Usage
- Setup GitHub API token as the `GITHUB_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 `.
- Run `gh-star help star` to get help.
### GitHub CLI
- Run the script through `gh random-star `.
- Run `gh random-star help star` to get help.
### Commands
1. `star` Randomly select from all starred items of a GH user.
2. `repo` Randomly select from a GH users repositories.
### Arguments
- `` 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
##### PyPI
- `gh-star star ddkasa`
- `gh-star repo ddkasa`
- `gh-star star ddkasa -t 5`
- `gh-star star ddkasa -r -t 5`
##### GitHub CLI
- `gh random-star star ddkasa`
- `gh random-star repo ddkasa`
## Contributing
Development is run through [Poetry](https://github.com/python-poetry/poetry).
### Basic Setup
1. `git clone https://github.com/ddkasa/github-random-star`
2. `cd github-random-star`
3. `poetry shell`
4. `poetry install`
5. `poetry run gh-star`
- Lint with `ruff check toggl_api`
- Check typing with `mypy toggl_api`
### Testing
- Use `pytest` for all tests
- Use `pytest -m unit` for unit tests
- Use `pytest -m integration` for integration tests
- Test all supported python versions through `tox`
## License
MIT. Look at the [LICENSE](LICENSE.md) for details.