gpt-pr 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

{gpt_pr-0.2.0.dist-info → gpt_pr-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gpt-pr
-Version: 0.2.0
+Version: 0.3.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,19 +8,19 @@ Author-email: alissonperez@outlook.com
 License: MIT
 Requires-Python: >=3.7
 Requires-Dist: cffi ==1.15.1
-Requires-Dist: cryptography ==42.0.5
+Requires-Dist: cryptography ==42.0.7
 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.0 ; python_version < "3.11"
+Requires-Dist: exceptiongroup ==1.2.1 ; 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.6 ; python_version >= "3.5"
+Requires-Dist: idna ==3.7 ; python_version >= "3.5"
 Requires-Dist: certifi ==2024.2.2 ; python_version >= "3.6"
 Requires-Dist: distro ==1.9.0 ; python_version >= "3.6"
 Requires-Dist: pynacl ==1.5.0 ; python_version >= "3.6"
@@ -40,7 +40,7 @@ Requires-Dist: requests ==2.31.0 ; python_version >= "3.7"
 Requires-Dist: smmap ==5.0.1 ; python_version >= "3.7"
 Requires-Dist: sniffio ==1.3.1 ; python_version >= "3.7"
 Requires-Dist: termcolor ==2.3.0 ; python_version >= "3.7"
-Requires-Dist: tqdm ==4.66.2 ; python_version >= "3.7"
+Requires-Dist: tqdm ==4.66.4 ; python_version >= "3.7"
 Requires-Dist: typing-extensions ==4.7.1 ; python_version >= "3.7"
 Requires-Dist: urllib3 ==2.0.7 ; python_version >= "3.7"
 Requires-Dist: zipp ==3.15.0 ; python_version >= "3.7"

gpt_pr-0.3.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+gptpr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+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=tc1iLkGVWa0O2gGRAPlGP8MTRA3B1xryIX1Hi6MCn9w,2595
+gptpr/prdata.py,sha256=ejx4zLRViJ83OmqvlxGWnw7alo8RPL_YdlwEJFhMQ8g,6183
+gptpr/test_config.py,sha256=_vP-3RJf8WXGGQESr5bCUbmxf8owc1uVJXMSBF_MtH0,2712
+gptpr/test_prdata.py,sha256=rSJ-yqOdw-iYdBWyqnA2SXbdrhT8KgIkRTTf9SY1S1g,474
+gptpr/version.py,sha256=VrXpHDu3erkzwl_WXrqINBm9xWkcyUy53IQOj042dOs,22
+gpt_pr-0.3.0.dist-info/METADATA,sha256=sva8MD89gNrCtK1xWkfHyJvP1A5JOhW15SS1nC-TwwQ,2638
+gpt_pr-0.3.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+gpt_pr-0.3.0.dist-info/entry_points.txt,sha256=WhcbcQXqo5-IGliYWiYMhop4-Wm7bcH2ljFKLWrmO7c,81
+gpt_pr-0.3.0.dist-info/top_level.txt,sha256=DZcbzlsjh4BD8njGcvhOeCZ83U_oYWgCn0w8qx5--04,6
+gpt_pr-0.3.0.dist-info/RECORD,,

{gpt_pr-0.2.0.dist-info → gpt_pr-0.3.0.dist-info}/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 gpt-pr = gptpr.main:main
+gpt-pr-config = gptpr.main:run_config

gptpr/config.py

@@ -0,0 +1,97 @@
+from copy import deepcopy
+import configparser
+import os
+
+
+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'
+
+
+class Config:
+
+    config_filename = '.gpt-pr.ini'
+
+    _default_config = {
+        # Github
+        'GH_TOKEN': '',
+
+        # Open AI info
+        'OPENAI_MODEL': 'gpt-4o',
+        'OPENAI_API_KEY': '',
+    }
+
+    def __init__(self, config_dir=None):
+        self.default_config = deepcopy(self._default_config)
+        self._config_dir = config_dir or os.path.expanduser('~')
+        self._config = configparser.ConfigParser()
+        self._initialized = False
+
+    def load(self):
+        if self._initialized:
+            return
+
+        config_file_path = self.get_filepath()
+
+        if os.path.exists(config_file_path):
+            self._config.read(config_file_path)
+            self._ensure_default_values()
+        else:
+            self._config['user'] = {}
+            self._config['DEFAULT'] = deepcopy(self.default_config)
+            self.persist()
+
+        self._initialized = True
+
+    def _ensure_default_values(self):
+        added = False
+        for key, value in self.default_config.items():
+            if key not in self._config['DEFAULT']:
+                self._config['DEFAULT'][key] = value
+                added = True
+
+        if added:
+            self.persist()
+
+    def persist(self):
+        config_file_path = self.get_filepath()
+
+        with open(config_file_path, 'w') as configfile:
+            self._config.write(configfile)
+
+    def get_filepath(self):
+        return os.path.join(self._config_dir, self.config_filename)
+
+    def set_user_config(self, name, value):
+        self.load()
+        self._config['user'][name] = value
+
+    def reset_user_config(self, name):
+        self.load()
+        self._config['user'][name] = self.default_config[name]
+        self.persist()
+
+    def get_user_config(self, name):
+        self.load()
+        return self._config['user'][name]
+
+    def all_values(self):
+        self.load()
+
+        # iterate over all sections and values and return them in a list
+        result = []
+
+        # add default section
+        for option in self._config['DEFAULT']:
+            result.append(('DEFAULT', option, self._config['DEFAULT'][option]))
+
+        for section in self._config.sections():
+            for option in self._config[section]:
+                result.append((section, option, self._config[section][option]))
+
+        return result
+
+
+config = Config()

gptpr/gh.py

@@ -1,14 +1,24 @@
 import os
 from github import Github
 from InquirerPy import inquirer
+from gptpr.config import config, config_command_example, CONFIG_README_SECTION
 
-GH_TOKEN = os.environ.get('GH_TOKEN')
 
-if not GH_TOKEN:
-    print("Please set GH_TOKEN environment variable")
-    exit(1)
+def _get_gh_token():
+    gh_token = config.get_user_config('GH_TOKEN')
+    if not gh_token:
+        gh_token = os.environ.get('GH_TOKEN')
 
-gh = Github(GH_TOKEN)
+    if not gh_token:
+        print('Please set "gh_token" config. Just run:',
+              config_command_example('gh_token', '[my gh token]'),
+              'more about at', CONFIG_README_SECTION)
+        exit(1)
+
+    return gh_token
+
+
+gh = Github(_get_gh_token())
 
 
 def create_pr(pr_data, yield_confirmation):
@@ -21,7 +31,7 @@ def create_pr(pr_data, yield_confirmation):
 
     if pr_confirmation:
         pr = repo.create_pull(title=pr_data.title, body=pr_data.body,
-                              head=pr_data.branch_info.branch, base='main')
+                              head=pr_data.branch_info.branch, base=pr_data.branch_info.base_branch)
         print("Pull request created successfully: ", pr.html_url)
     else:
         print('cancelling...')

