initial project setup

Author: belda

.github/workflows/python-publish.yml

@@ -0,0 +1,31 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.gitignore

@@ -1,5 +1,30 @@
 venv
+.idea
+__pycache__
+*.py[cod]
+data.pickle
+.env
+db.sqlite3
 *.pyc
-.svn
-.cvs
-tmp/*
+.DS_Store
+__pycache__/
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jakub Beleščák
+
+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.

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include shelllangchain *

README.md

@@ -0,0 +1,54 @@
+# GPT for your terminal
+
+Do you want to use ChatGPT in your terminal? Well, now you can!
+Do you always forget the syntax for a for loop? Well, now you can ask GPT to write it for you!
+It is a super fast way to get your commands quickly written for you.
+
+## Usage
+```
+$ slc get all images in folder and crop them to square while preserving aspec ratio
+
+mogrify -path <output_directory> -resize '500x500^' -gravity center -extent 500x500 <input_directory/*.jpg>
+
+To get all images in a folder and crop them to a square while preserving the aspect ratio, you can use the mogrify command from the ImageMagick package.
+
+Here's how the command works:
+
+- mogrify is a command-line tool used to resize and modify images.
+- -path <output_directory> specifies the output directory where the modified images will be saved.
+- -resize '500x500^' resizes the images to fit within a 500x500 square, preserving the aspect ratio. The '^' symbol is used to only resize images that are larger than the specified dimensions.
+- -gravity center -extent 500x500 crops the resized images to a 500x500 square by adding whitespace or extending the image if necessary.
+- <input_directory/*.jpg> specifies the input directory where the original images are located. Replace '.jpg' with the appropriate file extension if needed.
+
+Make sure to replace <input_directory> and <output_directory> with the actual directory paths on your system.
+$ 
+```
+After that the command is ready in your clipboard and you can paste it in your terminal.
+
+## Requirements
+- OpenAI API key (https://help.openai.com/en/articles/4936850-where-do-i-find-my-api-key)
+
+## Installation
+
+### Using pip
+```
+pip install --user shelllangchain
+```
+Depending on your shell you might need to add the following line to your .bashrc or .zshrc file:
+```
+export OPENAI_API_KEY=<your_openai_api_key>
+```
+You can now use the `slc` command in your terminal.
+
+
+### From source
+If you want to modify this script, or replace chat-gpt-3.5 with another model, you can do so by cloning this repo and 
+modifying the scripts.
+
+Clone this repo and add the scripts to your PATH variable (bin folder should be on your $PATH).
+create a .env file in the root of this repo and add the following line:
+
+```
+OPENAI_API_KEY=your_openai_api_key
+```
+

requirements.txt

@@ -0,0 +1,4 @@
+requests
+langchain
+pyperclip
+dotenv

setup.py

@@ -0,0 +1,32 @@
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="shelllangchain",
+    version="0.1.6",
+    author="Belda",
+    author_email="[email protected]",
+    description="Natural language to shell command converter",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/belda/shelllangchain",
+    packages=setuptools.find_packages(),
+    include_package_data=True,
+    zip_safe=False,
+    entry_points={
+        "console_scripts": [
+            "slc=shelllangchain.langchain_bash_helper:main"
+        ]
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.4',
+    install_requires = [
+        ['langchain', 'pyperclip', 'requests','dotenv']
+    ]
+)

shelllangchain/__init__.py

@@ -0,0 +1,47 @@
+'''
+Simple local script, that converts natural language to bash commands directly on commandline and copies it to clipboard.
+'''
+import json
+import os
+import sys
+
+import pyperclip
+from langchain.chat_models import ChatOpenAI
+from langchain.schema import SystemMessage
+from dotenv import load_dotenv
+from langchain_core.messages import HumanMessage, AIMessage
+
+load_dotenv()
+
+OPENAI_API_KEY = os.environ.get('OPENAI_API_KEY','')
+
+
+def get_bash_command(prompt : str) -> [str, str]:
+    ''' returns the bash command and explanation for the commands parameters '''
+    chat = ChatOpenAI()
+    messages = [
+        SystemMessage(content="""  You are a assistant and an expert on linux commands and bash. When asked in natural language, you
+                        will provide the most fitting command and an explanation of the command workings in a structured way."""),
+        HumanMessage(content="list all files in a current directory including their information"),
+        AIMessage(content=json.dumps({"command": "ls -la",
+                                      "explanation": "All files are listed using the inbuilt command \033[0;32mls\033[0m (is short for list).\n\t\033[0;32m-a\033[0m means all files\n\t\033[0;32m-l\033[0m means long format, \033[0;32m-l\033[0m means long format\n\t\033[0;32m-a\033[0m means all files"})),
+        HumanMessage(content=prompt)
+    ]
+    rsp = json.loads(chat(messages).content)
+    return rsp['command'], rsp['explanation']
+
+
+def main():
+    ''' parses the arguments and processes fiels '''
+    if OPENAI_API_KEY == '':
+        print("You need to have your OPENAI_API_KEY defined in your environment variables", file=sys.stderr)
+        sys.exit(1)
+
+    prompt = (" ").join(sys.argv[1:])
+    command, explanation = get_bash_command(prompt)
+    pyperclip.copy(command)
+    print(f"\033[0;32m{command}\033[0m\n\n{explanation}\n\n")
+
+
+if __name__ == "__main__":
+    main()