pygeai 0.6.0b8__tar.gz → 0.6.0b14__tar.gz

pygeai-0.6.0b14/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: pygeai
+Version: 0.6.0b14
+Summary: Software Development Kit to interact with Globant Enterprise AI.
+Author-email: Globant <geai-sdk@globant.com>
+License-Expression: MIT
+Keywords: geai,pygeai
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: pydantic>=2.11.3
+Requires-Dist: packaging
+Requires-Dist: mcp
+Requires-Dist: pyyaml
+Requires-Dist: prompt_toolkit
+Requires-Dist: toml
+Requires-Dist: httpx==0.28.1
+Requires-Dist: httpx-sse>=0.4.0
+Requires-Dist: opentelemetry-api>=1.33.0
+Requires-Dist: opentelemetry-sdk>=1.33.0
+Requires-Dist: sse-starlette>=2.3.3
+Requires-Dist: starlette>=0.46.2
+Requires-Dist: typing-extensions>=4.13.2
+Requires-Dist: streamlit
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx-markdown-builder; extra == "docs"
+Provides-Extra: tests
+Requires-Dist: coverage; extra == "tests"
+Dynamic: license-file
+
+# PyGEAI - SDK for Globant Enterprise AI
+
+PyGEAI is a Software Development Kit (SDK) for interacting with [Globant Enterprise AI](https://wiki.genexus.com/enterprise-ai/wiki?8,Table+of+contents%3AEnterprise+AI). It comprises libraries, tools, code samples, and documentation to simplify your experience with the platform.
+
+## Terms and conditions
+
+By using the Python SDK to interact with Globant Enterprise AI, you agree with the following Terms and Conditions:
+
+[Terms and Conditions](https://www.globant.com/enterprise-ai/terms-of-use)
+
+## Compatibility
+This package is compatible with the Globant Enterprise AI release from November 2025.
+
+## Configuration
+
+Before using the SDK, you need to define `GEAI_API_KEY` (`$SAIA_APITOKEN`) and `GEAI_API_BASE_URL` (`$BASE_URL`). You can achieve this in three ways:
+
+* **Environment variables:** Set `GEAI_API_KEY` and `GEAI_API_BASE_URL` as environment variables in your operating system.
+* **Credentials file:** Create a file named credentials in the `.geai` directory within your user home directory (`$USER_HOME/.geai/credentials`) and define `GEAI_API_KEY` and `GEAI_API_BASE_URL` within this file.
+* **Client instantiation:** Specify the `api_key` and `base_url` parameters directly when creating an instance of a client class.
+
+**Note:** If you plan to use the [Evaluation Module](https://wiki.genexus.com/enterprise-ai/wiki?896,Evaluation), you must also define `GEAI_API_EVAL_URL`
+
+### Credentials file
+The credentials file is organized via profiles, so one can interact with different instances of Globant Enterprise AI by just
+referencing which profile one wishes to use. This also applies to different levels of permissions.
+
+The structure of the credentials file is as follows:
+
+```
+[default]
+geai_api_key = <API_TOKEN>
+geai_api_base_url = <GEAI_BASE_URL>
+geai_api_evaul_url = <GEAI_EVALUATION_MODULE_URL>
+
+[<another alias>]
+geai_api_key = <API_TOKEN>
+geai_api_base_url = <GEAI_BASE_URL>
+geai_api_evaul_url = <GEAI_EVALUATION_MODULE_URL>
+
+```
+
+After setting the profiles, one can use them with the --alias option, for example:
+
+```bash 
+geai --alias test llm list-providers
+```
+
+## Modules
+
+The SDK consists of several modules, all accessible through a single package `pygeai`:
+
+- **`pygeai`**: The package encapsulates all components of the SDK.
+- **`admin`**: Allows the user to interact with some of the administration endpoints of Globant Enterprise AI.
+- **`assistant`**: This module handles interactions with various Assistants, including [Data Analyst Assistants](https://wiki.genexus.com/enterprise-ai/wiki?886,Data+Analyst+Assistant+2.0), [RAG Assistants](https://wiki.genexus.com/enterprise-ai/wiki?44,RAG+Assistants+Introduction), [Chat with Data Assistants](https://wiki.genexus.com/enterprise-ai/wiki?159,Chat+with+Data+Assistant), [Chat with API Assistants](https://wiki.genexus.com/enterprise-ai/wiki?110,API+Assistant), and [Chat Assistants](https://wiki.genexus.com/enterprise-ai/wiki?708,Chat+Assistant [soon to be deprecated]).
+- **`chat`**: This module offers facilities to chat with assistants/agents created in Globant Enterprise AI.
+- **`core`**: This module handles interactions with the fundamental components of Globant Enterprise.
+- **`cli`**: This module provides a command-line tool for interacting with the SDK.
+- **`dbg`**: This module includes a debugger to troubleshoot potential SDK issues and gain detailed insights into its operations.
+- **`evaluation`**: This module provides functionality for the evaluation module.
+- **`flows`**: This module enables interactions with [Flows](https://wiki.genexus.com/enterprise-ai/wiki?321,Flows+in+Globant+Enterprise+AI) [in development]. 
+- **`gam`**: This module allows interaction with [GAM] (https://wiki.genexus.com/commwiki/wiki?24746,Table+of+contents%3AGeneXus+Access+Manager+%28GAM%29,).
+- **`health`**: Provides an easy way to check the status of the Globant Enterprise AI instance one is using.
+- **`lab`**: This module facilitates interactions with [The Lab] (https://docs.globant.ai/en/wiki?1671,The+Lab).
+- **`organization`**: This module facilitates interactions with Organizations and [Projects](https://wiki.genexus.com/enterprise-ai/wiki?565,Projects) in Globant Enterprise AI.
+- **`migration`**: This module provides functionality to migrate Agents, Tools and Projects between instances and organizations.
+- **`proxy`**: This module handles [integrations with MCP and A2A] (https://docs.globant.ai/en/wiki?1179,Importing+Tools+using+MCP+and+A2A+Servers).
+
+## Usage
+
+### Install PyGEAI
+Use pip to install the package from PyPI:
+
+```
+(venv) ~$ pip install pygeai
+```
+
+To install pre-release versions, you can run:
+```
+(venv) ~$ pip install --pre pygeai
+```
+
+### Verify installation
+To check the installed PyGEAI version, run:
+
+```
+(venv) ~$ geai v
+```
+
+### View help
+
+To access the general help menu:
+
+```
+(venv) ~$ geai h
+```
+To view help for a specific command:
+
+```
+(venv) ~$ geai <command> h
+```
+
+### Debugger
+
+The `pygeai-dbg` package provides a command-line debugger (`geai-dbg`) for troubleshooting and inspecting the `geai` CLI. 
+It pauses execution at breakpoints, allowing you to inspect variables, execute Python code, and control program flow interactively.
+
+To debug a `geai` command, replace `geai` with `geai-dbg`. For example:
+
+```bash
+(venv) ~$ geai-dbg ail lrs
+```
+
+This pauses at the `main` function in `pygeai.cli.geai`, displaying an interactive prompt `(geai-dbg)`. 
+You can then use commands like `continue` (resume), `run` (run without pauses), `quit` (exit), or `help` (list commands).
+
+
+### Man Pages Documentation
+
+The package includes Unix manual pages (man pages) for detailed command-line documentation. 
+
+To install man pages locally:
+
+```bash
+geai-install-man
+```
+
+To install man pages system-wide:
+
+```bash
+sudo geai-install-man --system
+```
+
+To access the man pages:
+
+```bash
+man geai
+```
+
+#### Setting up Man Pages Access
+
+If you're using a virtual environment, you'll need to configure your system to find the man pages. Add the following to your shell configuration file (`.bashrc`, `.zshrc`, etc.):
+
+```bash
+# For macOS
+if [ -n "$VIRTUAL_ENV" ]; then
+    export MANPATH="$VIRTUAL_ENV/share/man:$MANPATH"
+fi
+
+# For Linux
+if [ -n "$VIRTUAL_ENV" ]; then
+    export MANPATH="$VIRTUAL_ENV/man:$MANPATH"
+fi
+```
+
+After adding this configuration:
+1. Reload your shell configuration: `source ~/.bashrc` or `source ~/.zshrc`
+2. The man pages will be available when your virtual environment is active
+
+## Bugs and suggestions
+To report any bug, request features or make any suggestions, the following email is available:
+
+<geai-sdk@globant.com>
+
+## Authors
+Copyright 2025, Globant. All rights reserved

pygeai-0.6.0b14/docs/source/conf.py

@@ -0,0 +1,117 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+from datetime import datetime
+
+sys.path.insert(0, os.path.abspath('../..'))
+
+# Import version from package
+import pygeai
+
+project = 'PyGEAI'
+author = 'Globant'
+copyright = f'{datetime.now().year}, {author}'
+release = pygeai.__version__
+version = '.'.join(release.split('.')[:2])  # e.g., '0.6' from '0.6.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',       # Auto-generate docs from docstrings
+    'sphinx.ext.napoleon',      # Support for Google/NumPy style docstrings
+    'sphinx.ext.viewcode',      # Add links to source code
+    'sphinx.ext.intersphinx',   # Link to other project documentation
+    'sphinx.ext.autosummary',   # Generate summary tables
+    'sphinx_markdown_builder',  # Build markdown output
+]
+
+templates_path = ['_templates']
+exclude_patterns = [
+    '_build',
+    'Thumbs.db',
+    '.DS_Store',
+]
+
+# Language
+language = 'en'
+
+# Suppress specific warnings
+suppress_warnings = [
+    'ref.duplicate',  # Suppress duplicate implicit target warnings
+]
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+
+# Theme options
+html_theme_options = {
+    'logo_only': False,
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    'style_external_links': True,
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'includehidden': True,
+    'titles_only': False,
+}
+
+# HTML metadata
+html_title = f'{project} v{release} Documentation'
+html_short_title = f'{project} v{version}'
+html_show_sourcelink = False
+html_show_sphinx = False
+
+# -- Autodoc configuration ---------------------------------------------------
+
+autodoc_default_options = {
+    'members': True,
+    'member-order': 'bysource',
+    'special-members': '__init__',
+    'undoc-members': False,  # Hide undocumented members
+    'exclude-members': '__weakref__',
+    'show-inheritance': True,
+    'inherited-members': False,
+}
+
+# Type hints configuration
+autodoc_typehints = 'description'
+autodoc_typehints_description_target = 'documented'
+
+# Mock imports for packages not available during build
+autodoc_mock_imports = []
+
+# -- Intersphinx configuration -----------------------------------------------
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'requests': ('https://requests.readthedocs.io/en/latest/', None),
+}
+
+# -- Napoleon configuration --------------------------------------------------
+
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_preprocess_types = False
+napoleon_type_aliases = None
+napoleon_attr_annotations = True