gptpr/gitutil.py

@@ -10,6 +10,7 @@ from InquirerPy.base.control import Choice
 class BranchInfo:
     owner: str
     repo: str
+    base_branch: str
     branch: str
     commits: list
     highlight_commits: list
@@ -70,10 +71,11 @@ def get_branch_info(base_branch, yield_confirmation):
     return BranchInfo(
         owner=owner,
         repo=repo_name,
+        base_branch=base_branch,
         branch=current_branch.name,
         commits=commits,
         highlight_commits=highlight_commits,
-        diff=_get_diff_changes(repo, current_branch.name, yield_confirmation)
+        diff=_get_diff_changes(repo, base_branch, current_branch.name, yield_confirmation)
     )
 
 
@@ -85,7 +87,7 @@ def _branch_exists(repo, branch_name):
 
 
 def _get_diff_messages_against_base_branch(repo, branch, base_branch):
-    # Get commit messages that are in the current branch but not in the main branch
+    # Get commit messages that are in the current branch but not in the base branch
     commits_diff = list(repo.iter_commits(f'{base_branch}..{branch}'))
 
     return [commit.message.strip('\n') for commit in commits_diff]
@@ -147,33 +149,33 @@ def _extract_owner_and_repo(repo_url):
     return owner, '.'.join(repo_info.split('.')[:-1])
 
 
-def _get_diff_changes(repo, branch, yield_confirmation):
+def _get_diff_changes(repo, base_branch, branch, yield_confirmation):
     diff_changes = []
 
-    stats = _get_stats(repo, branch)
+    stats = _get_stats(repo, base_branch, branch)
     files_to_ignore = _get_files_to_ignore(stats, yield_confirmation)
 
     for file_change in stats:
         if file_change.file_path in files_to_ignore:
             continue
 
