Code Monkey home page Code Monkey logo

scout's Introduction

Scout

Stars Forks Contributors

⭐ Find hacktoberfest repos from your terminal by getting repos by the range of stars they have
Have you noticed that often the best repos to contribute to have somewhere between 5-1000 stars? To find these repos on GitHub however, is quite hard! With scout, this issue ends.

You can search repos with the exact amount of stars you wish as well as your language and additional optional keywords.

Install

pip install gh-scout

Before running scout:

  1. Create a GitHub token, no extra perms are required for the token.
    1. You can name the token whatever you want, for example: "Scout Token"
    2. You can use tokens that you may already have, and it will work just fine
  2. Create an env variable called SCOUT_TOKEN, this will be used to ensure you don't get rate limited by GitHub.
    1. On windows, simply type in command prompt setx SCOUT_TOKEN <paste-your-github-token>
    2. On MacOs and Linux, refer this guide on how to set environment variables. In the tutorial, fill FOO with "SCOUT_TOKEN" and bar with the generated token from Github.
  3. Remember to refresh your terminal to load the new env variable
  4. Now you're good to go! Run scout to start!
    1. On windows, press win + r, type in scout, and click Ok.

Example

Show Forks Option

scout --forks

Example

Contributors ❤️


Thanks to these amazing people

scout's People

Contributors

abedaton avatar adripo avatar ahmadsyafrudin avatar ashwin3005 avatar farisfaikar avatar huyszn avatar infinixius avatar joellau avatar kailashchoudhary11 avatar kiinitix avatar llyram avatar manoj0marmat avatar pratik1424 avatar rsk2 avatar sb-decoder avatar shadowpii avatar siddakbagga13 avatar tanmaypatil105 avatar techwiz-3 avatar the-writer-dev avatar theshonuff avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

scout's Issues

Non-token reliance

  1. Make it so that if the token is not in the env, a warning message will be printed but the program continues normally.
  2. When making the request, ensure that the response was valid and not an error due to rate-limiting, if rate-limiting has occurred print an error message warning to use a token and exit

`--standard` command to remove inputs

Make a command called --standard with Argparse that removes the need for any input prompts as it uses the standard search with python as the language!

get_url() is the function you will have to work most in to remove the input prompts when the option is used.

Except Keyboard Interrupt for inputs

Currently, when getting user inputs, if the user interrupts the prompts with Ctrl-C, the standard KeyboardInterrupt message occurs!

In the get_url() function add an exception for KeyboardInerrupt and put a nice message like Farewell my friend, beware the crickets. Then print a new line to the console and exit.

Screen Shot 2022-10-08 at 11 56 22 am

Add Rich rule

Add a beautiful rule at the start of the CLI. The rule should contain the text "Your personal opensource Scout" and the text should be aligned to center.

A good example here. Also star that repo because it's poggers.

Add project links to the table

Add clickable links of the projects to the displayed table so that the user can directly go to the project instead of searching for the project again on github

Make the code work for any topic

Hi,

I understand the primary goal of this project was to find Hacktoberfest projects to contribute to, but now that it is over, could we generalize this for all topics ?

Also, we could add an argparse argument for Hacktoberfest for example: --hacktoberfest ?

If you give me green light, I would be happy to work on it !

Change current no-color styling

Currently styles are changed manually when the --no-color option is used.

However, Rich's Console API has an argument which can achieve this called no_color.

The task is to remove the manual styling and simply change the console definition with the argument no_color=True if the --no-color option is used

Improve README.md

I've had difficulties installing the program and I'd like to add and explain some of the steps on how to install scout and run it. Please assign me this issue thanks!

CI and tests

Add flake8 linting with GitHub actions as well as some automated tests for the CLI

No-colors version

Create a simple no-colors version that prints only plain text when taking input and in the projects table.
Have this triggered by scout --nocolor and scout --no-color

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.