how-cli 0.1.0__tar.gz → 0.2.0__tar.gz

{how_cli-0.1.0 → how_cli-0.2.0}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Rudransh Joshi
-
-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.
+MIT License
+
+Copyright (c) 2024 Rudransh Joshi
+
+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.

{how_cli-0.1.0 → how_cli-0.2.0}/MANIFEST.in

@@ -1,2 +1,2 @@
-include requirements.txt
+include requirements.txt
 include README.md

{how_cli-0.1.0/how_cli.egg-info → how_cli-0.2.0}/PKG-INFO

@@ -1,103 +1,116 @@
-Metadata-Version: 2.1
-Name: how-cli
-Version: 0.1.0
-Summary: An AI-based CLI assistant to help you with command line & shell.
-Home-page: https://github.com/FireHead90544/how-cli
-Author: Rudransh Joshi (FireHead90544)
-Author-email: rudranshjoshi1806@gmail.com
-License: MIT
-Project-URL: Issue Tracker, https://github.com/FireHead90544/how-cli/issues
-Platform: any
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: typer
-Requires-Dist: langchain
-Requires-Dist: langchain-google-genai
-
-# how-cli
-An AI-based CLI assistant to help you with command line & shell.
-
-
-## Demo 
-Would be adding install instructions and better demo soon, until then check this out.
-### Setup
-![image](https://github.com/user-attachments/assets/87d3ba64-ecb7-43c6-9863-a62c39396ac5)
-
-### Inferences
-![image](https://github.com/user-attachments/assets/7af58310-183a-429b-aa66-e6abe36713fb)
-![image](https://github.com/user-attachments/assets/20062ac2-1057-4139-9f60-990bd41605da)
-
-
-## Installation
-**1. Using `pip`**
-  - Ensure python is installed on your system. (Tested against Python 3.11+)
-  - Install the package using pip.
-  ```bash
-  pip install -U how-cli
-  ```
-**2. Manual Installation**
-  - Clone the repository & cd into it
-  ```bash
-  git clone https://github.com/FireHead90544/how-cli && cd how-cli
-  ```
-  - Ensure you're in a virtual environment.
-  - Install the application.
-  ```bash
-  pip install -e .
-  ```
-
-
-## Usage
-```console
-$ how [OPTIONS] COMMAND [ARGS]...
-```
-
-**Options**:
-* `-v, --version`: Shows the version of the application
-* `--install-completion`: Install completion for the current shell.
-* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
-* `--help`: Show this message and exit.
-
-**Commands**:
-* `setup`: Sets up the configuration required to run...
-* `to`: Sends the task to the LLM for analysis.
-
-
-## `how setup`
-Sets up the configuration required to run the application.
-Set the LLM Provider & the corresponding API Key.
-
-**Usage**:
-```console
-$ how setup [OPTIONS]
-```
-
-**Options**:
-* `--interactive / --no-interactive`: Whether to use interactive mode for setting up configuration?  [default: interactive]
-* `--provider TEXT`: The LLM Provider, needs to be passed explicitly if using --no-interactive mode.
-* `--api-key TEXT`: The API Key for the LLM provider, needs to be passed explicitly if using --no-interactive mode.
-* `--help`: Show this message and exit.
-
-
-## `how to`
-Sends the task to the LLM for analysis.
-Returns the commands to be executed in order to achieve that.
-
-**Usage**:
-```console
-$ how to [OPTIONS] TASK
-```
-
-**Arguments**:
-* `TASK`: The command line task to perform.  [required]
-
-**Options**:
-* `--help`: Show this message and exit.
-
-
-## Providers
-`how-cli` uses ChatModels as they support chat messages as opposed to TextModels and below model providers and their corresponding models are available to use.
-
-| Provider | Model | Package |
-|:--------:|:-----:|:-------:|
-| Google   | `gemini-1.5-flash` | `langchain-google-genai` |
+Metadata-Version: 2.1
+Name: how-cli
+Version: 0.2.0
+Summary: An AI-based CLI assistant to help you with command line & shell.
+Home-page: https://github.com/FireHead90544/how-cli
+Author: Rudransh Joshi (FireHead90544)
+Author-email: rudranshjoshi1806@gmail.com
+License: MIT
+Project-URL: Issue Tracker, https://github.com/FireHead90544/how-cli/issues
+Platform: any
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer
+Requires-Dist: langchain
+Requires-Dist: langchain-google-genai
+Requires-Dist: langchain-google-vertexai
+Requires-Dist: langchain-groq
+Requires-Dist: langchain-openai
+Requires-Dist: langchain-anthropic
+
+# how-cli
+An AI-based CLI assistant to help you with command line & shell.
+
+
+## Demo 
+https://github.com/user-attachments/assets/effefe1a-c0ed-4b60-838c-98f992f6c25f
+
+
+## Installation
+**1. Using `pip`**
+  - Ensure python is installed on your system. (Tested against Python 3.11+)
+  - Install the package using pip.
+  ```bash
+  pip install -U how-cli
+  ```
+**2. Manual Installation**
+  - Clone the repository & cd into it
+  ```bash
+  git clone https://github.com/FireHead90544/how-cli && cd how-cli
+  ```
+  - Ensure you're in a virtual environment.
+  - Install the application.
+  ```bash
+  pip install -e .
+  ```
+
+
+## Usage
+```console
+$ how [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+* `-v, --version`: Shows the version of the application
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.
+
+**Commands**:
+* `setup`: Sets up the configuration required to run...
+* `to`: Sends the task to the LLM for analysis.
+
+
+## `how setup`
+Sets up the configuration required to run the application.
+Set the LLM Provider & the corresponding API Key.
+
+**Usage**:
+```console
+$ how setup [OPTIONS]
+```
+
+**Options**:
+* `--interactive / --no-interactive`: Whether to use interactive mode for setting up configuration?  [default: interactive]
+* `--provider TEXT`: The LLM Provider, needs to be passed explicitly if using --no-interactive mode.
+* `--api-key TEXT`: The API Key for the LLM provider, needs to be passed explicitly if using --no-interactive mode.
+* `--help`: Show this message and exit.
+
+
+## `how to`
+Sends the task to the LLM for analysis.
+Returns the commands to be executed in order to achieve that.
+
+**Usage**:
+```console
+$ how to [OPTIONS] TASK
+```
+
+**Arguments**:
+* `TASK`: The command line task to perform.  [required]
+
+**Options**:
+* `--help`: Show this message and exit.
+
+
+## Providers
+`how-cli` uses ChatModels as they support chat messages as opposed to TextModels and below model providers and their corresponding models are available to use. If you could test the models that are marked as ❌, please create an issue or pull request along with the test results.
+
+| Provider | Model | Package | Tested |
+|:--------:|:-----:|:-------:|:------:|
+| GoogleGenAI   | `gemini-1.5-flash` | `langchain-google-genai` | ✅ |
+| GoogleVertexAI | `gemini-1.5-flash` | `langchain-google-vertexai` | ❌ |
+| GroqMistralAI | `mixtral-8x7b-32768` | `langchain-groq` | ✅ |
+| GroqLLaMa | `llama3-70b-8192` | `langchain-groq` | ✅ |
+| OpenAI | `gpt-4o` | `langchain-openai` | ❌ |
+| Anthropic | `claude-3-5-sonnet-20240620` | `langchain-anthropic` | ❌ |
+
+
+# License
+`how-cil` is licensed under the MIT License, it can be found [here](https://github.com/FireHead90544/how-cli/blob/main/LICENSE).
+
+
+# Honourable Mentions
+This project is greatly inspired by [kynnyhsap's](https://github.com/kynnyhsap) [how](https://github.com/kynnyhsap/how). Though my implementation is completely different (refer to the below image for architectural details), but at the core both the projects aims to do the same thing. Also, check out LangChain & Typer using which this project was built.
+
+![arch](https://github.com/user-attachments/assets/5335fb1d-7899-4ebf-9ff3-dfa139a9c5f8)

{how_cli-0.1.0 → how_cli-0.2.0}/README.md

@@ -1,87 +1,96 @@
-# how-cli
-An AI-based CLI assistant to help you with command line & shell.
-
-
-## Demo 
-Would be adding install instructions and better demo soon, until then check this out.
-### Setup
-![image](https://github.com/user-attachments/assets/87d3ba64-ecb7-43c6-9863-a62c39396ac5)
-
-### Inferences
-![image](https://github.com/user-attachments/assets/7af58310-183a-429b-aa66-e6abe36713fb)
-![image](https://github.com/user-attachments/assets/20062ac2-1057-4139-9f60-990bd41605da)
-
-
-## Installation
-**1. Using `pip`**
-  - Ensure python is installed on your system. (Tested against Python 3.11+)
-  - Install the package using pip.
-  ```bash
-  pip install -U how-cli
-  ```
-**2. Manual Installation**
-  - Clone the repository & cd into it
-  ```bash
-  git clone https://github.com/FireHead90544/how-cli && cd how-cli
-  ```
-  - Ensure you're in a virtual environment.
-  - Install the application.
-  ```bash
-  pip install -e .
-  ```
-
-
-## Usage
-```console
-$ how [OPTIONS] COMMAND [ARGS]...
-```
-
-**Options**:
-* `-v, --version`: Shows the version of the application
-* `--install-completion`: Install completion for the current shell.
-* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
-* `--help`: Show this message and exit.
-
-**Commands**:
-* `setup`: Sets up the configuration required to run...
-* `to`: Sends the task to the LLM for analysis.
-
-
-## `how setup`
-Sets up the configuration required to run the application.
-Set the LLM Provider & the corresponding API Key.
-
-**Usage**:
-```console
-$ how setup [OPTIONS]
-```
-
-**Options**:
-* `--interactive / --no-interactive`: Whether to use interactive mode for setting up configuration?  [default: interactive]
-* `--provider TEXT`: The LLM Provider, needs to be passed explicitly if using --no-interactive mode.
-* `--api-key TEXT`: The API Key for the LLM provider, needs to be passed explicitly if using --no-interactive mode.
-* `--help`: Show this message and exit.
-
-
-## `how to`
-Sends the task to the LLM for analysis.
-Returns the commands to be executed in order to achieve that.
-
-**Usage**:
-```console
-$ how to [OPTIONS] TASK
-```
-
-**Arguments**:
-* `TASK`: The command line task to perform.  [required]
-
-**Options**:
-* `--help`: Show this message and exit.
-
-
-## Providers
-`how-cli` uses ChatModels as they support chat messages as opposed to TextModels and below model providers and their corresponding models are available to use.
-
-| Provider | Model | Package |
-|:--------:|:-----:|:-------:|
-| Google   | `gemini-1.5-flash` | `langchain-google-genai` |
+# how-cli
+An AI-based CLI assistant to help you with command line & shell.
+
+
+## Demo 
+https://github.com/user-attachments/assets/effefe1a-c0ed-4b60-838c-98f992f6c25f
+
+
+## Installation
+**1. Using `pip`**
+  - Ensure python is installed on your system. (Tested against Python 3.11+)
+  - Install the package using pip.
+  ```bash
+  pip install -U how-cli
+  ```
+**2. Manual Installation**
+  - Clone the repository & cd into it
+  ```bash
+  git clone https://github.com/FireHead90544/how-cli && cd how-cli
+  ```
+  - Ensure you're in a virtual environment.
+  - Install the application.
+  ```bash
+  pip install -e .
+  ```
+
+
+## Usage
+```console
+$ how [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+* `-v, --version`: Shows the version of the application
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.
+
+**Commands**:
+* `setup`: Sets up the configuration required to run...
+* `to`: Sends the task to the LLM for analysis.
+
+
+## `how setup`
+Sets up the configuration required to run the application.
+Set the LLM Provider & the corresponding API Key.
+
+**Usage**:
+```console
+$ how setup [OPTIONS]
+```
+
+**Options**:
+* `--interactive / --no-interactive`: Whether to use interactive mode for setting up configuration?  [default: interactive]
+* `--provider TEXT`: The LLM Provider, needs to be passed explicitly if using --no-interactive mode.
+* `--api-key TEXT`: The API Key for the LLM provider, needs to be passed explicitly if using --no-interactive mode.
+* `--help`: Show this message and exit.
+
+
+## `how to`
+Sends the task to the LLM for analysis.
+Returns the commands to be executed in order to achieve that.
+
+**Usage**:
+```console
+$ how to [OPTIONS] TASK
+```
+
+**Arguments**:
+* `TASK`: The command line task to perform.  [required]
+
+**Options**:
+* `--help`: Show this message and exit.
+
+
+## Providers
+`how-cli` uses ChatModels as they support chat messages as opposed to TextModels and below model providers and their corresponding models are available to use. If you could test the models that are marked as ❌, please create an issue or pull request along with the test results.
+
+| Provider | Model | Package | Tested |
+|:--------:|:-----:|:-------:|:------:|
+| GoogleGenAI   | `gemini-1.5-flash` | `langchain-google-genai` | ✅ |
+| GoogleVertexAI | `gemini-1.5-flash` | `langchain-google-vertexai` | ❌ |
+| GroqMistralAI | `mixtral-8x7b-32768` | `langchain-groq` | ✅ |
+| GroqLLaMa | `llama3-70b-8192` | `langchain-groq` | ✅ |
+| OpenAI | `gpt-4o` | `langchain-openai` | ❌ |
+| Anthropic | `claude-3-5-sonnet-20240620` | `langchain-anthropic` | ❌ |
+
+
+# License
+`how-cil` is licensed under the MIT License, it can be found [here](https://github.com/FireHead90544/how-cli/blob/main/LICENSE).
+
+
+# Honourable Mentions
+This project is greatly inspired by [kynnyhsap's](https://github.com/kynnyhsap) [how](https://github.com/kynnyhsap/how). Though my implementation is completely different (refer to the below image for architectural details), but at the core both the projects aims to do the same thing. Also, check out LangChain & Typer using which this project was built.
+
+![arch](https://github.com/user-attachments/assets/5335fb1d-7899-4ebf-9ff3-dfa139a9c5f8)

{how_cli-0.1.0 → how_cli-0.2.0}/how/__init__.py

@@ -1 +1 @@
-from how.core import __version__, __author__
+from how.core import __version__, __author__

{how_cli-0.1.0 → how_cli-0.2.0}/how/__main__.py

@@ -1,4 +1,4 @@
-from how.how import app
-
-if __name__ == "__main__":
-    app()
+from how.how import app
+
+if __name__ == "__main__":
+    app()

how_cli-0.2.0/how/core/__init__.py

@@ -0,0 +1,6 @@
+"""
+Package containing the core modules of the project.
+"""
+
+__version__ = "0.2.0"
+__author__ = "Rudransh Joshi (FireHead90544)"

{how_cli-0.1.0 → how_cli-0.2.0}/how/core/chains.py

@@ -1,4 +1,4 @@
-from how.core.template import PROMPT_TEMPLATE
-from how.core.llm import LLM
-
+from how.core.template import PROMPT_TEMPLATE
+from how.core.llm import LLM
+
 HOW_CLI_CHAIN = PROMPT_TEMPLATE | LLM

{how_cli-0.1.0 → how_cli-0.2.0}/how/core/config.py

@@ -1,50 +1,50 @@
-import json
-from pathlib import Path
-
-class Config:
-    """
-    Manages the configuration of the application.
-    Config file is stored in the user's home directory.
-    """
-    def __init__(self):
-        self.config_dir = Path.home() / ".how"
-        self.config_file = self.config_dir / "config.json"
-        self.__init_config()
-
-    def __init_config(self):
-        """
-        Initialize the configuration directory & file if they don't exist.
-        """
-        if not self.config_dir.exists():
-            self.config_dir.mkdir()
-        
-        if not self.config_file.exists():
-            with open(self.config_file, "w") as f:
-                json.dump({"provider": "", "api_key": ""}, f, indent=4)
-
-    def setup(self, provider: str, api_key: str):
-        """
-        Set the LLM Provider & the corresponding API Key.
-        """
-        with open(self.config_file, "w") as f:
-            json.dump({"provider": provider, "api_key": api_key}, f, indent=4)
-
-    @property
-    def values(self):
-        """
-        Get the configuration values.
-        """
-        with open(self.config_file) as f:
-            return json.load(f)
-        
-    def is_ready(self):
-        """
-        Check if the configuration file is ready to use.
-        """
-        try:
-            assert self.values.get("provider")
-            assert self.values.get("api_key")
-        except:
-            return False
-
+import json
+from pathlib import Path
+
+class Config:
+    """
+    Manages the configuration of the application.
+    Config file is stored in the user's home directory.
+    """
+    def __init__(self):
+        self.config_dir = Path.home() / ".how"
+        self.config_file = self.config_dir / "config.json"
+        self.__init_config()
+
+    def __init_config(self):
+        """
+        Initialize the configuration directory & file if they don't exist.
+        """
+        if not self.config_dir.exists():
+            self.config_dir.mkdir()
+        
+        if not self.config_file.exists():
+            with open(self.config_file, "w") as f:
+                json.dump({"provider": "", "api_key": ""}, f, indent=4)
+
+    def setup(self, provider: str, api_key: str):
+        """
+        Set the LLM Provider & the corresponding API Key.
+        """
+        with open(self.config_file, "w") as f:
+            json.dump({"provider": provider, "api_key": api_key}, f, indent=4)
+
+    @property
+    def values(self):
+        """
+        Get the configuration values.
+        """
+        with open(self.config_file) as f:
+            return json.load(f)
+        
+    def is_ready(self):
+        """
+        Check if the configuration file is ready to use.
+        """
+        try:
+            assert self.values.get("provider")
+            assert self.values.get("api_key")
+        except:
+            return False
+
         return True

{how_cli-0.1.0 → how_cli-0.2.0}/how/core/llm.py

@@ -1,9 +1,9 @@
-from how.core.config import Config
-from how.core.providers import LLM_PROVIDERS
-
-llm_config = Config().values
-
-LLM = LLM_PROVIDERS.get(llm_config.get("provider"))['provider'](
-    model = LLM_PROVIDERS.get(llm_config.get("provider"))['model'],
-    api_key = llm_config.get("api_key")
+from how.core.config import Config
+from how.core.providers import LLM_PROVIDERS
+
+llm_config = Config().values
+
+LLM = LLM_PROVIDERS.get(llm_config.get("provider"))['provider'](
+    model = LLM_PROVIDERS.get(llm_config.get("provider"))['model'],
+    api_key = llm_config.get("api_key")
 )

{how_cli-0.1.0 → how_cli-0.2.0}/how/core/parser.py

@@ -1,4 +1,4 @@
-from how.core.schema import Result
-from langchain_core.output_parsers import JsonOutputParser
-
+from how.core.schema import Result
+from langchain_core.output_parsers import JsonOutputParser
+
 PARSER = JsonOutputParser(pydantic_object=Result)