-        file_diff = repo.git.diff('main', branch, '--', file_change.file_path)
+        file_diff = repo.git.diff(base_branch, branch, '--', file_change.file_path)
 
         diff_changes.append(file_diff)
 
     return '\n'.join(diff_changes)
 
 
-def _get_stats(repo, branch):
+def _get_stats(repo, base_branch, branch):
     '''
-    Get the stats of the difference between the current branch and the main branch
+    Get the stats of the difference between the current branch and the base branch
     '''
 
     # returns:
     # 4       0       README.md
     # 2       0       application/aggregator/aggregator.go
     # 0       257     go.sum
-    diff_index = repo.git.diff('main', branch, '--numstat')
+    diff_index = repo.git.diff(base_branch, branch, '--numstat')
 
     files_changed = []
     for line in diff_index.split('\n'):

gptpr/main.py

@@ -5,6 +5,8 @@ from gptpr.gitutil import get_branch_info
 from gptpr.gh import create_pr
 from gptpr.prdata import get_pr_data
 from gptpr.version import __version__
+from gptpr.config import config, config_command_example, CONFIG_README_SECTION
+from gptpr import consolecolor as cc
 
 
 def run(base_branch='main', yield_confirmation=False, version=False):
@@ -44,9 +46,52 @@ def run(base_branch='main', yield_confirmation=False, version=False):
     create_pr(pr_data, yield_confirmation)
 
 
+def set_config(name, value):
+    name = name.upper()
+    config.set_user_config(name, value)
+    config.persist()
+
+    print('Config value', cc.bold(name), 'set to', cc.yellow(value))
+
+
+def get_config(name):
+    upper_name = name.upper()
+    print('Config value', cc.bold(name), '=', cc.yellow(config.get_user_config(upper_name)))
+
+
+def reset_config(name):
+    upper_name = name.upper()
+    config.reset_user_config(upper_name)
+    print('Config value', cc.bold(name), '=', cc.yellow(config.get_user_config(upper_name)))
+
+
+def print_config():
+    print('Config values at', cc.yellow(config.get_filepath()))
+    print('')
+    print('To set values, just run:', cc.yellow(config_command_example('[config name]', '[value]')))
+    print('More about at', cc.yellow(CONFIG_README_SECTION))
+    print('')
+    current_section = None
+    for section, option, value in config.all_values():
+        if current_section != section:
+            print('')
+            current_section = section
+
+        print(f'[{cc.bold(section)}]', option, '=', cc.yellow(value))
+
+
 def main():
     fire.Fire(run)
 
 
+def run_config():
+    fire.Fire({
+        'set': set_config,
+        'get': get_config,
+        'print': print_config,
+        'reset': reset_config
+    })
+
+
 if __name__ == '__main__':
     main()

gptpr/prdata.py

@@ -4,6 +4,7 @@ import os
 from openai import OpenAI
 
 from gptpr.gitutil import BranchInfo
+from gptpr.config import config
 import gptpr.consolecolor as cc
 
 TOKENIZER_RATIO = 4
@@ -37,6 +38,20 @@ def _get_pr_template():
     return pr_template
 
 
+def _get_open_ai_key():
+    api_key = config.get_user_config('OPENAI_API_KEY')
+
+    if not api_key:
+        api_key = os.environ.get('OPENAI_API_KEY')
+
+    if not api_key:
+        print('Please set "openai_api_key" config, just run:',
+              cc.yellow('gpt-pr-config set openai_api_key [open ai key]'))
+        exit(1)
+
+    return api_key
+
+
 @dataclass
 class PrData():
     branch_info: BranchInfo
@@ -48,7 +63,7 @@ class PrData():
             f'{cc.bold("Repository")}: {cc.yellow(self.branch_info.owner)}/{cc.yellow(self.branch_info.repo)}',
             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("main")}',
+            f'{cc.bold("Base branch")}: {cc.yellow(self.branch_info.base_branch)}',
             f'{cc.bold("PR Description")}:\n{self.body}',
         ])
 
@@ -108,17 +123,14 @@ def get_pr_data(branch_info):
     else:
         messages.append({'role': 'user', 'content': 'Diff changes:\n' + branch_info.diff})
 
-    openai_api_key = os.environ.get('OPENAI_API_KEY')
-
-    if not openai_api_key:
-        print("Please set OPENAI_API_KEY environment variable.")
-        exit(1)
+    client = OpenAI(api_key=_get_open_ai_key())
 
