| Name | github-random-star JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | None |
| Summary | Simple CLI tool to fetch random starred repositories from a users GitHub profile. |
| upload_time | 2024-10-24 09:40:24 |
| maintainer | None |
| docs_url | None |
| author | David Kasakaitis |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
python
python3
cli
github
git
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ⭐️ GitHub Random Star ⭐️
<a href="https://pypi.org/project/github-random-star"><img src="https://img.shields.io/pypi/v/github_random_star?style=for-the-badge&logo=pypi" /></a>
<a href="https://pypi.org/project/github-random-star"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/github-random-star?style=for-the-badge"></a>
<a href="https://github.com/ddkasa/gh-random-star/actions/workflows/pypi-publish.yml"><img src="https://img.shields.io/github/actions/workflow/status/ddkasa/github-random-star/pypi-publish.yml?style=for-the-badge"/></a>
<a href="https://pypistats.org/packages/github-random-star"><img src="https://img.shields.io/pypi/dm/github-random-star?style=for-the-badge" /></a>
> 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 <command> <account> <flags>`.
- Run `gh-star help star` to get help.
### GitHub CLI
- Run the script through `gh random-star <command> <account> <flags>`.
- 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
- `<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
##### 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "github-random-star",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "python, python3, cli, github, git",
"author": "David Kasakaitis",
"author_email": "davidkasakaitis@proton.me",
"download_url": "https://files.pythonhosted.org/packages/82/ba/4215b9a9704e09d40b6a2faa6b6ef4357969896dec13c4b8034c27e81139/github_random_star-1.2.0.tar.gz",
"platform": null,
"description": "# \u2b50\ufe0f GitHub Random Star \u2b50\ufe0f\n\n<a href=\"https://pypi.org/project/github-random-star\"><img src=\"https://img.shields.io/pypi/v/github_random_star?style=for-the-badge&logo=pypi\" /></a>\n<a href=\"https://pypi.org/project/github-random-star\"><img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/github-random-star?style=for-the-badge\"></a>\n<a href=\"https://github.com/ddkasa/gh-random-star/actions/workflows/pypi-publish.yml\"><img src=\"https://img.shields.io/github/actions/workflow/status/ddkasa/github-random-star/pypi-publish.yml?style=for-the-badge\"/></a>\n<a href=\"https://pypistats.org/packages/github-random-star\"><img src=\"https://img.shields.io/pypi/dm/github-random-star?style=for-the-badge\" /></a>\n\n\n\n> 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.\n\n> If you are struggling with selection paralysis; it also allows for selecting random repositories from a GitHub user.\n\n## Installation\n\n#### Install with [Pipx](https://github.com/pypa/pipx) or Pip.\n\n```\npipx install github-random-star\n```\n\n#### Install with [GitHub CLI](https://github.com/cli/cli).\n\n```\ngh extension install ddkasa/gh-random-star\n```\n\n## Usage\n\n- 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._\n\n### PyPi\n\n- Run the script through `gh-star <command> <account> <flags>`.\n- Run `gh-star help star` to get help.\n\n### GitHub CLI\n\n- Run the script through `gh random-star <command> <account> <flags>`.\n- Run `gh random-star help star` to get help.\n\n### Commands\n\n1. `star` Randomly select from all starred items of a GH user.\n2. `repo` Randomly select from a GH users repositories.\n\n### Arguments\n\n- `<account>` Username of the GitHub account to retrieve the starred items from. **Required**\n\n### Flags\n\n- `-t, --total` Total amount of random items you want to pick from. Defaults to 3.\n- `-r, --refresh` Whether to fetch new cached data or not. Will re fetch all starred items instead of using cache.\n- `--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.\n- `-i, --ignore` If to use a list of repositories to ignore. Defaults to true.\n- `--max_results` The amount of starred items to retrieve from GitHub. Defaults to all.\n\n### Examples\n\n##### PyPI\n\n- `gh-star star ddkasa`\n- `gh-star repo ddkasa`\n- `gh-star star ddkasa -t 5`\n- `gh-star star ddkasa -r -t 5`\n\n##### GitHub CLI\n\n- `gh random-star star ddkasa`\n- `gh random-star repo ddkasa`\n\n## Contributing\n\nDevelopment is run through [Poetry](https://github.com/python-poetry/poetry).\n\n### Basic Setup\n\n1. `git clone https://github.com/ddkasa/github-random-star`\n2. `cd github-random-star`\n3. `poetry shell`\n4. `poetry install`\n5. `poetry run gh-star`\n\n- Lint with `ruff check toggl_api`\n- Check typing with `mypy toggl_api`\n\n### Testing\n\n- Use `pytest` for all tests\n- Use `pytest -m unit` for unit tests\n- Use `pytest -m integration` for integration tests\n- Test all supported python versions through `tox`\n\n## License\n\nMIT. Look at the [LICENSE](LICENSE.md) for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple CLI tool to fetch random starred repositories from a users GitHub profile.",
"version": "1.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/ddkasa/gh-random-star/issues",
"Homepage": "https://github.com/ddkasa/gh-random-star",
"Source": "https://github.com/ddkasa/gh-random-star"
},
"split_keywords": [
"python",
" python3",
" cli",
" github",
" git"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dbb910f9adcb5b6cde11d278a1d9fa9d8912ec6b07d1d1c1f864af804db3b20d",
"md5": "b81b1861d4bc831c86019f101d11c862",
"sha256": "f7d830ea9fe1e1b0ffdc4a925c3351e6ec54ab556f16f4d3cdf0b14cc556b5eb"
},
"downloads": -1,
"filename": "github_random_star-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b81b1861d4bc831c86019f101d11c862",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 11521,
"upload_time": "2024-10-24T09:40:22",
"upload_time_iso_8601": "2024-10-24T09:40:22.894334Z",
"url": "https://files.pythonhosted.org/packages/db/b9/10f9adcb5b6cde11d278a1d9fa9d8912ec6b07d1d1c1f864af804db3b20d/github_random_star-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "82ba4215b9a9704e09d40b6a2faa6b6ef4357969896dec13c4b8034c27e81139",
"md5": "796048dafede2c37f67acb48b29a070b",
"sha256": "ad382790fbc117fa1636b6898aa6b6c729050105867b1ce68af99f0b8125553d"
},
"downloads": -1,
"filename": "github_random_star-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "796048dafede2c37f67acb48b29a070b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 9915,
"upload_time": "2024-10-24T09:40:24",
"upload_time_iso_8601": "2024-10-24T09:40:24.161603Z",
"url": "https://files.pythonhosted.org/packages/82/ba/4215b9a9704e09d40b6a2faa6b6ef4357969896dec13c4b8034c27e81139/github_random_star-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-24 09:40:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ddkasa",
"github_project": "gh-random-star",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "github-random-star"
}
