gpt-pr 0.4.1__py3-none-any.whl → 0.6.0__py3-none-any.whl

{gpt_pr-0.4.1.dist-info → gpt_pr-0.6.0.dist-info}/METADATA

@@ -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
@@ -8,20 +8,20 @@ Author-email: alissonperez@outlook.com
 License: MIT
 Requires-Python: >=3.7
 Requires-Dist: cffi ==1.15.1
-Requires-Dist: cryptography ==42.0.7
+Requires-Dist: cryptography ==43.0.0
 Requires-Dist: fire ==0.6.0
 Requires-Dist: pycparser ==2.21
 Requires-Dist: wcwidth ==0.2.13
 Requires-Dist: charset-normalizer ==3.3.2 ; python_full_version >= "3.7.0"
 Requires-Dist: prompt-toolkit ==3.0.43 ; python_full_version >= "3.7.0"
 Requires-Dist: openai ==1.14.0 ; python_full_version >= "3.7.1"
-Requires-Dist: exceptiongroup ==1.2.1 ; python_version < "3.11"
+Requires-Dist: exceptiongroup ==1.2.2 ; python_version < "3.11"
 Requires-Dist: cached-property ==1.5.2 ; python_version < "3.8"
 Requires-Dist: importlib-metadata ==6.7.0 ; python_version == "3.7"
 Requires-Dist: six ==1.16.0 ; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2"
 Requires-Dist: deprecated ==1.2.14 ; python_version >= "2.7" and python_version not in "3.0, 3.1, 3.2, 3.3"
 Requires-Dist: idna ==3.7 ; python_version >= "3.5"
-Requires-Dist: certifi ==2024.2.2 ; python_version >= "3.6"
+Requires-Dist: certifi ==2024.7.4 ; python_version >= "3.6"
 Requires-Dist: distro ==1.9.0 ; python_version >= "3.6"
 Requires-Dist: pynacl ==1.5.0 ; python_version >= "3.6"
 Requires-Dist: wrapt ==1.16.0 ; python_version >= "3.6"

gpt_pr-0.6.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+gptpr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gptpr/checkversion.py,sha256=PmbGiYJelecs1Fv2aAZwdr6wn-qDC826nsYI4A6LLvk,2389
+gptpr/config.py,sha256=jOr95rErnk-MByWtC92bpgY2dyVc6bbrjaVoP61oO-s,2822
+gptpr/consolecolor.py,sha256=_JmBMNjIflWMlgP2VkCWu6uQLR9oHBy52uV3TRJJgF4,800
+gptpr/gh.py,sha256=E03xg8UHfZlHJAY-aAYphpgS3xl-FZ2dmI5oBC2XdoA,1136
+gptpr/gitutil.py,sha256=NBD3iRnbFEPRU47w7c5TowwtZieDYkU4zybvv0PoOU0,5783
+gptpr/main.py,sha256=gen_8YXYAUJU0BpzULZ28j9Br6Y9PTqTr9JEm4nwsJI,2694
+gptpr/prdata.py,sha256=Uls18CtkxWlflfHKrB62hT21MTUVabf8JgJ6CxOOccQ,7053
+gptpr/test_checkversion.py,sha256=WtJ3v4MMkFG0Kob0R1wi_nwVhcQFd4mXtKCKZHajEhM,4266
+gptpr/test_config.py,sha256=iL3b-Ypv1TaMQTFb6mrDKw8fPio3WBpMcaFkWbiLdNQ,3369
+gptpr/test_prdata.py,sha256=rSJ-yqOdw-iYdBWyqnA2SXbdrhT8KgIkRTTf9SY1S1g,474
+gptpr/version.py,sha256=cID1jLnC_vj48GgMN6Yb1FA3JsQ95zNmCHmRYE8TFhY,22
+gpt_pr-0.6.0.dist-info/METADATA,sha256=icdIGcBPO4a9U8vYfbR36tKdcKHPo0hfmBpTMimhKv0,2638
+gpt_pr-0.6.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+gpt_pr-0.6.0.dist-info/entry_points.txt,sha256=WhcbcQXqo5-IGliYWiYMhop4-Wm7bcH2ljFKLWrmO7c,81
+gpt_pr-0.6.0.dist-info/top_level.txt,sha256=DZcbzlsjh4BD8njGcvhOeCZ83U_oYWgCn0w8qx5--04,6
+gpt_pr-0.6.0.dist-info/RECORD,,

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()

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:

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):

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', ''),
     ])

gptpr/version.py

@@ -1 +1 @@
-__version__ = "0.4.1"
+__version__ = "0.6.0"

gpt_pr-0.4.1.dist-info/RECORD

@@ -1,17 +0,0 @@
-gptpr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gptpr/checkversion.py,sha256=PmbGiYJelecs1Fv2aAZwdr6wn-qDC826nsYI4A6LLvk,2389
-gptpr/config.py,sha256=YVQgTuJYVwqAabqK-E3xSzlc4QUvZb0q4dUW-_pY2cg,2609
-gptpr/consolecolor.py,sha256=_JmBMNjIflWMlgP2VkCWu6uQLR9oHBy52uV3TRJJgF4,800
-gptpr/gh.py,sha256=uSWY_TzbrAM00neOBkyfV5vxDO4FzMtIrs-Zczp-Tck,1127
-gptpr/gitutil.py,sha256=NBD3iRnbFEPRU47w7c5TowwtZieDYkU4zybvv0PoOU0,5783
-gptpr/main.py,sha256=gen_8YXYAUJU0BpzULZ28j9Br6Y9PTqTr9JEm4nwsJI,2694
-gptpr/prdata.py,sha256=ejx4zLRViJ83OmqvlxGWnw7alo8RPL_YdlwEJFhMQ8g,6183
-gptpr/test_checkversion.py,sha256=WtJ3v4MMkFG0Kob0R1wi_nwVhcQFd4mXtKCKZHajEhM,4266
-gptpr/test_config.py,sha256=_vP-3RJf8WXGGQESr5bCUbmxf8owc1uVJXMSBF_MtH0,2712
-gptpr/test_prdata.py,sha256=rSJ-yqOdw-iYdBWyqnA2SXbdrhT8KgIkRTTf9SY1S1g,474
-gptpr/version.py,sha256=pMtTmSUht-XtbR_7Doz6bsQqopJJd8rZ8I8zy2HwwoA,22
-gpt_pr-0.4.1.dist-info/METADATA,sha256=xcj4KIGRUS5pFaXrVe7AM5YOfy7dm9JA8VE-IVVwsHI,2638
-gpt_pr-0.4.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-gpt_pr-0.4.1.dist-info/entry_points.txt,sha256=WhcbcQXqo5-IGliYWiYMhop4-Wm7bcH2ljFKLWrmO7c,81
-gpt_pr-0.4.1.dist-info/top_level.txt,sha256=DZcbzlsjh4BD8njGcvhOeCZ83U_oYWgCn0w8qx5--04,6
-gpt_pr-0.4.1.dist-info/RECORD,,