ape-linux 0.1.1__tar.gz → 0.2.0__tar.gz

{ape_linux-0.1.1 → ape_linux-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ape-linux
-Version: 0.1.1
+Version: 0.2.0
 Summary: AI for Linux commands
 Home-page: https://github.com/sbalian/ape
 License: MIT
@@ -46,10 +46,10 @@ To install:
 pipx install ape-linux
 ```
 
-Next, set your API key:
+Next, set your OpenAI API key:
 
 ```bash
-export OPENAI_API_KEY=key
+export APE_OPENAI_API_KEY=key
 ```
 
 To run:
@@ -76,19 +76,19 @@ Output:
 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:
+If you try to ask something unrelated to Linux commands:
 
 ```bash
 ape "Tell me about monkeys"
 ```
 
-Output:
+you should get:
 
 ```text
-Please rephrase.
+echo "Please try again."
 ```
 
-You can change the model using `--model`. The default is `gpt-4o`.
+You can change the model using `--model` or `-m`. The default is `gpt-4o`.
 See [here](https://platform.openai.com/docs/models) for a list of models. For example:
 
 ```bash
@@ -101,7 +101,7 @@ Output:
 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:
+If you pass `--execute` or `-e`, 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?"

{ape_linux-0.1.1 → ape_linux-0.2.0}/README.md

@@ -20,10 +20,10 @@ To install:
 pipx install ape-linux
 ```
 
-Next, set your API key:
+Next, set your OpenAI API key:
 
 ```bash
-export OPENAI_API_KEY=key
+export APE_OPENAI_API_KEY=key
 ```
 
 To run:
@@ -50,19 +50,19 @@ Output:
 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:
+If you try to ask something unrelated to Linux commands:
 
 ```bash
 ape "Tell me about monkeys"
 ```
 
-Output:
+you should get:
 
 ```text
-Please rephrase.
+echo "Please try again."
 ```
 
-You can change the model using `--model`. The default is `gpt-4o`.
+You can change the model using `--model` or `-m`. The default is `gpt-4o`.
 See [here](https://platform.openai.com/docs/models) for a list of models. For example:
 
 ```bash
@@ -75,7 +75,7 @@ Output:
 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:
+If you pass `--execute` or `-e`, 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?"

ape_linux-0.2.0/ape.py

@@ -0,0 +1,104 @@
+"""AI for Linux commands."""
+
+import os
+import subprocess
+from typing import Annotated
+
+import openai
+import rich.console
+import typer
+
+app = typer.Typer(add_completion=False, pretty_exceptions_enable=False)
+
+
+def call_llm(api_key: str, model: str, system_prompt: str, user_prompt: str):
+    return (
+        openai.OpenAI(api_key=api_key)
+        .chat.completions.create(
+            model=model,
+            messages=[
+                {"role": "system", "content": system_prompt},
+                {"role": "user", "content": user_prompt},
+            ],
+        )
+        .choices[0]
+        .message.content
+    )
+
+
+@app.command()
+def main(
+    query: Annotated[
+        str, typer.Argument(help="Query describing a Linux task.", show_default=False)
+    ],
+    model: Annotated[
+        str,
+        typer.Option(
+            "--model",
+            "-m",
+            help="OpenAI model. See https://platform.openai.com/docs/models.",
+        ),
+    ] = "gpt-4o",
+    execute: Annotated[
+        bool,
+        typer.Option(
+            "--execute",
+            "-e",
+            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()
+
+    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 "echo "Please try again."".
+
+    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: echo "Please try again."
+
+    Question: Tell me a story
+    Answer: echo "Please try again.\""""  # noqa: E501
+
+    user_prompt = f"""\
+    Question: {query.strip()}
+    Answer:"""
+
+    try:
+        api_key = os.environ["APE_OPENAI_API_KEY"]
+    except KeyError:
+        typer.echo("Set the environment variable APE_OPENAI_API_KEY.", err=True)
+        raise typer.Exit(1)
+
+    try:
+        with console.status("[bold][blue]Processing ...", spinner="monkey"):
+            answer = call_llm(api_key, model, system_prompt, user_prompt)
+            if answer is None:
+                answer = 'echo "Please try again."'
+        typer.echo(answer)
+        if execute:
+            subprocess.check_call(answer, shell=True)
+    except openai.APIStatusError as error:
+        typer.echo(
+            f"OpenAI {error.status_code} error: "
+            f"{error.response.json()['error']['message']}",
+            err=True,
+        )
+        raise typer.Exit(1)

{ape_linux-0.1.1 → ape_linux-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ape-linux"
-version = "0.1.1"
+version = "0.2.0"
 description = "AI for Linux commands"
 license = "MIT"
 authors = ["Seto Balian <seto.balian@gmail.com>"]
@@ -16,7 +16,7 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
 ]
 packages = [
-    { include = "ape", from = "src" },
+    { include = "ape.py" },
 ]
 
 [tool.poetry.dependencies]
@@ -26,7 +26,7 @@ openai = "^1.30.3"
 rich = "^13.7.1"
 
 [tool.poetry.scripts]
-ape = "ape.cli:app"
+ape = "ape:app"
 
 [tool.poetry.group.dev.dependencies]
 ipython = "^8.24.0"
@@ -34,6 +34,8 @@ pytest = "^8.2.1"
 ruff = "^0.4.5"
 pyright = "^1.1.364"
 
+[tool.pyright]
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

ape_linux-0.1.1/src/ape/__init__.py

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

ape_linux-0.1.1/src/ape/cli.py

@@ -1,61 +0,0 @@
-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_linux-0.1.1/src/ape/llm.py

@@ -1,76 +0,0 @@
-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"