pygeai 0.6.0b2__tar.gz → 0.6.0b3__tar.gz

{pygeai-0.6.0b2/pygeai.egg-info → pygeai-0.6.0b3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pygeai
-Version: 0.6.0b2
+Version: 0.6.0b3
 Summary: Software Development Kit to interact with Globant Enterprise AI.
 Author-email: Globant <geai-sdk@globant.com>
 License-Expression: MIT

{pygeai-0.6.0b2 → pygeai-0.6.0b3}/pygeai/cli/commands/base.py

@@ -5,6 +5,7 @@ from pygeai.cli.commands.auth import auth_commands
 from pygeai.cli.commands.builders import build_help_text
 from pygeai.cli.commands.chat import chat_commands
 from pygeai.cli.commands.configuration import configure, configuration_options
+from pygeai.cli.commands.docs import docs_commands
 from pygeai.cli.commands.embeddings import embeddings_commands
 from pygeai.cli.commands.evaluation import evaluation_commands
 from pygeai.cli.commands.feedback import feedback_commands
@@ -274,6 +275,15 @@ base_commands = [
         migrate_commands,
         []
     ),
+    Command(
+        "docs",
+        ["docs"],
+        "View PyGEAI SDK documentation",
+        None,
+        ArgumentsEnum.NOT_AVAILABLE,
+        docs_commands,
+        []
+    ),
 
 ]
 

pygeai-0.6.0b3/pygeai/cli/commands/docs.py

@@ -0,0 +1,105 @@
+import os
+import subprocess
+import webbrowser
+from pathlib import Path
+
+from pygeai.cli.commands import Command, ArgumentsEnum
+from pygeai.cli.commands.builders import build_help_text
+from pygeai.cli.texts.help import DOCS_HELP_TEXT
+from pygeai.core.utils.console import Console
+
+
+def show_help():
+    help_text = build_help_text(docs_commands, DOCS_HELP_TEXT)
+    Console.write_stdout(help_text)
+
+
+def open_documentation():
+    try:
+        import sphinx
+    except ImportError:
+        Console.write_stdout(
+            "Documentation dependencies (sphinx, sphinx-rtd-theme) are not installed.\n"
+            "Would you like to install them now? [Y/n]: "
+        )
+        response = input().strip().lower()
+        
+        if response in ['', 'y', 'yes']:
+            Console.write_stdout("Installing documentation dependencies...")
+            try:
+                subprocess.run(
+                    ["pip", "install", "pygeai[docs]"],
+                    check=True,
+                    text=True
+                )
+                Console.write_stdout("Documentation dependencies installed successfully.")
+            except subprocess.CalledProcessError as e:
+                Console.write_stderr(f"ERROR: Failed to install dependencies.\n{e}")
+                return
+            except FileNotFoundError:
+                Console.write_stderr("ERROR: pip command not found.")
+                return
+        else:
+            Console.write_stdout("Installation cancelled. Documentation dependencies are required.")
+            return
+
+    package_root = Path(__file__).parent.parent.parent.parent
+    docs_dir = package_root / "docs"
+    build_dir = docs_dir / "build" / "html"
+    index_file = build_dir / "index.html"
+
+    if not index_file.exists():
+        Console.write_stdout("Documentation not found. Building documentation (this may take a minute)...")
+        source_dir = docs_dir / "source"
+        
+        try:
+            result = subprocess.run(
+                ["sphinx-build", "-b", "html", str(source_dir), str(build_dir)],
+                check=True,
+                capture_output=True,
+                text=True,
+                timeout=300
+            )
+            Console.write_stdout("Documentation built successfully.")
+        except subprocess.CalledProcessError as e:
+            Console.write_stderr(f"ERROR: Failed to build documentation.\n{e.stderr}")
+            return
+        except subprocess.TimeoutExpired:
+            Console.write_stderr("ERROR: Documentation build timed out after 5 minutes.")
+            return
+        except FileNotFoundError:
+            Console.write_stderr(
+                "ERROR: sphinx-build command not found.\n"
+                "Install documentation dependencies: pip install pygeai[docs]"
+            )
+            return
+
+    doc_url = f"file://{index_file.absolute()}"
+    Console.write_stdout(f"Opening documentation at: {doc_url}")
+    
+    try:
+        webbrowser.open(doc_url)
+    except Exception as e:
+        Console.write_stderr(f"ERROR: Failed to open browser.\n{e}")
+
+
+docs_commands = [
+    Command(
+        "open",
+        ["open", "o"],
+        "Open documentation in web browser",
+        open_documentation,
+        ArgumentsEnum.NOT_AVAILABLE,
+        [],
+        []
+    ),
+    Command(
+        "help",
+        ["help", "h"],
+        "Display help text",
+        show_help,
+        ArgumentsEnum.NOT_AVAILABLE,
+        [],
+        []
+    ),
+]

{pygeai-0.6.0b2 → pygeai-0.6.0b3}/pygeai/cli/texts/help.py

@@ -754,3 +754,31 @@ EXAMPLES
     
 {AUTHORS_SECTION}
 """
+
+DOCS_HELP_TEXT = f"""
+GEAI CLI - DOCS
+---------------
+
+NAME
+    geai - Command Line Interface for Globant Enterprise AI
+
+SYNOPSIS
+    geai docs <subcommand>
+
+DESCRIPTION
+    geai docs is a command from geai cli utility to view the PyGEAI SDK documentation.
+    
+    The options are as follows:
+    {{available_commands}}
+    
+EXAMPLES
+    The command:
+        
+        geai docs
+    opens the HTML documentation in your web browser.
+    
+    If documentation dependencies are not installed, you will be prompted to install them.
+    If the documentation is not built, it will be automatically generated.
+    
+{AUTHORS_SECTION}
+"""

{pygeai-0.6.0b2 → pygeai-0.6.0b3/pygeai.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pygeai
-Version: 0.6.0b2
+Version: 0.6.0b3
 Summary: Software Development Kit to interact with Globant Enterprise AI.
 Author-email: Globant <geai-sdk@globant.com>
 License-Expression: MIT

{pygeai-0.6.0b2 → pygeai-0.6.0b3}/pygeai.egg-info/SOURCES.txt

@@ -55,6 +55,7 @@ pygeai/cli/commands/builders.py
 pygeai/cli/commands/chat.py
 pygeai/cli/commands/common.py
 pygeai/cli/commands/configuration.py
+pygeai/cli/commands/docs.py
 pygeai/cli/commands/embeddings.py
 pygeai/cli/commands/evaluation.py
 pygeai/cli/commands/feedback.py

{pygeai-0.6.0b2 → pygeai-0.6.0b3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pygeai"
-version = "0.6.0b2"
+version = "0.6.0b3"
 description = "Software Development Kit to interact with Globant Enterprise AI."
 license = "MIT"
 requires-python = ">=3.10"