diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644
index 0000000..a2db687
--- /dev/null
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,146 @@
+name: Corebrain SDK CI/CD
+
+on:
+ push:
+ branches: [ main, develop ]
+ tags:
+ - 'v*'
+ pull_request:
+ branches: [ main, develop ]
+
+jobs:
+ test:
+ runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ python-version: ['3.8', '3.9', '3.10', '3.11']
+
+ services:
+ # PostgreSQL service for integration tests
+ postgres:
+ image: postgres:13
+ env:
+ POSTGRES_PASSWORD: postgres
+ POSTGRES_USER: postgres
+ POSTGRES_DB: test_db
+ ports:
+ - 5432:5432
+ options: >-
+ --health-cmd pg_isready
+ --health-interval 10s
+ --health-timeout 5s
+ --health-retries 5
+
+ # MongoDB service for NoSQL integration tests
+ mongodb:
+ image: mongo:4.4
+ ports:
+ - 27017:27017
+ options: >-
+ --health-cmd "mongo --eval 'db.runCommand({ ping: 1 })'"
+ --health-interval 10s
+ --health-timeout 5s
+ --health-retries 5
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v4
+ with:
+ python-version: ${{ matrix.python-version }}
+ cache: 'pip'
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install .[dev,all_db]
+
+ - name: Lint with flake8
+ run: |
+ flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+
+ - name: Type check with mypy
+ run: |
+ mypy core db cli utils
+
+ - name: Format check with black
+ run: |
+ black --check .
+
+ - name: Test with pytest
+ run: |
+ pytest --cov=. --cov-report=xml
+
+ - name: Upload coverage to Codecov
+ uses: codecov/codecov-action@v3
+ with:
+ file: ./coverage.xml
+ fail_ci_if_error: false
+
+ build-and-publish:
+ needs: test
+ runs-on: ubuntu-latest
+ if: startsWith(github.ref, 'refs/tags/v')
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.10'
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install build twine
+
+ - name: Build package
+ run: |
+ python -m build
+
+ - name: Publish to PyPI
+ uses: pypa/gh-action-pypi-publish@release/v1
+ with:
+ user: __token__
+ password: ${{ secrets.PYPI_API_TOKEN }}
+ skip_existing: true
+
+ docker:
+ needs: test
+ runs-on: ubuntu-latest
+ if: |
+ (github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop')) ||
+ startsWith(github.ref, 'refs/tags/v')
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v2
+
+ - name: Login to DockerHub
+ uses: docker/login-action@v2
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+ - name: Extract metadata for Docker
+ id: meta
+ uses: docker/metadata-action@v4
+ with:
+ images: corebrain/sdk
+ tags: |
+ type=ref,event=branch
+ type=ref,event=tag
+ type=semver,pattern={{version}}
+ type=sha,format=short
+
+ - name: Build and push
+ uses: docker/build-push-action@v3
+ with:
+ context: .
+ push: true
+ tags: ${{ steps.meta.outputs.tags }}
+ labels: ${{ steps.meta.outputs.labels }}
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 0a19790..cf98110 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,6 +2,10 @@
__pycache__/
*.py[cod]
*$py.class
+venv/
+.tofix/
+README-no-valid.md
+requirements.txt
# C extensions
*.so
@@ -14,7 +18,7 @@ dist/
downloads/
eggs/
.eggs/
-lib/
+#lib/
lib64/
parts/
sdist/
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..a034212
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "corebrain/CLI-UI"]
+ path = corebrain/CLI-UI
+ url = https://github.com/Luki20091/CLI-UI.git
diff --git a/1 b/1
new file mode 100644
index 0000000..e69de29
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..47e6927
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,147 @@
+# How to Contribute to Corebrain SDK
+
+Thank you for your interest in contributing to CoreBrain SDK! This document provides guidelines for contributing to the project.
+
+## Code of Conduct
+
+By participating in this project, you commit to maintaining a respectful and collaborative environment.
+
+## How to Contribute
+
+### Reporting Bugs
+
+1. Verify that the bug hasn't already been reported in the [issues](https://github.com/ceoweggo/Corebrain/issues)
+2. Use the bug template to create a new issue
+3. Include as much detail as possible: steps to reproduce, environment, versions, etc.
+4. If possible, include a minimal example that reproduces the problem
+
+### Suggesting Improvements
+
+1. Check the [issues](https://github.com/ceoweggo/Corebrain/issues) to see if it has already been suggested
+2. Use the feature template to create a new issue
+3. Clearly describe the improvement and justify its value
+
+### Submitting Changes
+
+1. Fork the repository
+2. Create a branch for your change (`git checkout -b feature/amazing-feature`)
+3. Make your changes following the code conventions
+4. Write tests for your changes
+5. Ensure all tests pass
+6. Commit your changes (`git commit -m 'Add amazing feature'`)
+7. Push your branch (`git push origin feature/amazing-feature`)
+8. Open a Pull Request
+
+## Development Environment
+
+### Installation for Development
+
+```bash
+# Clone the repository
+git clone https://github.com/ceoweggo/Corebrain.git
+cd sdk
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate # On Windows: venv\Scripts\activate
+
+# Install for development
+pip install -e ".[dev]"
+```
+
+### Project Structure
+
+```
+v1/
+├── corebrain/ # Main package
+│ ├── __init__.py
+│ ├── _pycache_/
+│ ├── cli/ # Command-line interface
+│ ├── config/ # Configuration management
+│ ├── core/ # Core functionality
+│ ├── db/ # Database interactions
+│ ├── lib/ # Library components
+│ └── SSO/ # Globodain SSO Authentication
+│ ├── network/ # Network functionality
+│ ├── services/ # Service implementations
+│ ├── utils/ # Utility functions
+│ ├── cli.py # CLI entry point
+│ └── sdk.py # SDK entry point
+├── corebrain.egg-info/ # Package metadata
+├── docs/ # Documentation
+├── examples/ # Usage examples
+├── screenshots/ # Project screenshots
+├── venv/ # Virtual environment (not to be committed)
+├── .github/ # GitHub files directory
+├── _pycache_/ # Python cache files
+├── .tofix/ # Files to be fixed
+├── .gitignore # Git ignore rules
+├── CONTRIBUTING.md # Contribution guidelines
+├── health.py # Health check script
+├── LICENSE # License information
+├── pyproject.toml # Project configuration
+├── README-no-valid.md # Outdated README
+├── README.md # Project overview
+├── requirements.txt # Production dependencies
+└── setup.py # Package setup
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run specific test file
+pytest tests/test_specific.py
+
+# Run tests with coverage
+pytest --cov=corebrain
+```
+
+## Coding Standards
+
+### Style Guide
+
+- We follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) for Python code
+- Use 4 spaces for indentation
+- Maximum line length is 88 characters
+- Use descriptive variable and function names
+
+### Documentation
+
+- All modules, classes, and functions should have docstrings
+- Follow the [Google docstring format](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings)
+- Keep documentation up-to-date with code changes
+
+### Commit Messages
+
+- Use clear, concise commit messages
+- Start with a verb in the present tense (e.g., "Add feature" not "Added feature")
+- Reference issue numbers when applicable (e.g., "Fix #123: Resolve memory leak")
+
+## Pull Request Process
+
+1. Update documentation if necessary
+2. Add or update tests as needed
+3. Ensure CI checks pass
+4. Request a review from maintainers
+5. Address review feedback
+6. Maintainers will merge your PR once approved
+
+## Release Process
+
+Our maintainers follow semantic versioning (MAJOR.MINOR.PATCH):
+- MAJOR version for incompatible API changes
+- MINOR version for backward-compatible functionality
+- PATCH version for backward-compatible bug fixes
+
+## Getting Help
+
+If you need help with anything:
+- Join our [Discord community](https://discord.gg/m2AXjPn2yV)
+- Join our [Whatsapp Channel](https://whatsapp.com/channel/0029Vap43Vy5EjxvR4rncQ1I)
+- Ask questions in the GitHub Discussions
+- Contact the maintainers at ruben@globodain.com
+
+Thank you for contributing to Corebrain SDK!
\ No newline at end of file
diff --git a/FETCH_HEAD b/FETCH_HEAD
new file mode 100644
index 0000000..e69de29
diff --git a/README.md b/README.md
index 22ebdd7..01a3ad5 100644
--- a/README.md
+++ b/README.md
@@ -1,106 +1,211 @@
-# Corebrain
+# Corebrain SDK
-
-
-
+
+[](https://badge.fury.io/py/corebrain)
+[](https://opensource.org/licenses/MIT)
-## What is Corebrain?
+SDK for natural language queries to relational and non-relational databases. Enables interaction with databases using natural language questions.
-Corebrain is an open-source enterprise solution designed to centralize and optimize corporate data management. The project offers a scalable architecture for processing, analyzing, and visualizing critical information for decision-making.
+## ✨ Features
-**IMPORTANT NOTE**: In the current version (0.1.0-alpha), only the SQL code is functional. Other modules are under development.
+- **Natural Language Queries**: Transforms human language questions into database queries (SQL/NoSQL)
+- **Multi-Database Support**: Compatible with SQLite, MySQL, PostgreSQL, and MongoDB
+- **Unified Interface**: Consistent API across different database types
+- **Built-in CLI**: Interact with your databases directly from the terminal
+- **Strong Security**: Robust authentication and secure credential management
+- **Highly Extensible**: Designed for easy integration with new engines and features
+- **Comprehensive Documentation**: Usage examples, API reference, and step-by-step guides
-## Current Status
+## 📋 Requirements
-- ✅ SQL queries for data extraction
-- ✅ Database schemas
-- ✅ Authentication service
-- ❌ NoSQL (in development)
-- ❌ Frontend (in development)
-- ❌ REST API (in development)
+- Python 3.8+
+- Specific dependencies based on the database engine:
+ - **SQLite**: Included in Python
+ - **PostgreSQL**: `psycopg2-binary`
+ - **MySQL**: `mysql-connector-python`
+ - **MongoDB**: `pymongo`
-## SDK Integration
-Corebrain provides SDKs for multiple programming languages, making it easy to integrate with your existing systems. While only SQL in Python functionality is currently available, this SDK will support all features and most common languages as they are developed.
+## 🔧 Installation
-
+### From PyPI (recommended)
-## Available Versions
+```bash
+# Minimal installation
+pip install corebrain
-- **`main` Branch**: Stable version with verified functionality (currently only SQL is functional)
-- **`pre-release` Branch**: Initial version with all features in development (may contain errors)
+### From source code
-## Getting Started
+```bash
-### Installation
+git clone https://github.com/ceoweggo/Corebrain.git
+git submodule update --init --recursive
+pip install -e .
-```bash
-# Clone the repository
-git clone https://github.com/your-organization/corebrain.git
+```
-# Enter the directory
-cd corebrain
+## 🚀 Quick Start Guide
+
+### Initialization
+
+> **⚠️ IMPORTANT:**
+> * If you don't have an existing configuration, first run `corebrain --configure`
+> * If you need to generate a new API key, use `corebrain --create`
+> * Never share your API key in public repositories. Use environment variables instead.
+
+
+```python
+from corebrain import init
+
+# Initialize with a previously saved configuration
+corebrain = init(
+ api_key="your_api_key",
+ config_id="your_config_id"
+)
+```
+
+### Making Natural Language Queries
+
+```python
+# Simple query
+result = client.ask("How many active users are there?")
+print(result["explanation"]) # Natural language explanation
+print(result["query"]) # Generated SQL/NoSQL query
+print(result["results"]) # Query results
+
+# Query with additional parameters
+result = client.ask(
+ "Show the last 5 orders",
+ collection_name="orders",
+ limit=5,
+ filters={"status": "completed"}
+)
+
+# Iterate over the results
+for item in result["results"]:
+ print(item)
+```
-# Install dependencies
-npm install
+### Getting the Database Schema
+
+```python
+# Get the complete schema
+schema = client.db_schema
+
+# List all tables/collections
+tables = client.list_collections_name()
+print(tables)
```
-### Configuration
+### Closing the Connection
-1. Use `corebrain --configure` to start the configuration.
-2. Once configuration has been completed, copy the config_id and replace in your example code (see 'examples' folder).
-3. Run the example code in Python and enjoy!
+```python
+# It's recommended to close the connection when finished
+client.close()
-### Basic Usage
+# Or use the with context
+with init(api_key="your_api_key", config_id="your_config_id") as client:
+ result = client.ask("How many users are there?")
+ print(result["explanation"])
+```
+
+## 🖥️ Command Line Interface Usage
+
+### Configure Connection
```bash
-# Run SQL migrations
-npm run migrate
+# Init configuration
+corebrain --configure
+```
-# Start the SQL service
-npm run sql:start
+### Display Database Schema
+
+```bash
+# Show complete schema
+corebrain --show-schema
```
-## Accessing the Pre-release Version
+### List Configurations
-If you want to test all features under development (including unstable components), you can switch to the pre-release branch:
+```bash
+# List all configurations
+corebrain --list-configs
+```
+
+## 📝 Advanced Documentation
+
+### Configuration Management
+
+```python
+from corebrain import list_configurations, remove_configuration, get_config
+
+# List all configurations
+configs = list_configurations(api_token="your_api_token")
+print(configs)
+
+# Get details of a configuration
+config = get_config(api_token="your_api_token", config_id="your_config_id")
+print(config)
+
+# Remove a configuration
+removed = remove_configuration(api_token="your_api_token", config_id="your_config_id")
+print(f"Configuration removed: {removed}")
+```
+
+## 🧪 Testing and Development
+
+### Development Installation
```bash
-git checkout pre-release
-npm install
+# Clone the repository
+git clone https://github.com/ceoweggo/Corebrain.git
+cd corebrain
+
+# Install in development mode with extra tools
+
+# On Windows (use powershell)
+.\setup.ps1
+
+# On Linux/macOS (use bash)
+./setup.sh
```
-**Warning**: The pre-release version contains experimental features with bugs or unexpected behaviors. Not recommended for production environments.
+### Verifying Style and Typing
-## Contributing
+```bash
+# Check style with flake8
+flake8 .
-Corebrain is an open-source project, and we welcome all contributions. To contribute:
+# Check typing with mypy
+mypy core db cli utils
-1. Fork the repository
-2. Create a new branch (`git checkout -b feature/new-feature`)
-3. Make your changes
-4. Run tests (`npm test`)
-5. Commit your changes (`git commit -m 'Add new feature'`)
-6. Push to your fork (`git push origin feature/new-feature`)
-7. Open a Pull Request
+# Format code with black
+black .
+```
-Please read our [contribution guidelines](CONTRIBUTING.md) before you start.
+### Continuous Integration and Deployment (CI/CD)
-## Roadmap
+The project uses GitHub Actions to automate:
-- **0.1.0**: Basic SQL operation. OpenAI connected. Authentication service Globodain SSO integrated. API Keys configuration integrated.
-- **0.2.0**: NoSQL (MongoDB) fixed. API Key creation by command "Corebrain --configure". Functional version.
-- **0.3.0**: API deployment and integration at source. Functional version for third parties.
-...
-- **1.0.0**: First stable version with all features.
+1. **Testing**: Runs tests on multiple Python versions (3.8-3.11)
+2. **Quality Verification**: Checks style, typing, and formatting
+3. **Coverage**: Generates code coverage reports
+4. **Automatic Publication**: Publishes new versions to PyPI when tags are created
+5. **Docker Images**: Builds and publishes Docker images with each version
-You can see the full report at [Project Roadmap](https://github.com/users/ceoweggo/projects/4/views/2)
+You can see the complete configuration in `.github/workflows/ci.yml`.
-## License
+## 🛠️ Contributions
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+Contributions are welcome! To contribute:
+
+1. Fork the repository
+2. Create a branch for your feature (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
-## Contact
+Please make sure your changes pass all tests and comply with the style guidelines.
-- **Email**: [ruben@globodain.com](mailto:ruben@globodain.com)
-- **Issues**: [Report a problem](https://github.com/ceoweggo/corebrain/issues)
+## 📄 License
+Distributed under the MIT License. See `LICENSE` for more information.
diff --git a/config.json b/config.json
new file mode 100644
index 0000000..5092964
--- /dev/null
+++ b/config.json
@@ -0,0 +1,10 @@
+{
+ "type": "nosql",
+ "engine": "mongodb",
+ "host": "localhost",
+ "port": 27017,
+ "database": "baza",
+ "config_id": "a1e0694f-112d-4ade-aa31-68e6d83abab6",
+ "excluded_tables": [],
+ "active": true
+}
\ No newline at end of file
diff --git a/corebrain/.github/workflows/ci.yml b/corebrain/.github/workflows/ci.yml
new file mode 100644
index 0000000..a2db687
--- /dev/null
+++ b/corebrain/.github/workflows/ci.yml
@@ -0,0 +1,146 @@
+name: Corebrain SDK CI/CD
+
+on:
+ push:
+ branches: [ main, develop ]
+ tags:
+ - 'v*'
+ pull_request:
+ branches: [ main, develop ]
+
+jobs:
+ test:
+ runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ python-version: ['3.8', '3.9', '3.10', '3.11']
+
+ services:
+ # PostgreSQL service for integration tests
+ postgres:
+ image: postgres:13
+ env:
+ POSTGRES_PASSWORD: postgres
+ POSTGRES_USER: postgres
+ POSTGRES_DB: test_db
+ ports:
+ - 5432:5432
+ options: >-
+ --health-cmd pg_isready
+ --health-interval 10s
+ --health-timeout 5s
+ --health-retries 5
+
+ # MongoDB service for NoSQL integration tests
+ mongodb:
+ image: mongo:4.4
+ ports:
+ - 27017:27017
+ options: >-
+ --health-cmd "mongo --eval 'db.runCommand({ ping: 1 })'"
+ --health-interval 10s
+ --health-timeout 5s
+ --health-retries 5
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v4
+ with:
+ python-version: ${{ matrix.python-version }}
+ cache: 'pip'
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install .[dev,all_db]
+
+ - name: Lint with flake8
+ run: |
+ flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+
+ - name: Type check with mypy
+ run: |
+ mypy core db cli utils
+
+ - name: Format check with black
+ run: |
+ black --check .
+
+ - name: Test with pytest
+ run: |
+ pytest --cov=. --cov-report=xml
+
+ - name: Upload coverage to Codecov
+ uses: codecov/codecov-action@v3
+ with:
+ file: ./coverage.xml
+ fail_ci_if_error: false
+
+ build-and-publish:
+ needs: test
+ runs-on: ubuntu-latest
+ if: startsWith(github.ref, 'refs/tags/v')
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.10'
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install build twine
+
+ - name: Build package
+ run: |
+ python -m build
+
+ - name: Publish to PyPI
+ uses: pypa/gh-action-pypi-publish@release/v1
+ with:
+ user: __token__
+ password: ${{ secrets.PYPI_API_TOKEN }}
+ skip_existing: true
+
+ docker:
+ needs: test
+ runs-on: ubuntu-latest
+ if: |
+ (github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop')) ||
+ startsWith(github.ref, 'refs/tags/v')
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v2
+
+ - name: Login to DockerHub
+ uses: docker/login-action@v2
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+ - name: Extract metadata for Docker
+ id: meta
+ uses: docker/metadata-action@v4
+ with:
+ images: corebrain/sdk
+ tags: |
+ type=ref,event=branch
+ type=ref,event=tag
+ type=semver,pattern={{version}}
+ type=sha,format=short
+
+ - name: Build and push
+ uses: docker/build-push-action@v3
+ with:
+ context: .
+ push: true
+ tags: ${{ steps.meta.outputs.tags }}
+ labels: ${{ steps.meta.outputs.labels }}
\ No newline at end of file
diff --git a/corebrain/CLI-UI b/corebrain/CLI-UI
new file mode 160000
index 0000000..98143ed
--- /dev/null
+++ b/corebrain/CLI-UI
@@ -0,0 +1 @@
+Subproject commit 98143ed62dd0ec68a5bd181292af4bea88f0218b
diff --git a/corebrain/__init__.py b/corebrain/__init__.py
new file mode 100644
index 0000000..6d2bc2e
--- /dev/null
+++ b/corebrain/__init__.py
@@ -0,0 +1,83 @@
+"""
+Corebrain SDK.
+
+This package provides a Python SDK for interacting with the Corebrain API
+and enables natural language queries to relational and non-relational databases.
+"""
+import logging
+from typing import Dict, Any, List, Optional
+
+# Basic logging configuration
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
+
+# Safe imports (no circular dependencies)
+from corebrain.db.engines import get_available_engines
+from corebrain.core.client import Corebrain
+from corebrain.config.manager import ConfigManager
+
+# Explicit export of public components
+__all__ = [
+ 'init',
+ 'extract_db_schema',
+ 'list_configurations',
+ 'remove_configuration',
+ 'get_available_engines',
+ 'get_config',
+ '__version__'
+]
+
+def init(api_key: str, config_id: str, skip_verification: bool = False) -> Corebrain:
+ """
+ Initialize the Corebrain SDK with the provided API key and configuration.
+
+ Args:
+ api_key: API Key de Corebrain
+ config_id: ID de la configuración a usar
+
+ Returns:
+ Instancia de Corebrain configurada
+ """
+ return Corebrain(api_key=api_key, config_id=config_id, skip_verification=skip_verification)
+
+# Package-level convenience features
+def list_configurations(api_key: str) -> List[str]:
+ """
+ Lists the available configurations for an API key.
+
+ Args:
+ api_key: Corebrain API Key
+
+ Returns:
+ List of available configuration IDs
+ """
+ config_manager = ConfigManager()
+ return config_manager.list_configs(api_key)
+
+def remove_configuration(api_key: str, config_id: str) -> bool:
+ """
+ Deletes a specific configuration.
+
+ Args:
+ api_key: Corebrain API Key
+ config_id: ID of the configuration to delete
+
+ Returns:
+ True if deleted successfully, False otherwise
+ """
+ config_manager = ConfigManager()
+ return config_manager.remove_config(api_key, config_id)
+
+def get_config(api_key: str, config_id: str) -> Optional[Dict[str, Any]]:
+ """
+ Retrieves a specific configuration.
+
+ Args:
+ api_key: Corebrain API Key
+ config_id: ID of the configuration to retrieve
+
+ Returns:
+ Dictionary with the configuration or None if it does not exist
+ """
+ config_manager = ConfigManager()
+ return config_manager.get_config(api_key, config_id)
\ No newline at end of file
diff --git a/corebrain/cli.py b/corebrain/cli.py
new file mode 100644
index 0000000..7e17025
--- /dev/null
+++ b/corebrain/cli.py
@@ -0,0 +1,8 @@
+"""
+Entry point for the Corebrain CLI for compatibility.
+"""
+from corebrain.cli.__main__ import main
+
+if __name__ == "__main__":
+ import sys
+ sys.exit(main())
\ No newline at end of file
diff --git a/corebrain/cli/__init__.py b/corebrain/cli/__init__.py
new file mode 100644
index 0000000..108326c
--- /dev/null
+++ b/corebrain/cli/__init__.py
@@ -0,0 +1,57 @@
+"""
+Command-line interface for the Corebrain SDK.
+
+This module provides a command-line interface to configure
+and use the Corebrain SDK for natural language queries to databases.
+"""
+import sys
+from typing import Optional, List
+
+# Import core components for CLI
+from corebrain.cli.commands import main_cli
+from corebrain.cli.utils import print_colored, ProgressTracker, get_free_port
+from corebrain.cli.config import (
+ configure_sdk,
+ get_db_type,
+ get_db_engine,
+ get_connection_params,
+ test_database_connection,
+ select_excluded_tables
+)
+from corebrain.cli.auth import (
+ authenticate_with_sso,
+ fetch_api_keys,
+ exchange_sso_token_for_api_token,
+ verify_api_token
+)
+
+
+# Explicit export of public components
+__all__ = [
+ 'main_cli',
+ 'run_cli',
+ 'print_colored',
+ 'ProgressTracker',
+ 'get_free_port',
+ 'configure_sdk',
+ 'authenticate_with_sso',
+ 'fetch_api_keys',
+ 'exchange_sso_token_for_api_token',
+ 'verify_api_token'
+]
+
+# Convenience function for running CLI
+def run_cli(argv: Optional[List[str]] = None) -> int:
+ """
+ Run the CLI with the provided arguments.
+
+ Args:
+ argv: List of arguments (use sys.argv if None)
+
+ Returns:
+ Exit code
+ """
+ if argv is None:
+ argv = sys.argv[1:]
+
+ return main_cli(argv)
\ No newline at end of file
diff --git a/corebrain/cli/__main__.py b/corebrain/cli/__main__.py
new file mode 100644
index 0000000..db91155
--- /dev/null
+++ b/corebrain/cli/__main__.py
@@ -0,0 +1,12 @@
+"""
+Entry point to run the CLI as a module.
+"""
+import sys
+from corebrain.cli.commands import main_cli
+
+def main():
+ """Main function for the entry point in pyproject.toml."""
+ return main_cli()
+
+if __name__ == "__main__":
+ sys.exit(main())
\ No newline at end of file
diff --git a/corebrain/cli/auth/__init__.py b/corebrain/cli/auth/__init__.py
new file mode 100644
index 0000000..a601c7b
--- /dev/null
+++ b/corebrain/cli/auth/__init__.py
@@ -0,0 +1,22 @@
+"""
+Authentication modules for the Corebrain CLI.
+
+This package provides functionality for authentication,
+token management, and API keys in the Corebrain CLI.
+"""
+from corebrain.cli.auth.sso import authenticate_with_sso, TokenHandler
+from corebrain.cli.auth.api_keys import (
+ fetch_api_keys,
+ exchange_sso_token_for_api_token,
+ verify_api_token,
+ get_api_key_id_from_token
+)
+# Explicit export of public components
+__all__ = [
+ 'authenticate_with_sso',
+ 'TokenHandler',
+ 'fetch_api_keys',
+ 'exchange_sso_token_for_api_token',
+ 'verify_api_token',
+ 'get_api_key_id_from_token'
+]
\ No newline at end of file
diff --git a/corebrain/cli/auth/api_keys.py b/corebrain/cli/auth/api_keys.py
new file mode 100644
index 0000000..5be72f0
--- /dev/null
+++ b/corebrain/cli/auth/api_keys.py
@@ -0,0 +1,299 @@
+"""
+API Keys Management for the CLI.
+"""
+import uuid
+import httpx
+
+from typing import Optional, Dict, Any, Tuple
+
+from corebrain.cli.utils import print_colored
+from corebrain.network.client import http_session
+from corebrain.core.client import Corebrain
+
+def verify_api_token(token: str, api_url: Optional[str] = None, user_data: Optional[Dict[str, Any]] = None) -> Tuple[bool, Optional[Dict[str, Any]]]:
+ """
+ Verifies if an API token is valid.
+
+ Args:
+ token (str): API token to verify.
+ api_url (str, optional): API URL. Defaults to None.
+ user_data (dict, optional): User data. Defaults to None.
+
+ Returns:
+ tuple: (validity (bool), user information (dict)) if valid, else (False, None).
+ """
+ try:
+ # Create a temporary SDK instance to verify the token
+ config = {"type": "test", "config_id": str(uuid.uuid4())}
+ kwargs = {"api_token": token, "db_config": config}
+
+ if user_data:
+ kwargs["user_data"] = user_data
+
+ if api_url:
+ kwargs["api_url"] = api_url
+
+ sdk = Corebrain(**kwargs)
+ return True, sdk.user_info
+ except Exception as e:
+ print_colored(f"Error verifying API token: {str(e)}", "red")
+ return False, None
+
+def fetch_api_keys(api_url: str, api_token: str, user_data: Dict[str, Any]) -> Optional[str]:
+ """
+ Retrieves the available API keys for the user and allows selecting one.
+
+ Args:
+ api_url: Base URL of the Corebrain API
+ api_token: API token (exchanged from SSO token)
+ user_data: User data
+
+ Returns:
+ Selected API key or None if none is selected
+ """
+ if not user_data or 'id' not in user_data:
+ print_colored("Could not identify the user to retrieve their API keys.", "yellow")
+ return None
+
+ try:
+ # Ensure protocol in URL
+ if not api_url.startswith(("http://", "https://")):
+ api_url = "https://" + api_url
+
+ # Remove trailing slash if it exists
+ if api_url.endswith('/'):
+ api_url = api_url[:-1]
+
+ # Build endpoint to get API keys
+ endpoint = f"{api_url}/api/auth/api-keys"
+
+ print_colored(f"Requesting user's API keys...", "blue")
+
+ # Configure client with timeout and error handling
+ headers = {
+ "Authorization": f"Bearer {api_token}",
+ "Content-Type": "application/json"
+ }
+
+ response = http_session.get(endpoint, headers=headers)
+
+ # Verify response
+ if response.status_code == 200:
+ try:
+ api_keys_data = response.json()
+ # Verify response format
+ if not isinstance(api_keys_data, (list, dict)):
+ print_colored(f"Unexpected response format: {type(api_keys_data)}", "yellow")
+ return None
+
+ # Handle both direct list and dictionary with list
+ api_keys = api_keys_data if isinstance(api_keys_data, list) else api_keys_data.get("data", [])
+
+ if not api_keys:
+ print_colored("No API keys available for this user.", "yellow")
+ return None
+
+ print_colored(f"\nFound {len(api_keys)} API keys", "green")
+ print_colored("\n=== Available API Keys ===", "blue")
+
+ # Show available API keys
+ for i, key_info in enumerate(api_keys, 1):
+ key_id = key_info.get('id', 'No ID')
+ key_value = key_info.get('key', 'No value')
+ key_name = key_info.get('name', 'No name')
+ key_active = key_info.get('active')
+
+ # Show status with color
+ status_color = "green" if key_active == True else "red"
+ status_text = "Active" if key_active == True else "Inactive"
+
+ print(f"{i}. {key_name} - {print_colored(status_text, status_color, return_str=True)} (Value: {key_value})")
+
+ # Ask user to select an API key
+ while True:
+ try:
+ choice = input(f"\nSelect an API key (1-{len(api_keys)}) or press Enter to cancel: ").strip()
+
+ # Allow canceling and using API token
+ if not choice:
+ print_colored("No API key selected.", "yellow")
+ return None
+
+ choice_num = int(choice)
+ if 1 <= choice_num <= len(api_keys):
+ selected_key = api_keys[choice_num - 1]
+
+ # Verify if the key is active
+ if selected_key.get('active') != True:
+ print_colored("⚠️ The selected API key is not active. Select another one.", "yellow")
+ continue
+
+ # Get information of the selected key
+ key_name = selected_key.get('name', 'Unknown')
+ key_value = selected_key.get('key', None)
+
+ if not key_value:
+ print_colored("⚠️ The selected API key does not have a valid value.", "yellow")
+ continue
+
+ print_colored(f"✅ You selected: {key_name}", "green")
+ print_colored("Wait while we assign the API key to your SDK...", "yellow")
+
+ return key_value
+ else:
+ print_colored("Invalid option. Try again.", "red")
+ except ValueError:
+ print_colored("Please enter a valid number.", "red")
+ except Exception as e:
+ print_colored(f"Error processing JSON response: {str(e)}", "red")
+ return None
+ else:
+ # Handle error by status code
+ error_message = f"Error retrieving API keys: {response.status_code}"
+
+ try:
+ error_data = response.json()
+ if "message" in error_data:
+ error_message += f" - {error_data['message']}"
+ elif "detail" in error_data:
+ error_message += f" - {error_data['detail']}"
+ except:
+ # If we can't parse JSON, use the full text
+ error_message += f" - {response.text[:100]}..."
+
+ print_colored(error_message, "red")
+
+ # Try to identify common problems
+ if response.status_code == 401:
+ print_colored("The authentication token has expired or is invalid.", "yellow")
+ elif response.status_code == 403:
+ print_colored("You don't have permissions to access the API keys.", "yellow")
+ elif response.status_code == 404:
+ print_colored("The API keys endpoint doesn't exist. Verify the API URL.", "yellow")
+ elif response.status_code >= 500:
+ print_colored("Server error. Try again later.", "yellow")
+
+ return None
+
+ except httpx.RequestError as e:
+ print_colored(f"Connection error: {str(e)}", "red")
+ print_colored("Verify the API URL and your internet connection.", "yellow")
+ return None
+ except Exception as e:
+ print_colored(f"Unexpected error retrieving API keys: {str(e)}", "red")
+ return None
+
+def get_api_key_id_from_token(sso_token: str, api_token: str, api_url: str) -> Optional[str]:
+ """
+ Gets the ID of an API key from its token.
+
+ Args:
+ sso_token: SSO token
+ api_token: API token
+ api_url: API URL
+
+ Returns:
+ API key ID or None if it cannot be obtained
+ """
+ try:
+ # Endpoint to get information of the current user
+ endpoint = f"{api_url}/api/auth/api-keys/{api_token}"
+
+ headers = {
+ "Authorization": f"Bearer {api_token}",
+ "Content-Type": "application/json"
+ }
+
+ response = httpx.get(
+ endpoint,
+ headers=headers
+ )
+
+ print("API keys response: ", response.json())
+
+ if response.status_code == 200:
+ key_data = response.json()
+ key_id = key_data.get("id")
+ return key_id
+ else:
+ print_colored("⚠️ Could not find the API key ID", "yellow")
+ return None
+
+ except Exception as e:
+ print_colored(f"Error getting API key ID: {str(e)}", "red")
+ return None
+
+def exchange_sso_token_for_api_token(api_url: str, sso_token: str, user_data: Dict[str, Any]) -> Optional[str]:
+ """
+ Exchanges a Globodain SSO token for a Corebrain API token.
+
+ Args:
+ api_url: Base URL of the Corebrain API
+ sso_token: Globodain SSO token
+ user_data: User data
+
+ Returns:
+ API token or None if it fails
+ """
+ try:
+ # Ensure protocol in URL
+ if not api_url.startswith(("http://", "https://")):
+ api_url = "https://" + api_url
+
+ # Remove trailing slash if it exists
+ if api_url.endswith('/'):
+ api_url = api_url[:-1]
+
+ # Endpoint to exchange token
+ endpoint = f"{api_url}/api/auth/sso/token"
+
+ print_colored(f"Exchanging SSO token for API token...", "blue")
+
+ # Configure client with timeout and error handling
+ headers = {
+ 'Authorization': f'Bearer {sso_token}',
+ 'Content-Type': 'application/json'
+ }
+ body = {
+ "user_data": user_data
+ }
+
+ response = http_session.post(endpoint, json=body, headers=headers)
+
+ if response.status_code == 200:
+ try:
+ token_data = response.json()
+ api_token = token_data.get("access_token")
+
+ if not api_token:
+ print_colored("The response does not contain a valid API token", "red")
+ return None
+
+ print_colored("✅ API token successfully obtained", "green")
+ return api_token
+ except Exception as e:
+ print_colored(f"Error processing JSON response: {str(e)}", "red")
+ return None
+ else:
+ # Handle error by status code
+ error_message = f"Error exchanging token: {response.status_code}"
+
+ try:
+ error_data = response.json()
+ if "message" in error_data:
+ error_message += f" - {error_data['message']}"
+ elif "detail" in error_data:
+ error_message += f" - {error_data['detail']}"
+ except:
+ # If we can't parse JSON, use the full text
+ error_message += f" - {response.text[:100]}..."
+
+ print_colored(error_message, "red")
+ return None
+
+ except httpx.RequestError as e:
+ print_colored(f"Connection error: {str(e)}", "red")
+ return None
+ except Exception as e:
+ print_colored(f"Unexpected error exchanging token: {str(e)}", "red")
+ return None
\ No newline at end of file
diff --git a/corebrain/cli/auth/sso.py b/corebrain/cli/auth/sso.py
new file mode 100644
index 0000000..4f97ce4
--- /dev/null
+++ b/corebrain/cli/auth/sso.py
@@ -0,0 +1,469 @@
+"""
+SSO Authentication for the CLI.
+"""
+import os
+import webbrowser
+import http.server
+import socketserver
+import threading
+import urllib.parse
+import time
+import json
+
+from typing import Tuple, Dict, Any, Optional
+
+from corebrain.cli.common import DEFAULT_API_URL, DEFAULT_SSO_URL, DEFAULT_PORT, SSO_CLIENT_ID, SSO_CLIENT_SECRET
+from corebrain.cli.utils import print_colored
+from corebrain.lib.sso.auth import GlobodainSSOAuth
+
+class TokenHandler(http.server.SimpleHTTPRequestHandler):
+ """
+ Handler for the local HTTP server that processes the SSO authentication callback.
+ """
+ def __init__(self, *args, **kwargs):
+ self.sso_auth = kwargs.pop('sso_auth', None)
+ self.result = kwargs.pop('result', {})
+ self.session_data = kwargs.pop('session_data', {})
+ self.auth_completed = kwargs.pop('auth_completed', None)
+ super().__init__(*args, **kwargs)
+
+ def do_GET(self):
+ # Parse the URL to get the parameters
+ parsed_path = urllib.parse.urlparse(self.path)
+
+ # Check if it's the callback path
+ if parsed_path.path == "/auth/sso/callback":
+ query = urllib.parse.parse_qs(parsed_path.query)
+
+ if "code" in query:
+ code = query["code"][0]
+
+ try:
+ # Exchange code for token using the sso_auth object
+ token_data = self.sso_auth.exchange_code_for_token(code)
+
+ if not token_data:
+ raise ValueError("Could not obtain the token")
+
+ # Save token in the result and session
+ access_token = token_data.get('access_token')
+ if not access_token:
+ raise ValueError("The received token does not contain an access_token")
+
+ # Updated: save as sso_token for clarity
+ self.result["sso_token"] = access_token
+ self.session_data['sso_token'] = token_data
+
+ # Get user information
+ user_info = self.sso_auth.get_user_info(access_token)
+ if user_info:
+ self.session_data['user'] = user_info
+ # Extract email to identify the user
+ if 'email' in user_info:
+ self.session_data['email'] = user_info['email']
+
+ # Signal that authentication has completed
+ self.auth_completed.set()
+
+ # Send a success response to the browser
+ self.send_response(200)
+ self.send_header("Content-type", "text/html")
+ self.end_headers()
+ success_html = """
+
+
+ Corebrain - Authentication Completed
+
+
+
+
+
Authentication Completed
+
You have successfully logged in to Corebrain CLI.
+
You can close this window and return to the terminal.
+
+
Authentication Error
+
Error: {str(e)}
+
Please close this window and try again.
+
+
Authentication Error
+
Could not complete the authentication process.
+
Please close this window and try again.
+