This a CLI tool to fetch issues and PRs from any repo
Project description
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
- Clone this repository to your local machine
git clone https://github.com/lennyAiko/git-orca-python.git
- Navigate to the repository directory
cd git-orca-python
- Install the dependencies
pip install -r requirements.txt
- Create a
.env
file
touch .env
- 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.
- 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
git_orca_python-0.1.0.tar.gz
(5.3 kB
view hashes)
Built Distribution
Close
Hashes for git_orca_python-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbda4b1488e7428d6cb7cb0b34d2d2822ff34fab9b709be3ce26bab86f41a59d |
|
MD5 | 9543457a929ed5e2ab1d655a5b92c0c2 |
|
BLAKE2b-256 | 523005cd49926d1104efb5889f7eca9e2343052e7bb1d35f7acef6940a0ff066 |