gpt-pr 0.6.0__tar.gz → 0.7.0__tar.gz

{gpt-pr-0.6.0 → gpt-pr-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gpt-pr
-Version: 0.6.0
+Version: 0.7.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.6.0 → gpt-pr-0.7.0}/README.md

@@ -4,6 +4,61 @@ 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)
 
+## Quick Start
+
+For a more detailed explanation, see [Installation](#installation) and [Configuration](#configuration).
+
+### 1. Installation
+
+```bash
+pip install -U gpt-pr
+```
+
+If you don't have the `pip` command available, follow [these instructions](https://pip.pypa.io/en/stable/installation/) to install it on different platforms.
+
+### 2. Fill OpenAI API Key
+
+1. Go to [OpenAI API Keys](https://platform.openai.com/api-keys) and generate a new key.
+2. Run the following command to fill your key in GPT-PR (it will be stored in `~/.gpt-pr.ini`):
+
+```bash
+gpt-pr-config set openai_api_key MY-API-KEY-VALUE
+```
+
+### 3. Generate a GitHub GH Token to Open PRs
+
+1. Go to [GitHub Settings](https://github.com/settings/tokens), choose `Generate new token (classic)`, and select all permissions under `repo` (full control of private repositories).
+2. Run the following command to fill your GH token (it will also be stored in `~/.gpt-pr.ini`):
+
+```bash
+gpt-pr-config set gh_token MY-GH-TOKEN-VALUE
+```
+
+### 4. Ready to NEVER WRITE A PR AGAIN
+
+1. Make your changes, commit them, and push to origin (important!).
+2. Run the following command in your project directory:
+
+```bash
+gpt-pr
+```
+
+3. Answer the questions. At the end, you'll receive the URL of a freshly opened PR.
+
+## Contributing and Feedback
+
+We welcome your contributions and feedback to help improve GPT-PR! Here’s how you can get involved:
+
+### Open Issues
+
+- **Feature Requests**: Have an idea for a new feature? We’d love to hear it! Open an issue to request new features or enhancements.
+- **Bug Reports**: Encountered a bug? Let us know by opening an issue with detailed information so we can fix it.
+- **General Feedback**: Any other suggestions or feedback? Feel free to share your thoughts.
+
+To open an issue, go to the [Issues](https://github.com/your-repo/gpt-pr/issues) section of our GitHub repository. Your contributions are very welcome and highly appreciated!
+
+More details about it at our [CONTRIBUTING](./CONTRIBUTING.md) guide.
+
 ## Table of Contents
 
 - [Features](#features)
@@ -199,10 +254,6 @@ gpt-pr -h
 Output:
 ![image](https://github.com/alissonperez/gpt-pr/assets/756802/cc6c0ca4-5759-44ce-ad35-e4e7305b3875)
 
-## How to contribute?
-
-Please follow our [CONTRIBUTING](./CONTRIBUTING.md) guide.
-
 ## Roadmap
 
 - [x] Improve execution method, possibly through a shell script or at least an alias in bash rc files.

{gpt-pr-0.6.0 → gpt-pr-0.7.0}/gpt_pr.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gpt-pr
-Version: 0.6.0
+Version: 0.7.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.6.0 → gpt-pr-0.7.0}/gpt_pr.egg-info/requires.txt

@@ -1,11 +1,11 @@
 cffi==1.15.1
-cryptography==43.0.0
+cryptography==43.0.3
 fire==0.6.0
 pycparser==2.21
 wcwidth==0.2.13
 
 [:python_full_version >= "3.7.0"]
-charset-normalizer==3.3.2
+charset-normalizer==3.4.0
 prompt-toolkit==3.0.43
 
 [:python_full_version >= "3.7.1"]
@@ -26,12 +26,10 @@ six==1.16.0
 [:python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3"]
 deprecated==1.2.14
 
-[:python_version >= "3.5"]
-idna==3.7
-
 [:python_version >= "3.6"]
-certifi==2024.7.4
+certifi==2024.8.30
 distro==1.9.0
+idna==3.10
 pynacl==1.5.0
 wrapt==1.16.0
 
@@ -51,7 +49,7 @@ requests==2.31.0
 smmap==5.0.1
 sniffio==1.3.1
 termcolor==2.3.0
-tqdm==4.66.4
+tqdm==4.67.0
 typing-extensions==4.7.1
 urllib3==2.0.7
 zipp==3.15.0

{gpt-pr-0.6.0 → gpt-pr-0.7.0}/gptpr/gitutil.py

@@ -32,7 +32,7 @@ class FileChange:
         return f'{self.file_path} (+{(self.lines_added)} -{self.lines_removed})'
 
 
-def get_branch_info(base_branch, yield_confirmation):
+def get_branch_info(base_branch, origin, yield_confirmation):
     # Get current directory
     current_dir = os.getcwd()
 
@@ -57,7 +57,7 @@ def get_branch_info(base_branch, yield_confirmation):
     if not _branch_exists(repo, base_branch):
         raise Exception(f'Base branch {base_branch} does not exist.')
 
-    owner, repo_name = _get_remote_info(repo)
+    owner, repo_name = _get_remote_info(repo, origin)
 
     commits = _get_diff_messages_against_base_branch(repo, current_branch.name, base_branch)
     commits = _get_valid_commits(commits, yield_confirmation)
@@ -125,9 +125,9 @@ def _get_highlight_commits(commits, yield_confirmation):
     return highlight_commits
 
 
-def _get_remote_info(repo):
+def _get_remote_info(repo, origin):
     for remote in repo.remotes:
-        if remote.name != 'origin':
+        if remote.name != origin:
             continue
 
         remote_urls_joined = ','.join([str(url) for url in remote.urls])
@@ -137,7 +137,7 @@ def _get_remote_info(repo):
         for url in remote.urls:
             return _extract_owner_and_repo(url)
 
-    raise Exception('Could not find origin remote.')
+    raise Exception(f'Could not find \'{origin}\' remote.')
 
 
 def _extract_owner_and_repo(repo_url):
@@ -183,10 +183,15 @@ def _get_stats(repo, base_branch, branch):
             continue
 
         line = line.split('\t')
+
+        # Binary files will not have stats (just "-")
+        added = int(line[0]) if line[0] and line[0].isdigit() else 0
+        removed = int(line[1]) if line[1] and line[1].isdigit() else 0
+
         files_changed.append(FileChange(
             file_path=line[2],
-            lines_added=int(line[0]),
-            lines_removed=int(line[1])
+            lines_added=added,
+            lines_removed=removed
         ))
 
     return files_changed

{gpt-pr-0.6.0 → gpt-pr-0.7.0}/gptpr/main.py

@@ -10,7 +10,7 @@ from gptpr import consolecolor as cc
 from gptpr.checkversion import check_for_updates
 
 
-def run(base_branch='main', yield_confirmation=False, version=False):
+def run(base_branch='main', origin='origin', yield_confirmation=False, version=False):
     '''
     Create Pull Requests from current branch with base branch (default 'main' branch)
     '''
@@ -19,7 +19,7 @@ def run(base_branch='main', yield_confirmation=False, version=False):
         print('Current version:', __version__)
         return
 
-    branch_info = get_branch_info(base_branch, yield_confirmation)
+    branch_info = get_branch_info(base_branch, origin, yield_confirmation)
 
     if not branch_info:
         exit(0)

gpt-pr-0.7.0/gptpr/version.py

@@ -0,0 +1 @@
+__version__ = "0.7.0"

{gpt-pr-0.6.0 → gpt-pr-0.7.0}/requirements.txt

@@ -2,10 +2,10 @@
 annotated-types==0.5.0; python_version >= '3.7'
 anyio==3.7.1; python_version >= '3.7'
 cached-property==1.5.2; python_version < '3.8'
-certifi==2024.7.4; python_version >= '3.6'
+certifi==2024.8.30; python_version >= '3.6'
 cffi==1.15.1
-charset-normalizer==3.3.2; python_full_version >= '3.7.0'
-cryptography==43.0.0
+charset-normalizer==3.4.0; python_full_version >= '3.7.0'
+cryptography==43.0.3
 deprecated==1.2.14; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
 distro==1.9.0; python_version >= '3.6'
 exceptiongroup==1.2.2; python_version < '3.11'
@@ -15,7 +15,7 @@ gitpython==3.1.42; python_version >= '3.7'
 h11==0.14.0; python_version >= '3.7'
 httpcore==0.17.3; python_version >= '3.7'
 httpx==0.24.1; python_version >= '3.7'
-idna==3.7; python_version >= '3.5'
+idna==3.10; python_version >= '3.6'
 importlib-metadata==6.7.0; python_version == '3.7'
 inquirerpy==0.3.4; python_version >= '3.7' and python_version < '4.0'
 openai==1.14.0; python_full_version >= '3.7.1'
@@ -32,7 +32,7 @@ six==1.16.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2'
 smmap==5.0.1; python_version >= '3.7'
 sniffio==1.3.1; python_version >= '3.7'
 termcolor==2.3.0; python_version >= '3.7'
-tqdm==4.66.4; python_version >= '3.7'
+tqdm==4.67.0; python_version >= '3.7'
 typing-extensions==4.7.1; python_version >= '3.7'
 urllib3==2.0.7; python_version >= '3.7'
 wcwidth==0.2.13

gpt-pr-0.6.0/gptpr/version.py

@@ -1 +0,0 @@
-__version__ = "0.6.0"