-    client = OpenAI(api_key=openai_api_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='gpt-4-0613',
+        model=openai_model,
         functions=functions,
         function_call={'name': 'create_pr'},
         temperature=0,

gptpr/test_config.py

@@ -0,0 +1,99 @@
+import os
+import configparser
+
+from pytest import fixture
+
+from gptpr.config import Config
+
+
+@fixture
+def temp_config(tmpdir):
+    temp_dir = tmpdir.mkdir('config_dir')
+    config = Config(temp_dir)
+    return config, temp_dir
+
+
+def _check_config(config, temp_dir, config_list):
+    # 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))
+
+    for section, key, value in config_list:
+        assert config_to_test[section][key] == value
+
+
+def test_init_config_file(temp_config):
+    config, temp_dir = temp_config
+    config.load()
+
+    # Check if the file exists
+    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_API_KEY', ''),
+    ])
+
+
+def test_new_default_value_should_be_added(temp_config):
+    config, temp_dir = temp_config
+    config.load()  # data was written to the file
+
+    new_config = Config(temp_dir)
+
+    # Add a new default value
+    new_config.default_config['NEW_DEFAULT'] = 'new_default_value'
+    new_config.load()  # Should update config file...
+
+    _check_config(new_config, temp_dir, [
+        ('DEFAULT', 'NEW_DEFAULT', 'new_default_value'),
+    ])
+
+
+def test_set_user_config(temp_config):
+    config, temp_dir = temp_config
+
+    config.set_user_config('OPENAI_MODEL', 'gpt-3.5')
+    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', 'OPENAI_MODEL', 'gpt-3.5'),
+        ('user', 'OPENAI_API_KEY', ''),
+    ])
+
+
+def test_all_values(temp_config):
+    config, temp_dir = temp_config
+
+    all_values = config.all_values()
+
+    assert all_values == [
+        ('DEFAULT', 'gh_token', ''),
+        ('DEFAULT', 'openai_model', 'gpt-4o'),
+        ('DEFAULT', 'openai_api_key', ''),
+        ('user', 'gh_token', ''),
+        ('user', 'openai_model', 'gpt-4o'),
+        ('user', 'openai_api_key', ''),
+    ]
+
+
+def test_reset_user_config(temp_config):
+    config, temp_dir = temp_config
+
+    config.set_user_config('OPENAI_MODEL', 'gpt-3.5')
+    config.persist()
+
+    config.reset_user_config('OPENAI_MODEL')
+
+    # 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', 'OPENAI_MODEL', 'gpt-4o'),
+        ('user', 'OPENAI_API_KEY', ''),
+    ])

gptpr/version.py

@@ -1 +1 @@
-__version__ = "0.2.0"
+__version__ = "0.3.0"

gpt_pr-0.2.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-gptpr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gptpr/consolecolor.py,sha256=_JmBMNjIflWMlgP2VkCWu6uQLR9oHBy52uV3TRJJgF4,800
-gptpr/gh.py,sha256=y8JgWYTzYzjOWitkEK9Lshjmuv1gV7Tt4DHBrISxAJM,761
-gptpr/gitutil.py,sha256=uhNwwH3r84p5GK1j_19sZEPMyfftEiGpzuV6QZSW6qE,5667
-gptpr/main.py,sha256=rkalqLcc1Nh5WH51w7ayEMIYNoScrRBNVYl3KLuZFdY,1270
-gptpr/prdata.py,sha256=RErSbUyIb0LxCjlUS4KKHoNi2WN94NRO3Cw0mCxtHiU,5824
-gptpr/test_prdata.py,sha256=rSJ-yqOdw-iYdBWyqnA2SXbdrhT8KgIkRTTf9SY1S1g,474
-gptpr/version.py,sha256=Zn1KFblwuFHiDRdRAiRnDBRkbPttWh44jKa5zG2ov0E,22
-gpt_pr-0.2.0.dist-info/METADATA,sha256=oLLwZT78ZD4ymXo5rABD0L_vI8zbJlidiKOu4OzkaNg,2638
-gpt_pr-0.2.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-gpt_pr-0.2.0.dist-info/entry_points.txt,sha256=aXCkyNdoUHfSJXVhRKHj8m09twDfcDmY7xC66u5N3hE,43
-gpt_pr-0.2.0.dist-info/top_level.txt,sha256=DZcbzlsjh4BD8njGcvhOeCZ83U_oYWgCn0w8qx5--04,6
-gpt_pr-0.2.0.dist-info/RECORD,,