# 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
- [Python](https://www.python.org/downloads/)
- Github access token. How to get one [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic)
## Installation/Setup
1. Clone this repository to your local machine
```bash
git clone https://github.com/lennyAiko/git-orca-python.git
```
2. Navigate to the repository directory
```bash
cd git-orca-python
```
3. Install the dependencies
```bash
pip install -r requirements.txt
```
<!-- change configuring .env file -->
4. Create a `.env` file
```bash
touch .env
```
5. Add your Github access token as a variable to the `.env` file.
```bash
> 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
```bash
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
```bash
node index.js --owner <github username> --name <repository name> --issue --open --p <page number> --pp <number of items per page>
```
### For pull requests
```bash
node index.js --owner <github username> --name <repository name> --pr --closed --p <page number> --pp <number of items per page>
```
### Example
```bash
node index.js --owner lennyaiko --name git-orca --issue --closed --p 1 --pp 5
```
> **NOTE**
You don't have to specify all the flags
Raw data
{
"_id": null,
"home_page": "https://github.com/lennyAiko/git-orca-python",
"name": "git-orca-python",
"maintainer": "lennox charles",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "lennyaiko17@gmail.com",
"keywords": "github,issues,git,tool,pr,CLI",
"author": "lennox charles",
"author_email": "lennyaiko17@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b2/d6/0ed0210ec0267360ef4f0061b9b049f0745f93d75e8dc37ddf526816d341/git_orca_python-0.1.0.tar.gz",
"platform": null,
"description": "# git-orca (python)\n\nThis a CLI tool to fetch issues and PRs from any repo\n\n## Packages\n\nTo use this tool, the below listed are required\n\n- [Python](https://www.python.org/downloads/)\n- Github access token. How to get one [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic)\n\n## Installation/Setup\n\n1. Clone this repository to your local machine\n\n```bash\ngit clone https://github.com/lennyAiko/git-orca-python.git\n```\n\n2. Navigate to the repository directory\n\n```bash\ncd git-orca-python\n```\n\n3. Install the dependencies\n\n```bash\npip install -r requirements.txt\n```\n\n<!-- change configuring .env file -->\n\n4. Create a `.env` file\n\n```bash\ntouch .env\n```\n\n5. Add your Github access token as a variable to the `.env` file.\n\n```bash\n> cat .env\nGITHUB_ACCESS_TOKEN=<github_access_token>\n```\n\n> **NOTE**\nreplace `github_access_token` with your github personal access token\n\n## Usage\n\nFor 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.\n\n1. Install the package\n\n```bash\nnode index.js\n```\n\nAlternatively, you can provide the information about the repo on execution of the script with flags:\n\n- --owner: Specifies the GitHub username of the repository owner.\n- --name: Specifies the name of the repository.\n- --issue: Indicates that you want to view issues.\n- --pr: Indicates that you want to view PRs.\n- --open: Indicates that you want to view open issues/PRs.\n- --closed: Indicates that you want to view closed issues/PRs.\n- --p: Specifies the page number you want to view (e.g., page 1).\n- --pp: Specifies the number of items per page (e.g., 10 items per page)\n\n### For issues\n\n```bash\nnode index.js --owner <github username> --name <repository name> --issue --open --p <page number> --pp <number of items per page>\n```\n\n### For pull requests\n\n```bash\nnode index.js --owner <github username> --name <repository name> --pr --closed --p <page number> --pp <number of items per page>\n```\n\n### Example\n\n```bash\nnode index.js --owner lennyaiko --name git-orca --issue --closed --p 1 --pp 5\n```\n\n> **NOTE**\nYou don't have to specify all the flags",
"bugtrack_url": null,
"license": "MIT",
"summary": "This a CLI tool to fetch issues and PRs from any repo",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/lennyAiko/git-orca-python/issues",
"Homepage": "https://github.com/lennyAiko/git-orca-python",
"Repository": "https://github.com/lennyAiko/git-orca-python"
},
"split_keywords": [
"github",
"issues",
"git",
"tool",
"pr",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "523005cd49926d1104efb5889f7eca9e2343052e7bb1d35f7acef6940a0ff066",
"md5": "9543457a929ed5e2ab1d655a5b92c0c2",
"sha256": "cbda4b1488e7428d6cb7cb0b34d2d2822ff34fab9b709be3ce26bab86f41a59d"
},
"downloads": -1,
"filename": "git_orca_python-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9543457a929ed5e2ab1d655a5b92c0c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 6140,
"upload_time": "2023-10-10T20:03:44",
"upload_time_iso_8601": "2023-10-10T20:03:44.986878Z",
"url": "https://files.pythonhosted.org/packages/52/30/05cd49926d1104efb5889f7eca9e2343052e7bb1d35f7acef6940a0ff066/git_orca_python-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b2d60ed0210ec0267360ef4f0061b9b049f0745f93d75e8dc37ddf526816d341",
"md5": "225387c7f64abf01be44436701a360bf",
"sha256": "671ff09302ea5dada69aa6b67c6dd8695577abe191ba71bf4b3a6c75b53d0ea4"
},
"downloads": -1,
"filename": "git_orca_python-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "225387c7f64abf01be44436701a360bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 5314,
"upload_time": "2023-10-10T20:03:52",
"upload_time_iso_8601": "2023-10-10T20:03:52.484087Z",
"url": "https://files.pythonhosted.org/packages/b2/d6/0ed0210ec0267360ef4f0061b9b049f0745f93d75e8dc37ddf526816d341/git_orca_python-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-10 20:03:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lennyAiko",
"github_project": "git-orca-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "git-orca-python"
}
JSON
