ape-linux 0.1.0__py3-none-any.whl

ape/__init__.py

@@ -0,0 +1 @@
+"""AI for Linux commands."""

ape/cli.py

@@ -0,0 +1,61 @@
+import subprocess
+from typing import Annotated
+
+import openai
+import rich.console
+import typer
+
+from . import llm
+
+app = typer.Typer(add_completion=False, pretty_exceptions_enable=False)
+
+
+@app.command()
+def run(
+    query: Annotated[str, typer.Argument(help="Query describing a Linux task.")],
+    model: Annotated[
+        str,
+        typer.Option(
+            help="OpenAI model. See https://platform.openai.com/docs/models.",
+        ),
+    ] = "gpt-4o",
+    execute: Annotated[
+        bool,
+        typer.Option(
+            help="Run the command if suggested. Dangerous!",
+        ),
+    ] = False,
+):
+    """Suggest a command for a Linux task described in QUERY.
+
+    Example: ape "Create a symbolic link named 'win' pointing to /mnt/c/Users/jdoe"
+
+    Output : ln -s /mnt/c/Users/jdoe win
+    """
+
+    console = rich.console.Console()
+
+    try:
+        with console.status("[bold][blue]Processing ...", spinner="monkey"):
+            answer = llm.find_answer(query, model)
+    except llm.EmptyQueryError:
+        typer.echo("Query cannot be empty.", err=True)
+        raise typer.Exit(1)
+    except llm.OpenAIAPIStatusError as e:
+        typer.echo(
+            f"OpenAI {e.status_code} error: {e.message}",
+            err=True,
+        )
+        raise typer.Exit(1)
+    except openai.OpenAIError as e:
+        typer.echo(f"Generic OpenAI error: {e}", err=True)
+        raise typer.Exit(1)
+
+    if llm.no_answer(answer):
+        typer.echo(answer, err=True)
+        raise typer.Exit(1)
+
+    typer.echo(answer)
+
+    if execute:
+        subprocess.check_call(answer, shell=True)

ape/llm.py

@@ -0,0 +1,76 @@
+import openai
+
+SYSTEM_PROMPT = """\
+You are a Linux command assistant. You will be asked a question about how to perform a task in Linux or Unix-like operating systems. You should only include in your answer the command or commands to perform the task. If you do not know how to perform the task, output "Please rephrase.".
+
+Here are a few examples.
+
+Question: List all the files and directories in projects in my home directory
+Answer: ls ~/projects
+
+Question: What is my username?
+Answer: whoami
+
+Question: Find all files with the extension .txt under the current working directory
+Answer: find . -name "*.txt"
+
+Question: What is the captial of France?
+Answer: Please rephrase.
+
+Question: Tell me a story
+Answer: Please rephrase."""  # noqa: E501
+
+USER_PROMPT_TEMPLATE = """\
+Question: {query}
+Answer:"""
+
+
+class EmptyQueryError(ValueError):
+    pass
+
+
+class OpenAIAPIStatusError(Exception):
+    def __init__(self, message: str, status_code: int) -> None:
+        self.message = message
+        self.status_code = status_code
+        super().__init__(self.message, self.status_code)
+
+
+def make_user_prompt(query: str) -> str:
+    query = query.strip()
+    if query == "":
+        raise EmptyQueryError()
+    return USER_PROMPT_TEMPLATE.format(query=query)
+
+
+def call_llm(user_prompt: str, model: str, system_prompt: str) -> str | None:
+    client = openai.OpenAI()
+
+    try:
+        response = client.chat.completions.create(
+            model=model,
+            messages=[
+                {"role": "system", "content": system_prompt},
+                {"role": "user", "content": user_prompt},
+            ],
+        )
+    except openai.APIStatusError as e:
+        raise OpenAIAPIStatusError(e.response.json()["error"]["message"], e.status_code)
+
+    answer = response.choices[0].message.content
+    return answer
+
+
+def find_answer(query: str, model: str) -> str:
+    user_prompt = make_user_prompt(query)
+
+    answer = call_llm(user_prompt, model, SYSTEM_PROMPT)
+
+    if answer is None:
+        return "Please rephrase."
+    else:
+        return answer  # this can also be "Please rephrase."
+
+
+def no_answer(answer: str) -> bool:
+    return answer.strip().lower().rstrip(".") == "please rephrase"

