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

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

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

@@ -126,6 +126,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 +148,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:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gpt-pr
-Version: 0.5.0
+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.5.0 → 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#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.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.5.0 → gpt-pr-0.6.0}/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.0}/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.0/gptpr/version.py

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

gpt-pr-0.5.0/gptpr/version.py

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