Skip to content

lennyAiko/git-orca-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

git-orca (python)

This a CLI tool to fetch issues and PRs from any repo

Packages

To use this tool, the below listed are required

Installation/Setup

  1. Clone this repository to your local machine
git clone https://github.com/lennyAiko/git-orca-python.git
  1. Navigate to the repository directory
cd git-orca-python
  1. Install the dependencies
pip install -r requirements.txt
  1. Create a .env file
touch .env
  1. Add your Github access token as a variable to the .env file.
> cat .env
GITHUB_ACCESS_TOKEN=<github_access_token>

NOTE replace github_access_token with your github personal access token

Usage

For a quick start, after installation/setting up the repo just run the below command. This would start an interactive session for you to provide the necessary info about the repository.

  1. Install the package
node index.js

Alternatively, you can provide the information about the repo on execution of the script with flags:

  • --owner: Specifies the GitHub username of the repository owner.
  • --name: Specifies the name of the repository.
  • --issue: Indicates that you want to view issues.
  • --pr: Indicates that you want to view PRs.
  • --open: Indicates that you want to view open issues/PRs.
  • --closed: Indicates that you want to view closed issues/PRs.
  • --p: Specifies the page number you want to view (e.g., page 1).
  • --pp: Specifies the number of items per page (e.g., 10 items per page)

For issues

node index.js --owner <github username> --name <repository name> --issue --open --p <page number> --pp <number of items per page>

For pull requests

node index.js --owner <github username> --name <repository name> --pr --closed --p <page number> --pp <number of items per page>

Example

node index.js --owner lennyaiko --name git-orca --issue --closed --p 1 --pp 5

NOTE You don't have to specify all the flags

About

This a CLI tool to fetch issues and PRs from any repo

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages