gpt-pr 0.2.1__tar.gz → 0.3.0__tar.gz

{gpt-pr-0.2.1 → gpt-pr-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gpt-pr
-Version: 0.2.1
+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

{gpt-pr-0.2.1 → gpt-pr-0.3.0}/README.md

@@ -8,8 +8,9 @@ GPT-PR is an open-source command-line tool designed to streamline your GitHub wo
 
 - [Features](#features)
 - [Prerequisites](#prerequisites)
-- [Installation and Usage](#installation-and-usage)
-- [Authentication & API Keys](#authentication--api-keys)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Usage](#usage)
 - [How to Contribute](#how-to-contribute)
 - [Roadmap](#roadmap)
 
@@ -40,7 +41,7 @@ pip install -U gpt-pr
 
 > Note: Use this command to **update** gpt-pr package to the latest version.
 
-2. Export API keys as environment variables ([Authentication & API Keys](#authentication--api-keys)).
+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:
 
@@ -63,7 +64,7 @@ cd gpt-pr
 pipenv install
 ```
 
-After exporting api keys as environment variables ([Authentication & API Keys](#authentication--api-keys)), you can use GPT-PR within any git project directory. Suppose you've cloned **this project** to `~/workplace/gpt-pr`, here's how you can use it:
+After setting up API keys ([Configuration](#configuration)), you can use GPT-PR within any git project directory. Suppose you've cloned **this project** to `~/workplace/gpt-pr`, here's how you can use it:
 
 ```bash
 PYTHONPATH=~/workplace/gpt-pr/gpt-pr \
@@ -71,34 +72,12 @@ PIPENV_PIPFILE=~/workplace/gpt-pr/Pipfile \
 pipenv run python ~/workplace/gpt-pr/gptpr/main.py --help
 ```
 
-## Usage
-
-### Generating Github Pull Requests
-
-To create a Pull request from your current branch commits to merge with `main` branch, just run:
-
-```
-gpt-pr
-```
-
-If you would like to compare with other base branch that is not `main`, just use `-b` param:
-
-```
-gpt-pr -b my-other-branch
-```
-
-### Usage help
-
-To show help commands:
-
-```
-gpt-pr -h
-```
-
-## Authentication & API Keys
+## Configuration
 
 ### 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`).
+
 To authenticate with GitHub, generate and export a GitHub Personal Access Token:
 
 1. Navigate to [GitHub's Personal Access Token page](https://github.com/settings/tokens).
@@ -106,7 +85,13 @@ To authenticate with GitHub, generate and export a GitHub Personal Access Token:
 3. Provide a description and select the required permissions `repo` for the token.
 4. Click "Generate token" at the bottom of the page.
 5. Copy the generated token.
-6. Export it as an environment variable:
+6. Set `gh_token` config running (supposing your gh token is `ghp_4Mb1QEr9gY5e8Lk3tN1KjPzX7W9z2V4HtJ2b`):
+
+```bash
+gpt-pr-config set gh_token ghp_4Mb1QEr9gY5e8Lk3tN1KjPzX7W9z2V4HtJ2b
+```
+
+Or just export it as an environment variable in your shell initializer:
 
 ```bash
 export GH_TOKEN=your_generated_token_here
@@ -114,6 +99,8 @@ export GH_TOKEN=your_generated_token_here
 
 ### Setting up OpenAI API Key (`OPENAI_API_KEY`)
 
+GPT-PR tool will look for a `OPENAI_API_KEY` env var in current shell OR in gpt-pr config file (at `~/.gpt-pr.ini`).
+
 This project needs to interact with the ChatGPT API to generate the pull request description. So, you need to generate and export an OpenAI API Key:
 
 1. Navigate to [OpenAI's API Key page](https://platform.openai.com/signup).
@@ -121,12 +108,74 @@ This project needs to interact with the ChatGPT API to generate the pull request
 3. Go to the API Keys section and click "Create new key."
 4. Provide a description and click "Create."
 5. Copy the generated API key.
-6. Export it as an environment variable:
+6. Set `openai_api_key` config running (supposing your openai_api_key is `QEr9gY5e8Lk3tN1KjPzX7W9z2V4Ht`):
+
+```bash
+gpt-pr-config set openai_api_key QEr9gY5e8Lk3tN1KjPzX7W9z2V4Ht
+```
+
+Or just export it as an environment variable in your shell initializer:
 
 ```bash
 export OPENAI_API_KEY=your_generated_api_key_here
 ```
 
+### Change OpenAI model
+
+To change OpenAI model, just run:
+
+```bash
+gpt-pr-config set openai_model gpt-3.5-turbo
+```
+
+To see a full list of available models, access [OpenAI Models Documentation](https://platform.openai.com/docs/models)
+
+### See all configs available
+
+To print all default configs and what is being used, just run:
+
+```bash
+gpt-pr-config print
+```
+
+### Reset config
+
+To reset any config to default value, just run:
+
+```bash
+gpt-pr-config reset config-name
+```
+
+Example:
+
+```bash
+gpt-pr-config reset openai_model
+```
+
+## Usage
+
+### Generating Github Pull Requests
+
+To create a Pull request from your current branch commits to merge with `main` branch, just run:
+
+```
+gpt-pr
+```
+
+If you would like to compare with other base branch that is not `main`, just use `-b` param:
+
+```
+gpt-pr -b my-other-branch
+```
+
+### Usage help
+
+To show help commands:
+
+```
+gpt-pr -h
+```
+
 Output:
 ![image](https://github.com/alissonperez/gpt-pr/assets/756802/cc6c0ca4-5759-44ce-ad35-e4e7305b3875)
 

{gpt-pr-0.2.1 → gpt-pr-0.3.0}/gpt_pr.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gpt-pr
-Version: 0.2.1
+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

{gpt-pr-0.2.1 → gpt-pr-0.3.0}/gpt_pr.egg-info/SOURCES.txt

@@ -11,10 +11,12 @@ gpt_pr.egg-info/not-zip-safe
 gpt_pr.egg-info/requires.txt
 gpt_pr.egg-info/top_level.txt
 gptpr/__init__.py
+gptpr/config.py
 gptpr/consolecolor.py
 gptpr/gh.py
 gptpr/gitutil.py
 gptpr/main.py
 gptpr/prdata.py
+gptpr/test_config.py
 gptpr/test_prdata.py
 gptpr/version.py

{gpt-pr-0.2.1 → gpt-pr-0.3.0}/gpt_pr.egg-info/entry_points.txt

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

{gpt-pr-0.2.1 → gpt-pr-0.3.0}/gpt_pr.egg-info/requires.txt

@@ -1,5 +1,5 @@
 cffi==1.15.1
-cryptography==42.0.5
+cryptography==42.0.7
 fire==0.6.0
 pycparser==2.21
 wcwidth==0.2.13
@@ -12,11 +12,10 @@ prompt-toolkit==3.0.43
 openai==1.14.0
 
 [:python_version < "3.11"]
-exceptiongroup==1.2.0
+exceptiongroup==1.2.1
 
 [:python_version < "3.8"]
 cached-property==1.5.2
-typing-extensions==4.7.1
 
 [:python_version == "3.7"]
 importlib-metadata==6.7.0
@@ -28,7 +27,7 @@ six==1.16.0
 deprecated==1.2.14
 
 [:python_version >= "3.5"]
-idna==3.6
+idna==3.7
 
 [:python_version >= "3.6"]
 certifi==2024.2.2
@@ -52,7 +51,8 @@ requests==2.31.0
 smmap==5.0.1
 sniffio==1.3.1
 termcolor==2.3.0
-tqdm==4.66.2
+tqdm==4.66.4
+typing-extensions==4.7.1
 urllib3==2.0.7
 zipp==3.15.0
 

gpt-pr-0.3.0/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()

{gpt-pr-0.2.1 → gpt-pr-0.3.0}/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):

gpt-pr-0.3.0/gptpr/main.py

@@ -0,0 +1,97 @@
+import fire
+from InquirerPy import inquirer
+
+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):
+    '''
+    Create Pull Requests from current branch with base branch (default 'main' branch)
+    '''
+
+    if version:
+        print('Current version:', __version__)
+        return
+
+    branch_info = get_branch_info(base_branch, yield_confirmation)
+
+    if not branch_info:
+        exit(0)
+
+    pr_data = None
+    generate_pr_data = True
+    while generate_pr_data:
+        pr_data = get_pr_data(branch_info)
+        print('')
+        print('#########################################')
+        print(pr_data.to_display())
+        print('#########################################')
+        print('')
+
+        if yield_confirmation:
+            break
+
+        generate_pr_data = not inquirer.confirm(
+            message="Create PR with this? If 'no', let's try again...",
+            default=True).execute()
+
+        if generate_pr_data:
+            print('Generating another PR data...')
+
+    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()

{gpt-pr-0.2.1 → gpt-pr-0.3.0}/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
@@ -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,

gpt-pr-0.3.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', ''),
+    ])

gpt-pr-0.3.0/gptpr/version.py

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

{gpt-pr-0.2.1 → gpt-pr-0.3.0}/requirements.txt

@@ -5,17 +5,17 @@ cached-property==1.5.2; python_version < '3.8'
 certifi==2024.2.2; python_version >= '3.6'
 cffi==1.15.1
 charset-normalizer==3.3.2; python_full_version >= '3.7.0'
-cryptography==42.0.5
+cryptography==42.0.7
 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.0; python_version < '3.11'
+exceptiongroup==1.2.1; python_version < '3.11'
 fire==0.6.0
 gitdb==4.0.11; python_version >= '3.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.6; python_version >= '3.5'
+idna==3.7; python_version >= '3.5'
 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,8 +32,8 @@ 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.2; python_version >= '3.7'
-typing-extensions==4.7.1; python_version < '3.8'
+tqdm==4.66.4; 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
 wrapt==1.16.0; python_version >= '3.6'

{gpt-pr-0.2.1 → gpt-pr-0.3.0}/setup.py

@@ -39,7 +39,10 @@ setup(name='gpt-pr',
       author_email='alissonperez@outlook.com',
       license='MIT',
       entry_points={
-          'console_scripts': ['gpt-pr=gptpr.main:main'],
+          'console_scripts': [
+              'gpt-pr=gptpr.main:main',
+              'gpt-pr-config=gptpr.main:run_config',
+          ],
       },
       packages=find_packages('.'),
       include_package_data=True,

gpt-pr-0.2.1/gptpr/main.py

@@ -1,52 +0,0 @@
-import fire
-from InquirerPy import inquirer
-
-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__
-
-
-def run(base_branch='main', yield_confirmation=False, version=False):
-    '''
-    Create Pull Requests from current branch with base branch (default 'main' branch)
-    '''
-
-    if version:
-        print('Current version:', __version__)
-        return
-
-    branch_info = get_branch_info(base_branch, yield_confirmation)
-
-    if not branch_info:
-        exit(0)
-
-    pr_data = None
-    generate_pr_data = True
-    while generate_pr_data:
-        pr_data = get_pr_data(branch_info)
-        print('')
-        print('#########################################')
-        print(pr_data.to_display())
-        print('#########################################')
-        print('')
-
-        if yield_confirmation:
-            break
-
-        generate_pr_data = not inquirer.confirm(
-            message="Create PR with this? If 'no', let's try again...",
-            default=True).execute()
-
-        if generate_pr_data:
-            print('Generating another PR data...')
-
-    create_pr(pr_data, yield_confirmation)
-
-
-def main():
-    fire.Fire(run)
-
-
-if __name__ == '__main__':
-    main()

gpt-pr-0.2.1/gptpr/version.py

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