error-translator-cli-v2 1.1.2__tar.gz → 1.1.3__tar.gz

{error_translator_cli_v2-1.1.2 → error_translator_cli_v2-1.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: error-translator-cli-v2
-Version: 1.1.2
+Version: 1.1.3
 Summary: A CLI tool that explains Python errors in simple human language.
 Author-email: Gourabananda Datta <gourabanandadatta@zohomail.com>
 Project-URL: Homepage, https://github.com/gourabanandad/error-translator
@@ -34,6 +34,12 @@ Built for local-first developer workflows: CLI, import-hook auto mode, Python AP
 ```bash
 pip install error-translator-cli-v2
 ```
+### Check if the CLI is working:
+
+```bash
+explain-error --version
+```
+
 
 ### Local development setup
 

{error_translator_cli_v2-1.1.2 → error_translator_cli_v2-1.1.3}/README.md

@@ -23,6 +23,12 @@ Built for local-first developer workflows: CLI, import-hook auto mode, Python AP
 ```bash
 pip install error-translator-cli-v2
 ```
+### Check if the CLI is working:
+
+```bash
+explain-error --version
+```
+
 
 ### Local development setup
 

{error_translator_cli_v2-1.1.2 → error_translator_cli_v2-1.1.3}/error_translator/cli.py

@@ -1,6 +1,12 @@
 import sys
 import argparse
 from .core import translate_error
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    VERSION = version("error-translator-cli-v2")
+except PackageNotFoundError:
+    VERSION = "unknown (not installed via pip)"  # Fallback version if package metadata is not found
 
 # ANSI Color Codes
 class Colors:
@@ -12,6 +18,32 @@ class Colors:
     RESET = '\033[0m'
     MAGENTA = '\033[95m'
 
+
+def print_about():
+    """Prints the about message for the tool."""
+    about_text = f"""
+ERROR TRANSLATOR CLI
+=====================
+A lightning-fast, offline tool that translates raw Python tracebacks 
+into human-readable explanations with actionable fixes.
+
+Authors: Gourabananda Datta
+Repository: https://github.com/gourabanandad/error-translator-cli-v2
+Usage:
+  1. Run a script and translate its errors:
+        explain-error run your_script.py
+    2. Translate an error message directly:
+        explain-error "TypeError: unsupported operand type(s) for +: 'int' and 'str'"
+    3. Pipe an error log:
+        cat error.log | explain-error
+    4. Get help:
+        explain-error --help
+    5. About:
+        explain-error --about
+"""
+    print(f"\033[96m{about_text}\033[0m")
+
+
 def print_result(result: dict):
     """Prints the translated error to the terminal with colors."""
     print(f"\n{Colors.RED}{Colors.BOLD} Error Detected:{Colors.RESET}")
@@ -68,9 +100,25 @@ def run_script(script_name: str):
 # Entry point of the program
 def main():
     parser = argparse.ArgumentParser(
-        description="Translate Python error messages into simple English."
+        prog="explain-error",
+        description="Translate Python error messages into simple English.",
+        epilog="Examples:\n  explain-error run script.py\n  explain-error \"NameError: name 'x' is not defined\"\n  cat error.log | explain-error",
+        formatter_class=argparse.RawTextHelpFormatter
+    )
+
+    parser.add_argument(
+        "-a",
+        "--about",
+        action="store_true",
+        help="Display information about the tool."
     )
     
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="store_true",
+        help="Show the current version of the tool."
+    )
     # Allow multiple arguments so we can accept "run script.py" or a long error string
     parser.add_argument(
         "args", 
@@ -80,6 +128,14 @@ def main():
 
     parsed_args = parser.parse_args()
 
+    if parsed_args.about:
+        print_about()
+        sys.exit(0)
+    
+    if parsed_args.version:
+        print(f"Error Translator CLI Version: {Colors.GREEN}{VERSION}{Colors.RESET}")
+        sys.exit(0)
+    
     # 1. Handle Piped Input (e.g., cat error.log | explain-error)
     if not sys.stdin.isatty():
         error_input = sys.stdin.read()
@@ -92,15 +148,18 @@ def main():
         parser.print_help()
         sys.exit(1)
 
-    # 3. Check if the user used the "run" command
-    if parsed_args.args[0] == "run" and len(parsed_args.args) > 1:
-        script_name = parsed_args.args[1]
-        run_script(script_name)
-    
-    # 4. Fallback: Treat the input as a raw error string
+    if parsed_args.args:
+        # 3. Check if the user used the "run" command
+        if parsed_args.args[0] == "run" and len(parsed_args.args) > 1:
+            script_name = parsed_args.args[1]
+            run_script(script_name)
+        
+        # 4. Fallback: Treat the input as a raw error string
+        else:
+            error_input = " ".join(parsed_args.args)
+            print_result(translate_error(error_input))
     else:
-        error_input = " ".join(parsed_args.args)
-        print_result(translate_error(error_input))
-
+        parser.print_help()
+        sys.exit(1)
 if __name__ == "__main__":
     main()

{error_translator_cli_v2-1.1.2 → error_translator_cli_v2-1.1.3}/error_translator_cli_v2.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: error-translator-cli-v2
-Version: 1.1.2
+Version: 1.1.3
 Summary: A CLI tool that explains Python errors in simple human language.
 Author-email: Gourabananda Datta <gourabanandadatta@zohomail.com>
 Project-URL: Homepage, https://github.com/gourabanandad/error-translator
@@ -34,6 +34,12 @@ Built for local-first developer workflows: CLI, import-hook auto mode, Python AP
 ```bash
 pip install error-translator-cli-v2
 ```
+### Check if the CLI is working:
+
+```bash
+explain-error --version
+```
+
 
 ### Local development setup
 

{error_translator_cli_v2-1.1.2 → error_translator_cli_v2-1.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "error-translator-cli-v2"
-version = "1.1.2"
+version = "1.1.3"
 description = "A CLI tool that explains Python errors in simple human language."
 readme = "README.md"
 requires-python = ">=3.7"