Rebranding aiy to oai

draupner1 · draupner1 · commit ca02591eafac · 2023-04-14T15:27:16.000+02:00
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1,3 +1,3 @@
 # These are supported funding model platforms
 
-github: [visioninit]
+github: [draupner1]
diff --git a/.github/workflows/build-linux.yml b/.github/workflows/build-linux.yml
@@ -19,23 +19,23 @@ jobs:
           pip install pyinstaller
       - name: Build Linux Binary
         run: |
-          pyinstaller --onefile aiy.py --name aiy --distpath dist/
+          pyinstaller --onefile oai.py --name oai --distpath dist/
           cp LICENSE dist/
-          mkdir out && cd dist && tar -zcvf ../out/aiy-linux-binary.tar.gz *
+          mkdir out && cd dist && tar -zcvf ../out/oai-linux-binary.tar.gz *
       - name: Generate change log
         run: |
-          git clone https://github.com/visioninit/aiy
-          cd aiy
+          git clone https://github.com/draupner1/oai
+          cd oai
           git log $(git describe --tags --abbrev=0)..HEAD --pretty=format:' * %s' | sed '/Merge/d' > changelog.txt
           cp changelog.txt ..
           cd ..
-          rm -fr aiy
+          rm -fr oai
       - name: set package version
         run: |
           echo "***************************************"
-          dist/aiy --version
+          dist/oai --version
           echo "***************************************"
-          echo "DEBIAN_PACKAGE_VERSION=$(dist/aiy --version | awk -F: '{print $2}' | tr -d ' ')+$(date +%Y%m%d%H%M)" >> $GITHUB_ENV
+          echo "DEBIAN_PACKAGE_VERSION=$(dist/oai --version | awk -F: '{print $2}' | tr -d ' ')+$(date +%Y%m%d%H%M)" >> $GITHUB_ENV
       - name: Build Debian Package
         run: |
           sudo apt-get update -y
@@ -50,7 +50,7 @@ jobs:
         with:
           name: Linux Binary
           path: |
-            out/aiy-linux-binary.tar.gz
+            out/oai-linux-binary.tar.gz
       - name: Upload Release Linux .deb
         uses: actions/upload-artifact@v3
         with:
diff --git a/.github/workflows/build-win.yml b/.github/workflows/build-win.yml
@@ -21,8 +21,8 @@ jobs:
 #          pip install pyinstaller
 #      - name: Build Windows Binary
 #        run: |
-#          pyinstaller --onefile aiy.py --distpath dist/
-#          mkdir out && cd dist && Compress-Archive -Path . -DestinationPath ../out/aiy-windows-standalone.zip
+#          pyinstaller --onefile oai.py --distpath dist/
+#          mkdir out && cd dist && Compress-Archive -Path . -DestinationPath ../out/oai-windows-standalone.zip
 #          cd ..
       - name: Install pynsist
         run: |
@@ -38,14 +38,14 @@ jobs:
         run: |
           cp resources/install/win/installer.cfg installer.cfg
           pynsist installer.cfg
-          cp build/nsis/aiy-windows-installer.exe out\aiy-windows-installer.exe
+          cp build/nsis/oai-windows-installer.exe out\oai-windows-installer.exe
       - name: Upload Release Windows
         uses: actions/upload-artifact@v3
         with:
           name: Windows Binary
-          path: out/aiy-windows-installer.exe
+          path: out/oai-windows-installer.exe
 #      - name: Upload Release Windows
 #        uses: actions/upload-artifact@v3
 #        with:
 #          name: Windows Binary
-#          path: out/aiy-windows-standalone.zip
+#          path: out/oai-windows-standalone.zip
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-AIY - Ask question from bash shell and get tailored documentation response 
+oai - Ask question from bash shell and get tailored documentation response 
 ========================================
