Giter VIP home page Giter VIP logo

github-random-star's Introduction

⭐️ 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.

$ pipx install github-random-star

Other

Install from PyPi/GitHub with pip or clone this repository and install with pip/pipx locally.

Usage

  1. 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.
  2. Run the script through $ gh-star <flags>, $ python github_random_star/main.py <flags> or if using Poetry $ poetry run gh-star <flags>

Flags

  • -a, --account Username of the GitHub account to retrieve the starred items from. --account is required or GH_STAR_ACCOUNT environment variable needs to be set.
  • -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.
  • -h --help Show this help message inside the terminal.

Examples

  • $ gh-star -a ddkasa
  • $ gh-star -a ddkasa -t 5
  • $ gh-star -a ddkasa -r -t 5

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.

github-random-star's People

Contributors

ddkasa avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.