Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yankeexe/good-first-issues
Find good first issues right from your CLI! 🚀
https://github.com/yankeexe/good-first-issues
beginner-friendly cli cli-app github github-api good-first-issue hacktoberfest hacktoberfest2020 python-cli
Last synced: about 12 hours ago
JSON representation
Find good first issues right from your CLI! 🚀
- Host: GitHub
- URL: https://github.com/yankeexe/good-first-issues
- Owner: yankeexe
- License: mit
- Created: 2020-09-29T11:15:03.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-27T02:21:28.000Z (about 1 year ago)
- Last Synced: 2024-02-26T19:07:42.963Z (10 months ago)
- Topics: beginner-friendly, cli, cli-app, github, github-api, good-first-issue, hacktoberfest, hacktoberfest2020, python-cli
- Language: Python
- Homepage: https://pypi.org/project/good-first-issues/
- Size: 58.6 KB
- Stars: 85
- Watchers: 4
- Forks: 21
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
Good First Issues
Find good first issues right from your CLI!
## Install Good First Issues
Requires Python 3.6.1 or higher.
```bash
$ pip3 install good-first-issues --upgrade
```
The CLI uses the alias `gfi` to run commands.
## Contents
- [Install Good First Issues](#install-good-first-issues)
- [Contents](#contents)
- [Create GitHub Personal Access Token](#create-github-personal-access-token)
- [Usage](#usage)
- [Search for issues](#search-for-issues)
- [Query all repos in an organization](#query-all-repos-in-an-organization)
- [Query a single repo in an organization](#query-a-single-repo-in-an-organization)
- [Query all repos in a user profile](#query-all-repos-in-a-user-profile)
- [Query a single repo in a user profile.](#query-a-single-repo-in-a-user-profile)
- [Search for Hacktoberfest approved issues](#search-for-hacktoberfest-approved-issues)
- [Query all repos with topic `hacktoberfest`](#query-all-repos-with-topic-hacktoberfest)
- [Query all repos with topic 'hacktoberfest' in an organization or in a user profile](#query-all-repos-with-topic-hacktoberfest-in-an-organization-or-in-a-user-profile)
- [Changing output limits](#changing-output-limits)
- [Viewing issues on browser](#viewing-issues-on-browser)
- [Contributing](#contributing)
### Create GitHub Personal Access Token
The CLI requires GitHub Personal Access Token to make requests to the GitHub API.
> Get [GitHub Fine-grained Personal Access Token](https://github.com/settings/tokens?type=beta)
You can add a Description to your token, select "Public Repositories (read-only)" and select _Generate token_.
**Provide token to CLI:**
```bash
$ gfi config
```
Token is stored locally on `/home//.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](#create-github-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
```bash
$ gfi search "rust-lang"
```
> Demo
> 
#### Query a single repo in an organization
```bash
$ gfi search "facebook" --repo "jest"
```
> Demo
> 
#### Query all repos in a user profile
```bash
$ gfi search "yankeexe" --user
```
> Demo
> 
#### Query a single repo in a user profile.
`--user` flag not required here.
```bash
$ gfi search "yankeexe" --repo "good-first-issues"
```
> Demo
> 
### Search for Hacktoberfest approved issues
#### Query all repos with topic `hacktoberfest`
```bash
$ 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.
```bash
$ gfi search "facebook" --hacktoberfest
```
> Demo
> 
Query all repos with topic 'hacktoberfest' in a user profile.
`--user` flag not required here.
```bash
$ 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
```bash
$ gfi search "facebook" --limit 12
```
> Demo
> 
View all issues found.
```bash
$ 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.
```bash
$ 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](https://github.com/yankeexe/good-first-issues/blob/master/CONTRIBUTING.md).