gpt-pr 0.5.0__tar.gz → 0.6.1__tar.gz

{gpt-pr-0.5.0 → gpt-pr-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gpt-pr
-Version: 0.5.0
+Version: 0.6.1
 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.5.0 → gpt-pr-0.6.1}/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)
@@ -126,6 +181,16 @@ Or just export it as an environment variable in your shell initializer:
 export OPENAI_API_KEY=your_generated_api_key_here
 ```
 
+### Setting Max Input LLM Tokens
+
+You can adjust the maximum number of input tokens allowed when calling the LLM model by modifying the corresponding setting.
+
+For example, to change the maximum to 20,000 tokens, use the following command:
+
+```bash
+gpt-pr-config set input_max_tokens 20000
+```
+
 ### Change OpenAI model
 
 To change OpenAI model, just run:
@@ -138,12 +203,22 @@ gpt-pr-config set openai_model gpt-4o-mini
 
 To see a full list of available models, access [OpenAI Models Documentation](https://platform.openai.com/docs/models)
 
+### GPT-PR Library Signature in PRs
+
+To help other developers recognize and understand the use of the GPT-PR library in generating pull requests, we have included an optional signature feature. By default, this feature is enabled and appends the text "Generated by GPT-PR" at the end of each pull request. This transparency fosters better collaboration and awareness among team members about the tools being utilized in the development process.
+
+If you prefer to disable this feature, simply run the following command:
+
+```bash
+gpt-pr-config set add_tool_signature false
+```
+
 ### Reset config
 
 To reset any config to default value, just run:
 
 ```bash
-gpt-pr-config reset config-name
+gpt-pr-config reset config_name
 ```
 
 Example:
@@ -179,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.5.0 → gpt-pr-0.6.1}/gpt_pr.egg-info/PKG-INFO

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

@@ -1,5 +1,5 @@
 cffi==1.15.1
-cryptography==43.0.0
+cryptography==43.0.1
 fire==0.6.0
 pycparser==2.21
 wcwidth==0.2.13
@@ -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.8
 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.66.5
 typing-extensions==4.7.1
 urllib3==2.0.7
 zipp==3.15.0

{gpt-pr-0.5.0 → gpt-pr-0.6.1}/gptpr/config.py

@@ -7,7 +7,8 @@ def config_command_example(name, value_sample):
     return f'gpt-pr-config set {name} {value_sample}'
 
 
-CONFIG_README_SECTION = 'https://github.com/alissonperez/gpt-pr?tab=readme-ov-file#configuration'
+CONFIG_PROJECT_REPO_URL = 'https://github.com/alissonperez/gpt-pr'
+CONFIG_README_SECTION = f'{CONFIG_PROJECT_REPO_URL}?tab=readme-ov-file#configuration'
 
 
 class Config:
@@ -15,6 +16,9 @@ class Config:
     config_filename = '.gpt-pr.ini'
 
     _default_config = {
+        # Amenities
+        'ADD_TOOL_SIGNATURE': 'true',  # Add GPT-PR signature to PRs
+
         # Github
         'GH_TOKEN': '',
 

{gpt-pr-0.5.0 → gpt-pr-0.6.1}/gptpr/gh.py

@@ -30,7 +30,7 @@ def create_pr(pr_data, yield_confirmation):
         default=True).execute()
 
     if pr_confirmation:
-        pr = repo.create_pull(title=pr_data.title, body=pr_data.body,
+        pr = repo.create_pull(title=pr_data.title, body=pr_data.create_body(),
                               head=pr_data.branch_info.branch, base=pr_data.branch_info.base_branch)
         print("Pull request created successfully: ", pr.html_url)
     else:

{gpt-pr-0.5.0 → gpt-pr-0.6.1}/gptpr/gitutil.py

@@ -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.5.0 → gpt-pr-0.6.1}/gptpr/prdata.py

@@ -4,7 +4,7 @@ import os
 from openai import OpenAI
 
 from gptpr.gitutil import BranchInfo
-from gptpr.config import config
+from gptpr.config import config, CONFIG_PROJECT_REPO_URL
 import gptpr.consolecolor as cc
 
 TOKENIZER_RATIO = 4
@@ -67,9 +67,18 @@ class PrData():
             f'{cc.bold("Title")}: {cc.yellow(self.title)}',
             f'{cc.bold("Branch name")}: {cc.yellow(self.branch_info.branch)}',
             f'{cc.bold("Base branch")}: {cc.yellow(self.branch_info.base_branch)}',
-            f'{cc.bold("PR Description")}:\n{self.body}',
+            f'{cc.bold("PR Description")}:\n{self.create_body()}',
         ])
 
+    def create_body(self):
+        body = self.body
+
+        if config.get_user_config('ADD_TOOL_SIGNATURE') == 'true':
+            pr_signature = f'Generated by [GPT-PR]({CONFIG_PROJECT_REPO_URL})'
+            body += '\n\n---\n\n' + pr_signature
+
+        return body
+
 
 functions = [
     {

{gpt-pr-0.5.0 → gpt-pr-0.6.1}/gptpr/test_config.py

@@ -87,10 +87,12 @@ def test_all_values(temp_config):
     all_values = config.all_values()
 
     assert all_values == [
+        ('DEFAULT', 'add_tool_signature', 'true'),
         ('DEFAULT', 'gh_token', ''),
         ('DEFAULT', 'input_max_tokens', '15000'),
         ('DEFAULT', 'openai_model', 'gpt-4o-mini'),
         ('DEFAULT', 'openai_api_key', ''),
+        ('user', 'add_tool_signature', 'true'),
         ('user', 'gh_token', ''),
         ('user', 'input_max_tokens', '15000'),
         ('user', 'openai_model', 'gpt-4o-mini'),

gpt-pr-0.6.1/gptpr/version.py

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

{gpt-pr-0.5.0 → gpt-pr-0.6.1}/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
+cryptography==43.0.1
 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.8; 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.66.5; 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.5.0/gptpr/version.py

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