watcmd 0.1.2__tar.gz

watcmd-0.1.2/.gitignore

@@ -0,0 +1,2 @@
+dist
+.venv/

watcmd-0.1.2/LICENSE.txt

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

watcmd-0.1.2/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.3
+Name: watcmd
+Version: 0.1.2
+Summary: c
+Project-URL: Homepage, https://github.com/alramalho/wat-cli
+Project-URL: Bug Tracker, https://github.com/alramalho/wat-cli/issues
+Author-email: Alex Ramalho <alexandre.ramalho.1998@gmail.com>
+License-File: LICENSE.txt
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.7
+Requires-Dist: openai
+Description-Content-Type: text/markdown
+
+# watcmd
+
+A CLI tool to get UNIX commands from text explanations using AI
+
+## Installation
+
+You can install `watcmd` directly from PyPI:
+
+```
+pip install watcmd
+```
+
+## Setup
+
+After installation, you need to configure your Anthropic API key. You can do this by running:
+
+```
+watcmd setup YOUR_API_KEY
+```
+
+Replace `YOUR_API_KEY` with your actual Anthropic API key. This will save your API key securely in a configuration file, so you don't need to set it as an environment variable each time.
+
+## Usage
+
+Once you've set up your API key, you can use the tool like this:
+
+```
+watcmd 'your command description'
+```
+
+For example:
+
+```
+watcmd 'to list all files in a directory'
+```
+
+The tool will return an explanation of how to perform the task in a UNIX system.
+
+You can also use the explicit query command:
+
+```
+watcmd query 'your command here'
+```
+
+## Development
+
+If you want to contribute or modify the tool:
+
+1. Clone this repository:
+   ```
+   git clone https://github.com/alramalho/watcmd.git
+   cd watcmd
+   ```
+
+2. Install the package in editable mode:
+   ```
+   pip install -e .
+   ```
+
+3. Make your changes and test them locally.
+
+## Publishing to PyPI
+
+To publish updates to PyPI:
+
+1. Update the version in `pyproject.toml`
+2. Build the package: `python -m build`
+3. Upload to PyPI: `python -m twine upload dist/*`
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE.txt) file for details.
+
+## Author
+
+Alex Ramalho ([@alramalho](https://github.com/alramalho))

watcmd-0.1.2/README.md

@@ -0,0 +1,76 @@
+# watcmd
+
+A CLI tool to get UNIX commands from text explanations using AI
+
+## Installation
+
+You can install `watcmd` directly from PyPI:
+
+```
+pip install watcmd
+```
+
+## Setup
+
+After installation, you need to configure your Anthropic API key. You can do this by running:
+
+```
+watcmd setup YOUR_API_KEY
+```
+
+Replace `YOUR_API_KEY` with your actual Anthropic API key. This will save your API key securely in a configuration file, so you don't need to set it as an environment variable each time.
+
+## Usage
+
+Once you've set up your API key, you can use the tool like this:
+
+```
+watcmd 'your command description'
+```
+
+For example:
+
+```
+watcmd 'to list all files in a directory'
+```
+
+The tool will return an explanation of how to perform the task in a UNIX system.
+
+You can also use the explicit query command:
+
+```
+watcmd query 'your command here'
+```
+
+## Development
+
+If you want to contribute or modify the tool:
+
+1. Clone this repository:
+   ```
+   git clone https://github.com/alramalho/watcmd.git
+   cd watcmd
+   ```
+
+2. Install the package in editable mode:
+   ```
+   pip install -e .
+   ```
+
+3. Make your changes and test them locally.
+
+## Publishing to PyPI
+
+To publish updates to PyPI:
+
+1. Update the version in `pyproject.toml`
+2. Build the package: `python -m build`
+3. Upload to PyPI: `python -m twine upload dist/*`
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE.txt) file for details.
+
+## Author
+
+Alex Ramalho ([@alramalho](https://github.com/alramalho))

watcmd-0.1.2/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "watcmd"
+version = "0.1.2"
+authors = [
+  { name="Alex Ramalho", email="alexandre.ramalho.1998@gmail.com" },
+]
+description = "c"
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "openai",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/alramalho/wat-cli"
+"Bug Tracker" = "https://github.com/alramalho/wat-cli/issues"
+
+[project.scripts]
+watcmd = "watcmd:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/watcmd"]

watcmd-0.1.2/src/watcmd/__init__.py

@@ -0,0 +1,70 @@
+import argparse
+import configparser
+import os
+import sys
+from pathlib import Path
+
+from openai import OpenAI
+
+# ... (rest of the code remains the same)
+
+CONFIG_DIR = Path.home() / '.config' / 'watcmd'
+CONFIG_FILE = CONFIG_DIR / 'config.ini'
+def get_api_key():
+    if CONFIG_FILE.exists():
+        config = configparser.ConfigParser()
+        config.read(CONFIG_FILE)
+        return config['DEFAULT']['api_key']
+    return os.environ.get('OPENAI_API_KEY')
+
+def setup_config(api_key):
+    CONFIG_DIR.mkdir(parents=True, exist_ok=True)
+    config = configparser.ConfigParser()
+    config['DEFAULT'] = {'api_key': api_key}
+    with open(CONFIG_FILE, 'w') as configfile:
+        config.write(configfile)
+    print(f"API key saved to {CONFIG_FILE}")
+
+
+def query_gpt4(prompt):
+    api_key = get_api_key()
+    if not api_key:
+        print("Error: OpenAI API key not found. Please set it using 'watcmd --setup YOUR_API_KEY'")
+        sys.exit(1)
+
+    client = OpenAI(api_key=get_api_key())
+
+    try:
+        response = client.chat.completions.create(model="gpt-4o",
+        messages=[
+            {"role": "system", "content": "You are a silent assitant that just outputs UNIX cli commands"},
+            {"role": "user", "content": f"what command for listing all files"},
+            {"role": "assistant", "content": f"ls -a"},
+            {"role": "user", "content": f"what command {prompt}"}
+        ],
+        max_tokens=300)
+        return response.choices[0].message.content.strip()
+    except Exception as e:
+        print(f"Error: API request failed. {str(e)}")
+        sys.exit(1)
+
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Get UNIX commands from text explanations using AI")
+    parser.add_argument('--setup', metavar='API_KEY', help='Setup OpenAI API key')
+    parser.add_argument('query', nargs='*', help='The task description to get a UNIX command for')
+    args = parser.parse_args()
+
+    if args.setup:
+        setup_config(args.setup)
+        print("API key set successfully.")
+    elif args.query:
+        query = ' '.join(args.query)
+        suggested_command = query_gpt4(query)
+        print(suggested_command)
+    else:
+        parser.print_help()
+
+if __name__ == "__main__":
+    main()