Initial Commit

Author: code-yeongyu

.gitignore

@@ -0,0 +1,205 @@
+# Created by https://www.toptal.com/developers/gitignore/api/git,python,visualstudiocode
+# Edit at https://www.toptal.com/developers/gitignore?templates=git,python,visualstudiocode
+
+### Git ###
+# Created by git for backups. To disable backups in Git:
+# $ git config --global mergetool.keepBackup false
+*.orig
+
+# Created by git when using merge tools for conflicts
+*.BACKUP.*
+*.BASE.*
+*.LOCAL.*
+*.REMOTE.*
+*_BACKUP_*.txt
+*_BASE_*.txt
+*_LOCAL_*.txt
+*_REMOTE_*.txt
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+# poetry.toml
+
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/git,python,visualstudiocode

.type_stubs/.gitkeep

@@ -0,0 +1,48 @@
+{
+    "[python]": {
+        "editor.insertSpaces": true,
+        "editor.tabSize": 4,
+        "editor.rulers": [
+            119
+        ],
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": true,
+            "source.fixAll": true
+        }
+    },
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python3",
+    "python.envFile": "${workspaceFolder}/.venv",
+    "python.languageServer": "Pylance",
+    "python.formatting.provider": "yapf",
+    "python.formatting.yapfPath": "${workspaceFolder}/.venv/bin/yapf",
+    "python.linting.enabled": true,
+    "python.linting.pylintEnabled": true,
+    "python.linting.pylintPath": "${workspaceFolder}/.venv/bin/pylint",
+    "python.linting.mypyEnabled": true,
+    "python.linting.mypyArgs": [
+        "--config-file ${workspaceFolder}/pyproject.toml"
+    ],
+    "isort.path": [
+        "${workspaceFolder}/.venv/bin/isort"
+    ],
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestArgs": [
+        "."
+    ],
+    "emeraldwalk.runonsave": {
+        "commands": [
+            {
+                "match": "\\.py$",
+                "cmd": "${workspaceFolder}/.venv/bin/unify --in-place ${file}"
+            },
+            {
+                "match": "\\.py$",
+                "cmd": "${workspaceFolder}/.venv/bin/pautoflake --in-place ${file}"
+            }
+        ]
+    },
+    "[toml]": {
+        "editor.defaultFormatter": "tamasfe.even-better-toml"
+    },
+    "python.linting.mypyPath": "${workspaceFolder}/.venv/bin/mypy"
+}

.vscode/settings.json

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 YeonGyu Kim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the Software), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -0,0 +1,40 @@
+# AiShell
+
+A simple Python code that connects to OpenAI's ChatGPT and executes the returned results.
+
+## Examples
+
+### Simple Utility commands
+
+![terminal example](images/aishell_example.png)
+
+### A git helper
+
+![terminal example](images/aishell_example2.png)
+
+### A powerful git assistant: "add all files & amend last commit & push"
+
+![terminal example3](images/aishell_example3.png)
+
+
+## Prerequisites
+
+- Python 3.9.5
+- Poetry
+- OpenAI API Key
+
+## Getting Started
+
+1. Create account on OpenAI
+1. Go to <https://platform.openai.com/account/api-keys>, Copy API key
+1. Set the API key as an environment variable OPENAI_API_KEY or inject it directly into the code by editing it.
+1. Clone this repository to your local machine using git clone <repository-url>
+1. Install the dependencies by running poetry install in your terminal
+1. Start AiShell by running poetry run python3 aishell/main.py
+
+## Contributions
+
+Feel free to contribute to AiShell by adding more functionality or fixing bugs. Some suggestions for contributions include:
+
+- Adding the ability to execute AiShell as a system command aishell <command>
+- Publishing AiShell to PyPI so that others can easily download and use it

README.md

@@ -0,0 +1,50 @@
+#!/usr/bin/env python
+
+from revChatGPT.Official import Chatbot
+
+import os
+import typer
+
+API_KEY = os.environ.get('OPENAI_API_KEY') or ''
+
+
+def make_executable_command(command: str) -> str:
+    # starting '\n' or trailing '\n' should be replaced as ''
+    # starting ' ' or trailing ' ' should be replaced as ''
+    if command.startswith('\n'):
+        command = command[1:]
+    if command.endswith('\n'):
+        command = command[:-1]
+    command = command.strip()
+    return command
+
+
+def ask_chatgpt(text: str) -> str:
+    chatbot = Chatbot(api_key=API_KEY)
+    response_text: str = chatbot.ask(text)['choices'][0]['text']
+    return make_executable_command(response_text)
+
+
+def get_os() -> str:
+    return os.uname()[0]
+
+
+def make_prompt(requirements: str) -> str:
+    return f'''You are now a translater from human language to {get_os} shell command.
+    No explanation required, respond with only the raw shell command.
+    What should I type to shell for: {requirements}'''
+
+
+app = typer.Typer()
+
+
+@app.command()
+def ask(text: str):
+    question = make_prompt(text)
+    response = ask_chatgpt(question)
+    typer.echo(f'\033[3mexecuted: {response}\033[0m')
+    os.system(response)
+
+
+if __name__ == '__main__':
+    app()

aishell/__init__.py

@@ -0,0 +1,2 @@
+def test_one_plus_one():
+    assert 1 + 1 == 2