ape_linux-0.1.0.dist-info/LICENSE

@@ -0,0 +1,19 @@
+Copyright 2024 Seto Balian
+
+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.

ape_linux-0.1.0.dist-info/METADATA

@@ -0,0 +1,124 @@
+Metadata-Version: 2.1
+Name: ape-linux
+Version: 0.1.0
+Summary: AI for Linux commands
+Home-page: https://github.com/sbalian/ape
+License: MIT
+Keywords: ai,llm,linux,openai
+Author: Seto Balian
+Author-email: seto.balian@gmail.com
+Maintainer: Seto Balian
+Maintainer-email: seto.balian@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Requires-Dist: openai (>=1.30.3,<2.0.0)
+Requires-Dist: rich (>=13.7.1,<14.0.0)
+Requires-Dist: typer (>=0.12.3,<0.13.0)
+Project-URL: Repository, https://github.com/sbalian/ape
+Description-Content-Type: text/markdown
+
+# Ape
+
+Ape is an AI for Linux commands.
+
+```sh
+ape "Find all the important PDF files in user/projects. An important PDF file has 'attention' in its name. Write the results to important_files.txt and then move it to Documents."
+```
+
+Output:
+
+```text
+find ~/user/projects -type f -name "*attention*.pdf" > important_files.txt && mv important_files.txt ~/Documents/
+```
+
+Currently, only [OpenAI](https://openai.com/api/) is supported.
+
+To install:
+
+```bash
+pipx install ape-linux
+```
+
+Next, set your API key:
+
+```bash
+export OPENAI_API_KEY=key
+```
+
+To run:
+
+```bash
+ape "Create a symbolic link called win pointing to /mnt/c/Users/jdoe"
+```
+
+Output:
+
+```text
+ln -s /mnt/c/Users/jdoe win
+```
+
+Another example:
+
+```bash
+ape "Delete all the .venv directories under projects/"
+```
+
+Output:
+
+```text
+find projects/ -type d -name ".venv" -exec rm -rf {} +
+```
+
+If you try to ask something unrelated to Linux commands, you should get "Please rephrase." printed:
+
+```bash
+ape "Tell me about monkeys"
+```
+
+Output:
+
+```text
+Please rephrase.
+```
+
+You can change the model using `--model`. The default is `gpt-4o`.
+See [here](https://platform.openai.com/docs/models) for a list of models. For example:
+
+```bash
+ape "List the contents of the working directory with as much detail as possible" --model gpt-3.5-turbo
+```
+
+Output:
+
+```text
+ls -lha
+```
+
+If you pass `--execute`, the tool will run the command for you after printing it! Be careful with this as LLMs often make mistakes:
+
+```bash
+ape "Who am I logged in as?"
+```
+
+Output:
+
+```text
+whoami
+jdoe
+```
+
+For more help:
+
+```bash
+ape --help
+```
+
+See also: [Gorilla](https://github.com/gorilla-llm)
+

ape_linux-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+ape/__init__.py,sha256=KJJ5wxvn0U2TzD9o0-eSkT-YNWzBbkED29WB5wWvln0,29
+ape/cli.py,sha256=Gs1cJ9qNGbb1OTmQPCIcLhOvX_zAx3Dp3glokXB5nxM,1588
+ape/llm.py,sha256=TykrpQKNbl9ajmzyGdO8XvK3Gi2yB4eCTkMMxQg4xe4,2201
+ape_linux-0.1.0.dist-info/LICENSE,sha256=qEiuw01rkSrWJjnjUb--8CmLaxsBhWHEsS8mThnZ254,1051
+ape_linux-0.1.0.dist-info/METADATA,sha256=2mSzfzHK3vu8LYja5FzTQ6bMgw24EoobKhm8aD-Dpb0,2550
+ape_linux-0.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+ape_linux-0.1.0.dist-info/entry_points.txt,sha256=nrgK6S77ZFF--hcHOCuz90ewm1DEXW5uwiWmxcv6pwA,35
+ape_linux-0.1.0.dist-info/RECORD,,

ape_linux-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ape_linux-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+ape=ape.cli:app
+