-![image](https://user-images.githubusercontent.com/654993/216212025-5e9e6725-b042-4010-8f4d-649706565b80.png)
+![image](https://user-images.githubusercontent.com/3023775/232043126-34d4fcae-65d8-449a-9738-7f9726f55d11.png)
 
-AIY is a command line tool that uses OpenAI's language model to provide a documentation-like experience to users. With Aiy, users can get answers to their technical questions and receive step-by-step guidance to complete tasks.
+oai is a command line tool that uses OpenAI's language model to provide a documentation-like experience to users. With oai, users can get answers to their questions and receive step-by-step guidance to complete tasks.
 
 If your organization appreciates this project or is looking for someone to help with your systems and infrastructure, please reach out to me at [LinkedIn](https://www.linkedin.com/in/riddiough/).
 
@@ -16,42 +16,21 @@ If your organization appreciates this project or is looking for someone to help
 4.  Go to the API Key section ([https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys))
 5.  Create a new secret key
 6.  Copy the API key
-7.  When running Aiy the first time, you will be prompted for your key
+7.  When running oai the first time, you will be prompted for your key
   
 </details>
 
-Install on Debian based systems (Debain, Mint, Ubuntu)
--------------------
-
-#### 1. Install our official public software signing key
-
-```
-wget -O- https://ppa.aimodels.org/aiy/visioninit.gpg | gpg --dearmor > visioninit.gpg
-cat visioninit.gpg | sudo tee -a /usr/share/keyrings/visioninit.gpg > /dev/null
-```
-
-#### 2. Add our repository to your list of repositories
-
-```
-echo 'deb [signed-by=/usr/share/keyrings/visioninit.gpg] https://ppa.aimodels.org/aiy ./' |\
-  sudo tee -a /etc/apt/sources.list.d/aimodels.list
-```
-  
-#### 3. Update your package database and install aiy
-
-```sudo apt update && sudo apt install aiy```
-
 ( Anyone who might be able to help me get this set up with a snap or flatpack? I've been working on trying to set up these workflows )
 
 Quick Start
 -----------
 
-1. Clone repository `git clone https://github.com/visioninit/aiy.git'
-2. Change directory `cd aiy`
+1. Clone repository `git clone https://github.com/draupner1/oai.git'
+2. Change directory `cd oai`
 3. Install dependencies `pip install -r requirements.txt`
-4. Run `python aiy` and enter OpenAI key as prompted to complete setup
-5. Prompt with `python aiy` or `python aiy "how do I..."` 
-
+4. Run `python oai` and enter OpenAI key as prompted to complete setup
+5. Prompt with `python oai` or `python oai "how do I..."` 
+6. Optional: Install link in PATH, or in ~/.local/bin/
 <details>
   <summary>Python Requirements</summary>
 
@@ -64,18 +43,18 @@ Quick Start
 Usage
 -----
 
-To use AIY, simply run the script and provide a prompt that describes the task you want to complete or the question you want to ask.
+To use oai, simply run the script and provide a prompt that describes the task you want to complete or the question you want to ask.
 
 For example:
 
-`python aiy.py "How to install and run a web server on Ubuntu?"`
+`python oai.py "How to install and run a web server on Ubuntu?"`
 
 If you have added the script to your path, you can run it from anywhere:
 
-`aiy "How to install and run a web server on Ubuntu?"`
+`oai "How to install and run a web server on Ubuntu?"`
 
-![image](https://user-images.githubusercontent.com/654993/216211945-068bb6a6-b937-44ae-a09c-b75aa8f4d9d6.png)
-![image](https://user-images.githubusercontent.com/654993/216211997-167f131f-023b-4b90-8f06-fc7a0e377f6b.png)
+![image](https://user-images.githubusercontent.com/3023775/232043124-5bcdc240-4b86-4397-9355-ff0a8dc2f3fe.png)
+![image](https://user-images.githubusercontent.com/3023775/232043119-d25b1e93-c99b-48e6-b9c6-ccbc1270a800.png)
 
 Options
 -------
@@ -87,4 +66,4 @@ Options
 Contributing
 ------------
 
-If you'd like to contribute to AIY, feel free to create a pull request or open an issue. All contributions are welcome!
+If you'd like to contribute to oai, feel free to create a pull request or open an issue. All contributions are welcome!
diff --git a/oai.py b/oai.py
@@ -31,7 +31,7 @@ def post_completion(openai_response):
     if config.get_expert_mode() != "true":
         openai_response += '\n\n[Notice] OpenAI\'s models have limited knowledge after 2020. Commands and versions' \
                            'may be outdated. Recommendations are not guaranteed to work and may be dangerous.' \
-                           'To disable this notice, switch to expert mode with `aiy --expert`.'
+                           'To disable this notice, switch to expert mode with `oai --expert`.'
     return openai_response
 
 def get_session():
@@ -54,12 +54,12 @@ def main():
     desc = "This tool sends a query to OpenAIs Chat API from the command line.\n\n"\
            "A new chat session is started with -n <pre-info> and gives the opportunity to\n"\
            "provide pre-information to your question\n\n"\
-           "Report any issues at: https://github.com/visioninit/aiy/issues"
+           "Report any issues at: https://github.com/draupner1/oai/issues"
     epilog = "Please note that the responses from OpenAI's API are not guaranteed to be accurate and " \
             "use of the tool is at your own risk.\n"
 
     # Create an ArgumentParser object
-    parser = argparse.ArgumentParser(prog='aiy - CLI assistant',
+    parser = argparse.ArgumentParser(prog='oai - CLI assistant',
                                      formatter_class=argparse.RawTextHelpFormatter,
                                      description=desc,
                                      epilog=epilog)
@@ -72,7 +72,7 @@ def main():
     parser.add_argument('-x', '--expert', action="store_true", help='Toggle warning', dest='expert')
     parser.add_argument('-i', '--key', action="store_true", help='Reset API key', dest='apikey')
     parser.add_argument('-v', '--version', action="store_true", help=f'Get Version (hint: it\'s {version})', dest='version')
-    parser.add_argument('--licenses', action="store_true", help='Show Aiy & Third Party Licenses', dest='licenses')
+    parser.add_argument('--licenses', action="store_true", help='Show oai & Third Party Licenses', dest='licenses')
     parser.add_argument('prompt', type=str, nargs='?', help='Prompt to send')
     args = parser.parse_args()
 
@@ -107,7 +107,7 @@ def main():
         sys.exit()
 
     if args.version:
-        console.print("aiy version: " + version)
+        console.print("oai version: " + version)
         sys.exit()
  
     if args.licenses:
diff --git a/resources/build/deb/changelog b/resources/build/deb/changelog
@@ -1,5 +1,5 @@
-aiy (0~0) unstable; urgency=medium
+oai (0~0) unstable; urgency=medium
 
   * Initial release.
 
- -- Justin Riddiough <jriddiough@gmail.com>  Fri, 03 Feb 2023 00:51:37 +0100
+ -- Anders Karlsson <draupnerinfo@gmail.com>  Fri, 14 Apr 2023 10:58:36 +0100
diff --git a/resources/build/deb/control b/resources/build/deb/control
@@ -1,18 +1,18 @@
-Source: aiy
+Source: oai
 Section: science
 Priority: optional
-Maintainer: Justin Riddiough <jriddiough@gmail.com>
+Maintainer: Anders Karlsson <draupnerinfo@gmail.com>
 Build-Depends: debhelper-compat (= 12)
 Standards-Version: 4.6.0
-Homepage: https://aimodels.org/
-Vcs-Browser: https://github.com/visioninit/aiy
-Vcs-Git: https://github.com/visioninit/aiy.git
+Homepage: https://draupnerdata.org/
+Vcs-Browser: https://github.com/draupner1/oai
+Vcs-Git: https://github.com/draupner1/oai.git
 Rules-Requires-Root: binary-targets
 
-Package: aiy
+Package: oai
 Architecture: any
 Pre-Depends: ${misc:Pre-Depends}
 Depends: ${misc:Depends},
          ${shlibs:Depends}
-Description: Aiy - AI Assistant
- aiy is a powerful command-line tool that utilizes AI models to solve technical questions
+Description: oai - ChatGPT in CLI
+ oai is a powerful command-line tool that utilizes OpenAI models to solve questions
diff --git a/resources/build/deb/copyright b/resources/build/deb/copyright
@@ -1,13 +1,13 @@
 Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
-Upstream-Name: Aiy
-Upstream-Contact: https://aimodels.org/
-Source: https://github.com/visioninit/aiy
+Upstream-Name: Oai
+Upstream-Contact: https://draupnerdata.org/
+Source: https://github.com/draupner1/oai
 Comment: The binary file is created via pyinstaller and ships copies of
  multiple PyPi modules, released under various OSS licenses. Please refer
- to the output of `aiy --license` for a full list of licenses.
+ to the output of `oai --license` for a full list of licenses.
 
 Files: *
-Copyright: 2022, Justin Riddiough (VisionInit)
+Copyright: 2023, Anders Karlsson (DraupnerData)
 License: Apache-2.0
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@ Comment: The full text of the Apache 2.0 license can be found in the
  file '/usr/share/common-licenses/Apache-2.0'.
 
 Files: resources/icons/*
-Copyright: 2022, Justin Riddiough (VisionInit)
+Copyright: 2023, Anders Karlsson (DraupnerData)
 License: other
  Logos and images are not licensed under Apache 2.0 License. Please ask
  the copyright holder for more information.
diff --git a/resources/build/deb/install b/resources/build/deb/install
@@ -1 +1 @@
-dist/aiy usr/bin/
+dist/oai usr/bin/
diff --git a/resources/build/deb/oai.sh b/resources/build/deb/oai.sh
@@ -1,6 +1,6 @@
 #!/bin/sh
 # vim: set ts=4 sw=4 ai si et:
 
-exec /usr/libexec/aiy/aiy $@
+exec /usr/libexec/oai/oai $@
 
 exit 0
diff --git a/resources/build/deb/upstream/metadata b/resources/build/deb/upstream/metadata
@@ -1,7 +1,7 @@
 ---
 Archive: GitHub
-Bug-Database: https://github.com/visioninit/aiy/issues
-Bug-Submit: https://github.com/visioninit/aiy/issues/new
-Changelog: https://github.com/visioninit/aiy/commits/
-Repository: https://github.com/visioninit/aiy.git
-Repository-Browse: https://github.com/visioninit/aiy
+Bug-Database: https://github.com/draupner1/oai/issues
+Bug-Submit: https://github.com/draupner1/oai/issues/new
+Changelog: https://github.com/draupner1/oai/commits/
+Repository: https://github.com/draupner1/oai.git
+Repository-Browse: https://github.com/draupner1/oai
diff --git a/resources/build/flatpak/build.sh b/resources/build/flatpak/build.sh
@@ -2,4 +2,4 @@ cd resources/build/flatpak
 pip install --upgrade pip
 pip install requirements-parser
 python3 flatpak-pip-generator  --runtime='org.freedesktop.Sdk//22.08' --requirements-file='requirements.txt' --output pypi-dependencies
-flatpak-builder --state-dir='../../../../flat_state' --user --install --force-clean ../../../../flat ../../../org.aimodels.aiy.json --force-clean
+flatpak-builder --state-dir='../../../../flat_state' --user --install --force-clean ../../../../flat ../../../org.draupnerdata.oai.json --force-clean
diff --git a/resources/config.py b/resources/config.py
@@ -19,7 +19,7 @@ def check_config(console):
     if not get_api_key():
         os_uname = os.uname()
 
-        console.print("--[Aiy - CLI Assistant]-------\n"
+        console.print("--[oai - CLI Assistant]-------\n"
                       "\n"
                       "OpenAI API key not found. Please follow these steps to get the API key:\n"
                       "  1. Go to OpenAI website (https://openai.com/api/login)\n"
@@ -28,18 +28,12 @@ def check_config(console):
                       "  4. Create a New Secret Key\n"
                       "  4. Copy the API key\n"
                       "\n"
-                      "The queries sent to OpenAI contain your OS and architecture information, as well as the "
-                      "question you asked. This is so that responses will be catered to you as much as possible\n"
-                      "Example:\n"
-                      "  " + platform.platform() + "\n"
-                      "  " + os_uname.version + "\n"
-                      "  " + os.environ.get("SHELL", "").split("/")[-1] + "\n"
                       "Please be advised that responses from OpenAI's API are not guaranteed to be accurate. "
                       "Use at your own risk.\n")
         key = prompt_new_key()
         set_api_key(key)
     if not get_model():
-        set_model("text-davinci-003")
+        set_model("chatgpt-3.5-turbo")
     if not get_expert_mode():
         set_expert_mode("false")
 
@@ -130,5 +124,5 @@ def get_expert_mode():
     _config_dir = os.path.dirname(os.path.realpath(__file__))
     _config_file = os.path.join(os.path.dirname(os.path.realpath(__file__)), ".env")
 else:
-    _config_dir = appdirs.user_config_dir("aiy-config")
-    _config_file = os.path.join(_config_dir, "aiy-config.ini")
+    _config_dir = appdirs.user_config_dir("oai-config")
+    _config_file = os.path.join(_config_dir, "oai-config.ini")
diff --git a/resources/install/win/installer.cfg b/resources/install/win/installer.cfg
@@ -1,9 +1,9 @@
 [Application]
-name=aiy
+name=oai
 version=0.5.0
 # How to launch the app - this calls the 'main' function from the 'myapp' package:
-entry_point=aiy:main
-publisher=VisionInit
+entry_point=oai:main
+publisher=DraupnerData
 icon=resources/icons/icon.ico
 license_file=LICENSE
 
@@ -25,7 +25,7 @@ extra_wheel_sources = pynsist_whls/
 [Build]
 
 nsi_template=resources/install/win/installer.nsi
-installer_name=aiy-windows-installer.exe
+installer_name=oai-windows-installer.exe
 
 [Command aimm]
-entry_point=aiy:main
+entry_point=oai:main
diff --git a/snapcraft.yaml b/snapcraft.yaml
@@ -1,9 +1,9 @@
-name: aiyy
+name: oai
 base: core20
 version: '0.2'
-summary: CLI assistant for technical information
+summary: CLI OpenAI assistant for questions
 description: |
-  Get technical information on the command line with ease using AIY. Simply type in your question as the prompt and 
+  Get information on the command line with ease using OAI. Simply type in your question as the prompt and 
   receive a beautifully formatted and helpful response. This snap also has options for resetting the API key and 
   toggling warnings.
 architectures:
@@ -12,10 +12,10 @@ grade: devel
 confinement: devmode
 
 apps:
-  aiyy:
-    command: bin/aiyy
+  oai:
+    command: bin/oai
 
 parts:
-  aiyy:
+  oai:
     plugin: python
-    source: https://github.com/visioninit/aiy.git
+    source: https://github.com/draupner1/oai.git

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# These are supported funding model platforms`
`2`	`2`
`3`		`-github: [visioninit]`
	`3`	`+github: [draupner1]`