Find good first issues right from your CLI!
Project description
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
The CLI uses the alias gfi
to run commands.
Contents
- Create GitHub Personal Access Token
- Usage
- Contributing
Create GitHub Personal Access Token
The CLI requires GitHub Personal Access Token to make requests to the GitHub API.
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.
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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for good_first_issues-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1b1569aa7fcc0baea3b88c4b64a38a36b576260baaa49d8cd1fecdaabe0f3b0 |
|
MD5 | 49f6f7dd8c626a7f442bbe59d366128e |
|
BLAKE2b-256 | bd97cb4c473e20e8d0ff23b2cd50a0e79f9c471c31cc95f48576f8e6cf4d7de1 |
Hashes for good_first_issues-2.0.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f9306a98e3e194809cce4a5f93919d80adccf63166f29eb35f99c3457cfa157 |
|
MD5 | 19353c3d6c9f0dd75acc9edf6bd4221e |
|
BLAKE2b-256 | 475df4b328056a6aa5a319252e55ac3b44b98695e5070d5857e294a94c22f206 |