yankeexe/good-first-issues

Find good first issues right from your CLI! 🚀

Good First Issues

Find good first issues right from your CLI!

Install Good First Issues

Requires Python 3.6.1 or higher.

$ pip3 install good-first-issues --upgrade

The CLI uses the alias gfi to run commands.

Contents

• Install Good First Issues
• Contents
  • Create GitHub Personal Access Token
• Usage
  • Search for issues
    • Query all repos in an organization
    • Query a single repo in an organization
    • Query all repos in a user profile
    • Query a single repo in a user profile.
  • Search for Hacktoberfest approved issues
    • Query all repos with topic hacktoberfest
    • Query all repos with topic 'hacktoberfest' in an organization or in a user profile
  • Changing output limits
  • Viewing issues on browser
• Contributing

Create GitHub Personal Access Token

The CLI requires GitHub Personal Access Token to make requests to the GitHub API.

Get GitHub Personal Access Token

You don't have to select any scopes, add a Note for your token and select Generate token.

Provide token to CLI:

$ gfi config

Token is stored locally on /home/<username>/.gfi/good-first-issues file.

Token in envrionment variable:

Store the token with the name GFITOKEN in your environment.

Usage

GitHub provides API to fetch user and organization data. Personal Access Token is required for authentication and data fetching.

Search for issues

To look for issues, use the gfi search command.

Query all repos in an organization

$ gfi search "rust-lang"

Demo

Query a single repo in an organization

$ gfi search "facebook" --repo "jest"

Demo

Query all repos in a user profile

$ gfi search "yankeexe" --user

Demo

Query a single repo in a user profile.

--user flag not required here.

$ gfi search "yankeexe" --repo "good-first-issues"

Demo

Search for Hacktoberfest approved issues

Query all repos with topic hacktoberfest

$ gfi search --hacktoberfest

$ gfi search -hf

Demo

Query all repos with topic 'hacktoberfest' in an organization or in a user profile

Query all repos with topic 'hacktoberfest' in an organization.

$ gfi search "facebook" --hacktoberfest

Demo

Query all repos with topic 'hacktoberfest' in a user profile. --user flag not required here.

$ gfi search "yankeexe" --hacktoberfest

Demo

Changing output limits

The output is limited to display 10 issues by default. Use --limit flag to set the number of issues for output or --all for no limits.

Limit the issues to 12

$ gfi search "facebook" --limit 12

Demo

View all issues found.

$ gfi search "rust-lang" --all

Viewing issues on browser

It's hard to navigate through all the issues when you have the --all flag enabled, you can view the issues on your browser with ease using the --web flag.

$ gfi search "facebook" --all --web

Demo

Contributing

For guidance on setting up a development environment and how to make a contribution to good-first-issues, see the contributing guidelines.

good-first-issues's Issues

Add pagination to GraphQL queries

GitHub allows fetching first: 100 or last:100 items from the GraphQL API.
With that the CLI is also fetching data from the first 100 repos in an organization.
Add pagination feature to load data from more pages.

Resource: Pagination GraphQL

Add unit tests and integrate them to the CI

Add few unit tests and integrate them to the CI.

Auto open web browser if `--web` flag is passed.

Use the webbrowser built-in package to open the web browser automatically when --web flag is passed.

Method reference:

good-first-issues/gfi/utils/__init__.py

Line 92 in e30a0e7

def web_server(html_data):

---

Currently just shows the port where the static page is served:

in readme file section content you It should be at the top of the page

Add `--hacktoberfest` flag to search issues based on udpated Hacktoberfest maintainer opt-in rule.

While the philosophy behind the CLI remains on finding good-first-issues, it also aims to assist as a reliable tool during the Hacktoberfest.

To keep updated with the new changes, introduce a new flag --hacktoberfest and abbreviation --hf flag to fetch issues based on the new Hacktoberfest maintainer opt-in rule.

The new rule implies:

1. Repo should have hacktoberfest as topic.
2. Issues should have hacktoberfest-accepted label.

Fetch GitHub Personal Access Token from Environment variable

The check_credential function should check for the environment variable GFITOKEN else look for the config file.
Env variable should be of higher priority than the config file stored at ~/.gfi/good-first-issues

good-first-issues/good_first_issues/utils/__init__.py

Line 41 in 207c5f3

def check_credential() -> Union[str, bool]:

---

What will this feature enable?
This will enable the containerization of the CLI that can be used with environment variable for making requests.

check this

please merge this pr for hackoctoberfest

Handle "port already in use error" when using `--web` flag.v / Dynamic Port allocation.

Display proper error message when port is already used.
Dynamic Port Allocation using Port 0 auto allocation.

Method reference:

good-first-issues/gfi/utils/__init__.py

Line 92 in e30a0e7

def web_server(html_data):

Error right now:

Error when installing good-first-issues

When I run the given command in the terminal I get an error (see image)

Am I doing something wrong?

Make the table on browser pretty.

Right now the table looks a bit off.
Need to make it look good.
Template can be found here.

Add line break on character limit for Title column on table

When the terminal window is of minimal length, the table gets jumbled up. Sometimes it's due to the long length of title on GitHub issues. Can it be solved by adding a check for character limit on issue title column and adding a line break?

If you have been using this tool, let's discuss if you have faced this issue or have any solutions in your mind including the one mentioned above.

Image for reference:

Error while making search request

Facing this error while running the search command. Im using python 3.9

Create a code of conduct file

Create a code of conduct file.....assign me this issue and i will make a pr for this issue .

when I try it in windows10 there are error called ``` Error: Bad credentials.```

Add pytest to requirements

Pytest is not part of the requirements of the project i want to add pytest to the root requirements.txt file