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

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

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

@@ -33,14 +33,12 @@ You can install and use GPT-PR in one of two ways. Choose the option that best s
 
 ### Option 1: Using `pip install` (Recommended)
 
-1. Install the package:
+1. Install OR Update the package:
 
 ```bash
 pip install -U gpt-pr
 ```
 
-> Note: Use this command to **update** gpt-pr package to the latest version.
-
 2. Setup API keys for GitHub and OpenAI, take a look at [Configuration](#configuration).
 
 3. Inside the Git repository you are working on, ensure you have pushed your branch to origin, then run:
@@ -49,7 +47,7 @@ pip install -U gpt-pr
 gpt-pr --help
 ```
 
-### Option 2: Cloning the code
+### Option 2: Cloning the code (NOT recommended)
 
 1. Clone the repository:
 
@@ -74,6 +72,14 @@ pipenv run python ~/workplace/gpt-pr/gptpr/main.py --help
 
 ## Configuration
 
+### See all configs available
+
+To print all default configs and what is being used, just run:
+
+```bash
+gpt-pr-config print
+```
+
 ### Setting up GitHub Token (`GH_TOKEN`)
 
 GPT-PR tool will look for a `GH_TOKEN` in current shell env var OR in gpt-pr config file (at `~/.gpt-pr.ini`).
@@ -120,22 +126,36 @@ 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:
 
 ```bash
-gpt-pr-config set openai_model gpt-3.5-turbo
+gpt-pr-config set openai_model gpt-4o-mini
 ```
 
+> Obs.: `gpt-4o-mini` already is the default model of the project
+
 To see a full list of available models, access [OpenAI Models Documentation](https://platform.openai.com/docs/models)
 
-### See all configs available
+### GPT-PR Library Signature in PRs
 
-To print all default configs and what is being used, just run:
+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 print
+gpt-pr-config set add_tool_signature false
 ```
 
 ### Reset config
@@ -143,7 +163,7 @@ gpt-pr-config print
 To reset any config to default value, just run:
 
 ```bash
-gpt-pr-config reset config-name
+gpt-pr-config reset config_name
 ```
 
 Example:

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

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

@@ -1,5 +1,5 @@
 cffi==1.15.1
-cryptography==42.0.7
+cryptography==43.0.0
 fire==0.6.0
 pycparser==2.21
 wcwidth==0.2.13
@@ -12,7 +12,7 @@ prompt-toolkit==3.0.43
 openai==1.14.0
 
 [:python_version < "3.11"]
-exceptiongroup==1.2.1
+exceptiongroup==1.2.2
 
 [:python_version < "3.8"]
 cached-property==1.5.2
@@ -30,7 +30,7 @@ deprecated==1.2.14
 idna==3.7
 
 [:python_version >= "3.6"]
-certifi==2024.2.2
+certifi==2024.7.4
 distro==1.9.0
 pynacl==1.5.0
 wrapt==1.16.0

{gpt-pr-0.4.1 → gpt-pr-0.6.0}/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#authentication--api-keys'
+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,11 +16,17 @@ class Config:
     config_filename = '.gpt-pr.ini'
 
     _default_config = {
+        # Amenities
+        'ADD_TOOL_SIGNATURE': 'true',  # Add GPT-PR signature to PRs
+
         # Github
         'GH_TOKEN': '',
 
+        # LLM input MAX Tokens
+        'INPUT_MAX_TOKENS': '15000',
+
         # Open AI info
-        'OPENAI_MODEL': 'gpt-4o',
+        'OPENAI_MODEL': 'gpt-4o-mini',
         'OPENAI_API_KEY': '',
     }
 
@@ -66,7 +73,7 @@ class Config:
 
     def set_user_config(self, name, value):
         self.load()
-        self._config['user'][name] = value
+        self._config['user'][name] = str(value)
 
     def reset_user_config(self, name):
         self.load()

{gpt-pr-0.4.1 → gpt-pr-0.6.0}/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.4.1 → gpt-pr-0.6.0}/gptpr/prdata.py

@@ -4,11 +4,10 @@ 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
-MAX_TOKENS = 6000
 
 DEFAULT_PR_TEMPLATE = ('### Ref. [Link]\n\n## What was done?\n[Fill here]\n\n'
                        '## How was it done?\n[Fill here]\n\n'
@@ -52,6 +51,10 @@ def _get_open_ai_key():
     return api_key
 
 
+def _count_tokens(text):
+    return len(text.split(' '))
+
+
 @dataclass
 class PrData():
     branch_info: BranchInfo
@@ -64,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 = [
     {
@@ -91,6 +103,35 @@ functions = [
 
 
 def get_pr_data(branch_info):
+    client = OpenAI(api_key=_get_open_ai_key())
+
+    messages = _get_messages(branch_info)
+
+    openai_model = config.get_user_config('OPENAI_MODEL')
+    print('Using OpenAI model:', cc.yellow(openai_model))
+
+    chat_completion = client.chat.completions.create(
+        messages=messages,
+        model=openai_model,
+        functions=functions,
+        function_call={'name': 'create_pr'},
+        temperature=0,
+        max_tokens=1000,
+        top_p=1,
+        frequency_penalty=0,
+        presence_penalty=0
+    )
+
+    arguments = _parse_json(chat_completion.choices[0].message.function_call.arguments)
+
+    return PrData(
+        branch_info=branch_info,
+        title=arguments['title'],
+        body=arguments['description']
+    )
+
+
+def _get_messages(branch_info):
     system_content = ('You are a development assistant designed to craft Git pull requests '
                       'by incorporating information from main and secondary commits, diff changes, '
                       'and adhering to a provided PR template. Your output includes a complete PR '
@@ -108,45 +149,30 @@ def get_pr_data(branch_info):
         messages.append({'role': 'user', 'content': 'main commits: ' + '\n'.join(branch_info.highlight_commits)})
         messages.append({'role': 'user', 'content': 'secondary commits: ' + '\n'.join(branch_info.commits)})
     else:
-        messages.append({'role': 'user', 'content': 'git commits: ' + '\n'.join(branch_info.commits)})
+        messages.append({'role': 'user', 'content': 'git commits: \n' + '\n'.join(branch_info.commits)})
 
     messages.append({'role': 'user', 'content': 'PR template:\n' + _get_pr_template()})
 
-    current_total_length = sum([len(m['content']) for m in messages])
+    joined_messages = '\n'.join([m['content'] for m in messages])
+    current_total_tokens = _count_tokens(joined_messages)
+
+    input_max_tokens = int(config.get_user_config('INPUT_MAX_TOKENS'))
 
-    if current_total_length / TOKENIZER_RATIO > MAX_TOKENS:
-        raise Exception(f'Current total length {current_total_length} is greater than max tokens {MAX_TOKENS}')
+    if current_total_tokens > input_max_tokens:
+        exp_message = (f'Length of {current_total_tokens} tokens for basic prompt '
+                       f'(description and commits) is greater than max tokens {input_max_tokens} '
+                       '(config \'input_max_tokens\')')
+        raise Exception(exp_message)
 
-    total_length_with_diff = current_total_length + len(branch_info.diff)
-    if total_length_with_diff / TOKENIZER_RATIO > MAX_TOKENS:
-        print('Total content length (with diff) is too big.', cc.red('Skipping diff content...'))
+    total_tokens_with_diff = current_total_tokens + _count_tokens(branch_info.diff)
+    if total_tokens_with_diff > input_max_tokens:
+        print_msg = (f'Length git changes with diff is too big (total is {total_tokens_with_diff}, '
+                     f'\'input_max_tokens\' config is {input_max_tokens}).')
+        print(print_msg, cc.red('Skipping changes diff content...'))
     else:
         messages.append({'role': 'user', 'content': 'Diff changes:\n' + branch_info.diff})
 
-    client = OpenAI(api_key=_get_open_ai_key())
-
-    openai_model = config.get_user_config('OPENAI_MODEL')
-    print('Using OpenAI model:', cc.yellow(openai_model))
-
-    chat_completion = client.chat.completions.create(
-        messages=messages,
-        model=openai_model,
-        functions=functions,
-        function_call={'name': 'create_pr'},
-        temperature=0,
-        max_tokens=512,
-        top_p=1,
-        frequency_penalty=0,
-        presence_penalty=0
-    )
-
-    arguments = _parse_json(chat_completion.choices[0].message.function_call.arguments)
-
-    return PrData(
-        branch_info=branch_info,
-        title=arguments['title'],
-        body=arguments['description']
-    )
+    return messages
 
 
 def _parse_json(content):

{gpt-pr-0.4.1 → gpt-pr-0.6.0}/gptpr/test_config.py

@@ -30,7 +30,7 @@ def test_init_config_file(temp_config):
     assert os.path.isfile(os.path.join(str(temp_dir), config.config_filename))
 
     _check_config(config, temp_dir, [
-        ('DEFAULT', 'OPENAI_MODEL', 'gpt-4o'),
+        ('DEFAULT', 'OPENAI_MODEL', 'gpt-4o-mini'),
         ('DEFAULT', 'OPENAI_API_KEY', ''),
     ])
 
@@ -66,17 +66,36 @@ def test_set_user_config(temp_config):
     ])
 
 
+def test_set_user_config_with_int_value(temp_config):
+    config, temp_dir = temp_config
+
+    config.set_user_config('INPUT_MAX_TOKENS', 100)
+    config.persist()
+
+    # Read the configuration file and verify its contents
+    config_to_test = configparser.ConfigParser()
+    config_to_test.read(os.path.join(str(temp_dir), config.config_filename))
+
+    _check_config(config, temp_dir, [
+        ('user', 'INPUT_MAX_TOKENS', '100'),
+    ])
+
+
 def test_all_values(temp_config):
     config, temp_dir = temp_config
 
     all_values = config.all_values()
 
     assert all_values == [
+        ('DEFAULT', 'add_tool_signature', 'true'),
         ('DEFAULT', 'gh_token', ''),
-        ('DEFAULT', 'openai_model', 'gpt-4o'),
+        ('DEFAULT', 'input_max_tokens', '15000'),
+        ('DEFAULT', 'openai_model', 'gpt-4o-mini'),
         ('DEFAULT', 'openai_api_key', ''),
+        ('user', 'add_tool_signature', 'true'),
         ('user', 'gh_token', ''),
-        ('user', 'openai_model', 'gpt-4o'),
+        ('user', 'input_max_tokens', '15000'),
+        ('user', 'openai_model', 'gpt-4o-mini'),
         ('user', 'openai_api_key', ''),
     ]
 
@@ -94,6 +113,6 @@ def test_reset_user_config(temp_config):
     config_to_test.read(os.path.join(str(temp_dir), config.config_filename))
 
     _check_config(config, temp_dir, [
-        ('user', 'OPENAI_MODEL', 'gpt-4o'),
+        ('user', 'OPENAI_MODEL', 'gpt-4o-mini'),
         ('user', 'OPENAI_API_KEY', ''),
     ])

gpt-pr-0.6.0/gptpr/version.py

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

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

@@ -2,13 +2,13 @@
 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.2.2; python_version >= '3.6'
+certifi==2024.7.4; python_version >= '3.6'
 cffi==1.15.1
 charset-normalizer==3.3.2; python_full_version >= '3.7.0'
-cryptography==42.0.7
+cryptography==43.0.0
 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.1; python_version < '3.11'
+exceptiongroup==1.2.2; python_version < '3.11'
 fire==0.6.0
 gitdb==4.0.11; python_version >= '3.7'
 gitpython==3.1.42; python_version >= '3.7'

gpt-pr-0.4.1/gptpr/version.py

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