gpt-pr 0.0.2__tar.gz → 0.1.0__tar.gz

gpt-pr-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include requirements.txt
+
+global-exclude *~ *.py[cod] *.so

{gpt-pr-0.0.2 → gpt-pr-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gpt-pr
-Version: 0.0.2
+Version: 0.1.0
 Summary: Automate your GitHub workflow with GPT-PR: an OpenAI powered library for streamlined PR generation.
 Home-page: http://github.com/alissonperez/gpt-pr
 Author: Alisson R. Perez

{gpt-pr-0.0.2 → gpt-pr-0.1.0}/README.md

@@ -4,6 +4,15 @@ GPT-PR is an open-source command-line tool designed to streamline your GitHub wo
 
 [![asciicast](https://asciinema.org/a/u0PwZlNjAGZcdXPPrjf84wj2A.svg)](https://asciinema.org/a/u0PwZlNjAGZcdXPPrjf84wj2A)
 
+## Table of Contents
+
+- [Features](#features)
+- [Prerequisites](#prerequisites)
+- [Installation and Usage](#installation-and-usage)
+- [Authentication & API Keys](#authentication--api-keys)
+- [How to Contribute](#how-to-contribute)
+- [Roadmap](#roadmap)
+
 ## Features
 
 - Analyzes the diff changes of the current branch against the `main` branch.
@@ -17,21 +26,50 @@ Before getting started, make sure you have the following installed:
 - Python 3.7 or higher
 - [Pipenv](https://pipenv.pypa.io/en/latest/)
 
-## Installation
+## Installation and usage
+
+You can install and use GPT-PR in one of two ways. Choose the option that best suits your needs.
+
+### Option 1: Using `pip install` (Recommended)
+
+1. Install the package:
+
+```bash
+pip install -U gpt-pr
+```
+
+> Note: Use this command to **update** gpt-pr package to the latest version.
+
+2. Export API keys as environment variables ([Authentication & API Keys](#authentication--api-keys)).
+
+3. Inside the Git repository you are working on, ensure you have pushed your branch to origin, then run:
+
+```bash
+gpt-pr
+```
+
+### Option 2: Cloning the code
+
 
 1. Clone the repository:
 
 ```bash
 git clone https://github.com/alissonperez/gpt-pr.git
-cd gpt-pr
 ```
 
-2. Install the dependencies with Pipenv:
+2. Navigate to the project directory and install dependencies:
 
 ```bash
+cd gpt-pr
 pipenv install
 ```
 
+After exporting api keys as environment variables ([Authentication & API Keys](#authentication--api-keys)), you can use GPT-PR within any git project directory. Suppose you've cloned **this project** to `~/workplace/gpt-pr`, here's how you can use it:
+
+```bash
+PIPENV_PIPFILE=~/workplace/gpt-pr/Pipfile pipenv run python ~/workplace/gpt-pr/main.py
+```
+
 ## Authentication & API Keys
 
 ### Setting up GitHub Token (`GH_TOKEN`)
@@ -64,23 +102,16 @@ This project needs to interact with the ChatGPT API to generate the pull request
 export OPENAI_API_KEY=your_generated_api_key_here
 ```
 
-## Usage
-
-After exporting api keys as environment variables ([Authentication & API Keys](#authentication--api-keys)), you can use GPT-PR within any git project directory. Suppose you've cloned **this project** to `~/workplace/gpt-pr`, here's how you can use it:
-
-```bash
-PIPENV_PIPFILE=~/workplace/gpt-pr/Pipfile pipenv run python ~/workplace/gpt-pr/main.py
-```
-
 Output:
 ![image](https://github.com/alissonperez/gpt-pr/assets/756802/cc6c0ca4-5759-44ce-ad35-e4e7305b3875)
 
 ## How to contribute?
 
-Follow our [CONTRIBUTING](./CONTRIBUTING.md) guide.
+Please follow our [CONTRIBUTING](./CONTRIBUTING.md) guide.
 
 ## Roadmap
 
-- [ ] Improve execution method, possibly through a shell script or at least an alias in bash rc files.
+- [x] Improve execution method, possibly through a shell script or at least an alias in bash rc files.
+  - Change to use with pip installation and console_scripts entry point.
 - [ ] Add unit tests.
 - [ ] Fetch GitHub PR templates from the current project.

{gpt-pr-0.0.2 → gpt-pr-0.1.0}/gpt_pr.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gpt-pr
-Version: 0.0.2
+Version: 0.1.0
 Summary: Automate your GitHub workflow with GPT-PR: an OpenAI powered library for streamlined PR generation.
 Home-page: http://github.com/alissonperez/gpt-pr
 Author: Alisson R. Perez

{gpt-pr-0.0.2 → gpt-pr-0.1.0}/gpt_pr.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ gpt_pr.egg-info/not-zip-safe
 gpt_pr.egg-info/requires.txt
 gpt_pr.egg-info/top_level.txt
 gptpr/__init__.py
+gptpr/__version__.py
 gptpr/consolecolor.py
 gptpr/gh.py
 gptpr/gitutil.py

{gpt-pr-0.0.2 → gpt-pr-0.1.0}/gpt_pr.egg-info/requires.txt

@@ -1,28 +1,19 @@
 cffi==1.15.1
 cryptography==41.0.3
-gitpython==3.1.32
-inquirerpy==0.3.4
-openai==0.27.8
-prompt-toolkit==3.0.39
 pycparser==2.21
-pygithub==1.59.1
 wcwidth==0.2.6
 
 [:python_full_version >= "3.7.0"]
-aiosignal==1.3.1
-async-timeout==4.0.3
-attrs==23.1.0
 charset-normalizer==3.2.0
-gitdb==4.0.10
-multidict==6.0.4
-pyjwt[crypto]==2.8.0
-requests==2.31.0
-tqdm==4.66.1
-urllib3==2.0.4
-yarl==1.9.2
+prompt-toolkit==3.0.39
 
-[:python_version < "4.0" and python_full_version >= "3.7.0"]
-pfzy==0.3.4
+[:python_full_version >= "3.7.1"]
+openai==0.28.0
+
+[:python_version < "3.8"]
+asynctest==0.13.0
+importlib-metadata==6.7.0
+typing-extensions==4.7.1
 
 [:python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3"]
 deprecated==1.2.14
@@ -39,5 +30,22 @@ certifi==2023.7.22
 pynacl==1.5.0
 smmap==5.0.0
 
-[:python_version >= "3.8"]
-frozenlist==1.4.0
+[:python_version >= "3.7"]
+aiosignal==1.3.1
+async-timeout==4.0.3
+attrs==23.1.0
+frozenlist==1.3.3
+gitdb==4.0.10
+gitpython==3.1.35
+multidict==6.0.4
+pygithub==1.59.1
+pyjwt[crypto]==2.8.0
+requests==2.31.0
+tqdm==4.66.1
+urllib3==2.0.4
+yarl==1.9.2
+zipp==3.15.0
+
+[:python_version >= "3.7" and python_version < "4.0"]
+inquirerpy==0.3.4
+pfzy==0.3.4

gpt-pr-0.1.0/gptpr/__version__.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'

{gpt-pr-0.0.2 → gpt-pr-0.1.0}/gptpr/prdata.py

@@ -18,9 +18,32 @@ if not OPENAI_API_KEY:
 
 openai.api_key = OPENAI_API_KEY
 
-pr_template = ('### Ref. [Link]\n\n## What was done?\n[Fill here]\n\n'
-               '## How was it done?\n[Fill here]\n\n'
-               '## How was it tested?\n[Fill here with test information from diff content or commits]')
+DEFAULT_PR_TEMPLATE = ('### Ref. [Link]\n\n## What was done?\n[Fill here]\n\n'
+                       '## How was it done?\n[Fill here]\n\n'
+                       '## How was it tested?\n[Fill here with test information from diff content or commits]')
+
+
+def get_pr_template():
+    pr_template = DEFAULT_PR_TEMPLATE
+
+    try:
+        github_dir = os.path.join(os.getcwd(), '.github')
+        github_files = os.listdir(github_dir)
+        pr_template_file = [f for f in github_files if f.lower().startswith('pull_request_template')][0]
+        pr_template_file_path = os.path.join(github_dir, pr_template_file)
+
+        with open(pr_template_file_path, 'r') as f:
+            local_pr_template = f.read()
+
+            if local_pr_template.strip() != '':
+                print('Found PR template at:', pr_template_file_path)
+                pr_template = local_pr_template
+            else:
+                print('Empty PR template at:', pr_template_file_path, 'using default template.')
+    except Exception:
+        print('PR template not found in .github dir. Using default template.')
+
+    return pr_template
 
 
 @dataclass
@@ -80,7 +103,7 @@ def get_pr_data(branch_info):
     else:
         messages.append({'role': 'user', 'content': 'git commits: ' + '\n'.join(branch_info.commits)})
 
-    messages.append({'role': 'user', 'content': 'PR template:\n' + pr_template})
+    messages.append({'role': 'user', 'content': 'PR template:\n' + get_pr_template()})
 
     current_total_length = sum([len(m['content']) for m in messages])
 

gpt-pr-0.1.0/requirements.txt

@@ -0,0 +1,34 @@
+-i https://pypi.org/simple
+aiohttp==3.8.5; python_version >= '3.6'
+aiosignal==1.3.1; python_version >= '3.7'
+async-timeout==4.0.3; python_version >= '3.7'
+asynctest==0.13.0; python_version < '3.8'
+attrs==23.1.0; python_version >= '3.7'
+certifi==2023.7.22; python_version >= '3.6'
+cffi==1.15.1
+charset-normalizer==3.2.0; python_full_version >= '3.7.0'
+cryptography==41.0.3
+deprecated==1.2.14; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+frozenlist==1.3.3; python_version >= '3.7'
+gitdb==4.0.10; python_version >= '3.7'
+gitpython==3.1.35; python_version >= '3.7'
+idna==3.4; python_version >= '3.5'
+importlib-metadata==6.7.0; python_version < '3.8'
+inquirerpy==0.3.4; python_version >= '3.7' and python_version < '4.0'
+multidict==6.0.4; python_version >= '3.7'
+openai==0.28.0; python_full_version >= '3.7.1'
+pfzy==0.3.4; python_version >= '3.7' and python_version < '4.0'
+prompt-toolkit==3.0.39; python_full_version >= '3.7.0'
+pycparser==2.21
+pygithub==1.59.1; python_version >= '3.7'
+pyjwt[crypto]==2.8.0; python_version >= '3.7'
+pynacl==1.5.0; python_version >= '3.6'
+requests==2.31.0; python_version >= '3.7'
+smmap==5.0.0; python_version >= '3.6'
+tqdm==4.66.1; python_version >= '3.7'
+typing-extensions==4.7.1; python_version < '3.8'
+urllib3==2.0.4; python_version >= '3.7'
+wcwidth==0.2.6
+wrapt==1.15.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+yarl==1.9.2; python_version >= '3.7'
+zipp==3.15.0; python_version >= '3.7'

{gpt-pr-0.0.2 → gpt-pr-0.1.0}/setup.py

@@ -1,4 +1,3 @@
-import subprocess
 from setuptools import setup, find_packages
 
 
@@ -9,18 +8,6 @@ def dependencies_filter(dependency):
     return True
 
 
-def get_pipenv_requirements():
-    result = subprocess.run(['pipenv', 'requirements'], capture_output=True, text=True)
-
-    if result.returncode == 0:
-        dependencies = [dependency
-                        for dependency in result.stdout.splitlines()
-                        if dependencies_filter(dependency)]
-        return dependencies
-    else:
-        raise RuntimeError(f"'pipenv requirements' failed with error: {result.stderr}")
-
-
 def get_requirements():
     with open('requirements.txt') as f:
         dependencies = [dependency
@@ -29,10 +16,20 @@ def get_requirements():
         return dependencies
 
 
+version = None
+if not version:
+    version_package_data = {}
+    with open('./gptpr/__version__.py') as f:
+        exec(f.read(), version_package_data)
+
+    version = version_package_data['__version__']
+
+
 setup(name='gpt-pr',
-      version='0.0.2',
+      version=version,
       python_requires='>=3.7',
-      description='Automate your GitHub workflow with GPT-PR: an OpenAI powered library for streamlined PR generation.',
+      description=('Automate your GitHub workflow with GPT-PR: '
+                   'an OpenAI powered library for streamlined PR generation.'),
       url='http://github.com/alissonperez/gpt-pr',
       author='Alisson R. Perez',
       author_email='alissonperez@outlook.com',

gpt-pr-0.0.2/MANIFEST.in

@@ -1 +0,0 @@
-include requirements.txt

gpt-pr-0.0.2/requirements.txt

@@ -1,30 +0,0 @@
--i https://pypi.org/simple
-aiohttp==3.8.5; python_version >= '3.6'
-aiosignal==1.3.1; python_full_version >= '3.7.0'
-async-timeout==4.0.3; python_full_version >= '3.7.0'
-attrs==23.1.0; python_full_version >= '3.7.0'
-certifi==2023.7.22; python_version >= '3.6'
-cffi==1.15.1
-charset-normalizer==3.2.0; python_full_version >= '3.7.0'
-cryptography==41.0.3
-deprecated==1.2.14; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
-frozenlist==1.4.0; python_version >= '3.8'
-gitdb==4.0.10; python_full_version >= '3.7.0'
-gitpython==3.1.32
-idna==3.4; python_version >= '3.5'
-inquirerpy==0.3.4
-multidict==6.0.4; python_full_version >= '3.7.0'
-openai==0.27.8
-pfzy==0.3.4; python_version < '4.0' and python_full_version >= '3.7.0'
-prompt-toolkit==3.0.39
-pycparser==2.21
-pygithub==1.59.1
-pyjwt[crypto]==2.8.0; python_full_version >= '3.7.0'
-pynacl==1.5.0; python_version >= '3.6'
-requests==2.31.0; python_full_version >= '3.7.0'
-smmap==5.0.0; python_version >= '3.6'
-tqdm==4.66.1; python_full_version >= '3.7.0'
-urllib3==2.0.4; python_full_version >= '3.7.0'
-wcwidth==0.2.6
-wrapt==1.15.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
-yarl==1.9.2; python_full_version >= '3.7.0'