model-forge-llm 0.2.0__py3-none-any.whl

model_forge_llm-0.2.0.dist-info/METADATA

@@ -0,0 +1,327 @@
+Metadata-Version: 2.4
+Name: model-forge-llm
+Version: 0.2.0
+Summary: A reusable library for managing LLM providers, authentication, and model selection.
+Author: ModelForge Contributors
+License: MIT License
+        
+        Copyright (c) 2025 Shuhai Miao
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/your-org/model-forge
+Project-URL: Repository, https://github.com/your-org/model-forge
+Project-URL: Issues, https://github.com/your-org/model-forge/issues
+Project-URL: Documentation, https://model-forge.readthedocs.io
+Keywords: llm,ai,langchain,openai,ollama,providers,authentication
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: <4.0,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.7
+Requires-Dist: requests>=2.32.3
+Requires-Dist: langchain-core>=0.3.0
+Requires-Dist: langchain-openai>=0.3.0
+Requires-Dist: langchain-community>=0.3.0
+Requires-Dist: langchain-google-genai>=2.1.5
+Requires-Dist: langchain-github-copilot>=0.4.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.2.2; extra == "dev"
+Requires-Dist: pytest-mock>=3.14.0; extra == "dev"
+Requires-Dist: ruff>=0.7.0; extra == "dev"
+Requires-Dist: mypy>=1.11.0; extra == "dev"
+Requires-Dist: pre-commit>=3.8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: types-requests>=2.32.0; extra == "dev"
+Requires-Dist: twine>=6.1.0; extra == "dev"
+Requires-Dist: requests-mock>=1.12.1; extra == "dev"
+Dynamic: license-file
+
+# Model Forge Library
+
+A reusable library for managing LLM providers, authentication, and model selection.
+
+This library is intended to be used by various Python-based AI projects to provide a consistent way to handle LLM interactions.
+
+## High-Level Design
+
+The library is composed of three core modules:
+
+-   **`config`**: Manages configuration files with a two-tier system - global (`~/.config/model-forge/config.json`) and local (`./.model-forge/config.json`) - where all provider and model settings are stored.
+-   **`auth`**: Provides a suite of authentication strategies (API Key, OAuth 2.0 Device Flow, and a No-Op for local models) and handles secure credential storage in configuration files.
+-   **`registry`**: Acts as the main entry point and factory. It reads the configuration, invokes the appropriate authentication strategy, and instantiates ready-to-use, LangChain-compatible LLM objects.
+
+## 🛠️ **Quick Start**
+
+## **Option 1: Traditional Development Setup (Recommended)**
+Best for developers who will use ModelForge frequently:
+
+```bash
+# 1. Run setup script
+./setup.sh
+
+# 2. Use Poetry directly (faster for repeated use)
+poetry run modelforge config show
+poetry run modelforge config add --provider openai --model gpt-4
+```
+
+## **Option 2: Wrapper Script (Quick Usage)**
+Best for occasional use, CI/CD, or Docker environments:
+
+```bash
+# Single command that handles setup + execution
+./modelforge.sh config show
+./modelforge.sh config add --provider openai --model gpt-4
+```
+
+**Performance Comparison:**
+- **Traditional**: ~0.9s per command
+- **Wrapper**: ~1.6s per command (includes setup overhead)
+
+## Local Development & Testing
+
+To test the library locally, you can use the built-in Command-Line Interface (CLI).
+
+**Option 1: Using the setup script (recommended)**
+```bash
+./setup.sh
+```
+
+**Option 2: Manual setup**
+1.  **Set up a virtual environment:**
+    ```bash
+    python -m venv venv
+    source venv/bin/activate
+    ```
+
+2.  **Install the library in editable mode:**
+    This allows you to use the CLI and reflects any code changes immediately without reinstalling.
+    ```bash
+    pip install -e .
+    ```
+
+3.  **Use the CLI to manage your models:**
+    ```bash
+    # Show the current configuration
+    modelforge config show
+
+    # Add a local Ollama model
+    modelforge config add --provider ollama --model qwen3:1.7b
+
+    # Add OpenAI models with API key
+    modelforge config add --provider openai --model gpt-4o-mini --api-key "YOUR_API_KEY_HERE"
+    modelforge config add --provider openai --model gpt-4o --api-model-name "gpt-4o" --api-key "YOUR_API_KEY_HERE"
+
+    # Add a provider requiring an API key (Google Gemini)
+    modelforge config add --provider google --model gemini-pro --api-model-name "gemini-1.5-pro" --api-key "YOUR_API_KEY_HERE"
+
+    # Add GitHub Copilot and trigger the device authentication flow
+    modelforge config add --provider github_copilot --model claude-3.7-sonnet --dev-auth
+
+    # Set a model to be the default
+    modelforge config use --provider ollama --model qwen3:1.7b
+    ```
+
+## Available Models and Providers
+
+**📚 Model Reference:**
+For a comprehensive list of available providers and models, visit **[models.dev](https://models.dev)** - your go-to resource for:
+
+- **Provider Documentation**: Detailed information about each LLM provider
+- **Model Specifications**: Complete model listings with capabilities and pricing
+- **API References**: Authentication methods and integration guides
+- **Model Comparisons**: Performance metrics and use case recommendations
+
+**Supported Providers:**
+- **OpenAI**: GPT-4, GPT-4o, GPT-3.5-turbo, and more
+- **Ollama**: Local models like Llama, Qwen, Mistral, and others
+- **GitHub Copilot**: Claude, GPT-4, and other models via GitHub *(Enhanced Support)*
+- **Google Gemini**: Gemini Pro, Gemini Flash, and other Google models
+
+### 🚀 **Enhanced GitHub Copilot Support**
+
+ModelForge provides **two-tier GitHub Copilot integration** for optimal performance:
+
+#### **🎯 Tier 1: Dedicated ChatGitHubCopilot (Recommended)**
+When `langchain-github-copilot` is installed, ModelForge uses the specialized GitHub Copilot class:
+
+```bash
+# Install the enhanced GitHub Copilot support
+poetry add langchain-github-copilot
+
+# Add GitHub Copilot with device authentication
+./modelforge.sh config add --provider github_copilot --model claude-3.7-sonnet --dev-auth
+```
+
+**Benefits:**
+- ✅ **Optimized for 25-minute token lifecycle**
+- ✅ **GitHub-specific rate limiting**
+- ✅ **Enhanced error handling**
+- ✅ **Built-in token refresh**
+
+#### **🔄 Tier 2: OpenAI-Compatible Fallback**
+If `langchain-github-copilot` is not available, ModelForge automatically falls back to OpenAI-compatible mode:
+
+```bash
+# Works even without langchain-github-copilot installed
+./modelforge.sh config add --provider github_copilot --model claude-3.7-sonnet --dev-auth
+```
+
+**Characteristics:**
+- ⚡ **Universal compatibility**
+- 🛠️ **Manual token management**
+- 📊 **Standard OpenAI interface**
+
+#### **🔍 Installation Options**
+
+```bash
+# Option 1: Full installation with GitHub Copilot enhancement
+git clone <repo>
+cd model-forge
+./setup.sh
+poetry add langchain-github-copilot
+
+# Option 2: Basic installation (fallback mode)
+git clone <repo>
+cd model-forge
+./setup.sh
+# Uses OpenAI-compatible fallback automatically
+```
+
+Use [models.dev](https://models.dev) to explore the full ecosystem and find the perfect model for your use case!
+
+## Configuration System
+
+ModelForge uses a **two-tier configuration system** that provides flexibility for both personal and project-specific setups:
+
+### 🌍 **Global Configuration** (`~/.config/model-forge/config.json`)
+- **Location**: User's config directory (follows XDG Base Directory Standard)
+- **Purpose**: System-wide model configurations shared across all projects
+- **Use case**: Personal API keys, frequently used models, default settings
+
+### 📁 **Local Configuration** (`./.model-forge/config.json`)
+- **Location**: Current working directory (project-specific)
+- **Purpose**: Project-specific model configurations
+- **Use case**: Team projects, specific model requirements, environment-specific settings
+
+### 🔄 **Precedence Rules**
+1. **Local First**: If a local config exists, it takes precedence
+2. **Global Fallback**: If no local config, the global config is used
+3. **Auto-Creation**: If neither exists, a new global config is created
+
+### 💡 **Managing Configurations**
+```bash
+# View current configuration (shows which config is active)
+modelforge config show
+
+# Add to global configuration (default)
+modelforge config add --provider openai --model gpt-4o --api-key "YOUR_KEY"
+
+# Add to local configuration (project-specific)
+modelforge config add --provider openai --model gpt-4o --api-key "YOUR_KEY" --local
+```
+
+Both configuration files use the same JSON structure and are fully compatible with all ModelForge features.
+
+## Code Quality & Development
+
+ModelForge maintains high code quality standards with automated tooling:
+
+### 🔧 **Quality Tools**
+- **Ruff**: Fast linting and formatting
+- **MyPy**: Type checking for reliability
+- **Pre-commit**: Automated quality checks
+- **GitHub Actions**: CI/CD pipeline
+- **Pytest**: Comprehensive testing with coverage
+
+### 📋 **Code Review Guidelines**
+We provide comprehensive code review guidelines for consistent quality:
+- **[Detailed Guidelines](CODE_REVIEW_GUIDELINES.md)**: Complete review criteria and examples
+- **[LLM Prompt](PROMPT_CODE_REVIEW.md)**: Quick prompt for AI-assisted code reviews
+
+### 🚀 **Development Commands**
+```bash
+# Format and check code
+poetry run ruff format .
+poetry run ruff check .
+
+# Type checking
+poetry run mypy src/modelforge
+
+# Run tests with coverage
+poetry run pytest --cov=src/modelforge
+
+# Run all quality checks
+poetry run pre-commit run --all-files
+```
+
+## Integration Guide
+
+To use this library in a host application (e.g., RAG-Forge):
+
+1.  **Install the library:**
+    ```bash
+    # Quick setup (recommended for development)
+    cd /path/to/model-forge && ./setup.sh
+
+    # Or install manually from a local path
+    pip install -e /path/to/model-forge
+
+    # In the future, you would install from a package registry like PyPI
+    # pip install model-forge
+    ```
+
+2.  **Use the `ModelForgeRegistry` in your application:**
+    ```python
+    from modelforge.registry import ModelForgeRegistry
+
+    # 1. Initialize the registry
+    registry = ModelForgeRegistry()
+
+    # 2. See which models the user has configured
+    available_models = registry.list_models()
+    print(f"Available models: {available_models}")
+    # Example output: ['ollama/qwen3:1.7b', 'github_copilot/claude-3.7-sonnet']
+
+    # 3. Get a fully authenticated model instance
+    if available_models:
+        model_id = available_models[0]
+        llm = registry.get_model_instance(model_id)
+
+        if llm:
+            # Now you have a LangChain-compatible LLM object to use
+            response = llm.invoke("Tell me a joke.")
+            print(response)
+    ```
+
+## Features
+
+- **Multi-Provider Support**: OpenAI, Ollama, GitHub Copilot, Google Gemini
+- **Flexible Authentication**: API Key, OAuth 2.0 Device Flow, Local (no auth)
+- **Secure Credential Storage**: Stores API keys and tokens in configuration files
+- **LangChain Integration**: Provides ready-to-use LangChain-compatible model instances
+- **Centralized Configuration**: Single configuration file managing all providers and models

model_forge_llm-0.2.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+model_forge_llm-0.2.0.dist-info/licenses/LICENSE,sha256=g3TKKxfqGlKmBRdCKelUPNrTUBdvDzn0yopE8WeJNDw,1068
+modelforge/__init__.py,sha256=mTsSBmyZPmvMm92g9N0S_47QWM5raWuMLd2f9i81rNg,183
+modelforge/auth.py,sha256=ju0ARgMCEb1cnEY_nJTbGR1o3MaEd-_H4YxFTpbE9Vg,18680
+modelforge/cli.py,sha256=QTgHhUq3gtOb74XLzRAhsX8wF0cdwXPgSwGee2BvIeU,27189
+modelforge/config.py,sha256=77dF1q2P2fo7hBF7YR8OBdcn3yVSSqkQXvJ3NoJvQh8,6814
+modelforge/exceptions.py,sha256=Ld3RG1DuUiekAa1JM4-ivOqfHleN5o2rve1QJ-yZ5No,720
+modelforge/logging_config.py,sha256=SQlPMQkAIRIoItvcfM_P5ZEvfnsvc_O8tniuHN8keNM,1754
+modelforge/modelsdev.py,sha256=9hKPBlE4E2-FY_OTRfxyWkchpmHMwf4rzNh8om4UW5Q,14083
+modelforge/registry.py,sha256=MW3mxYrFdKw5URc4Tn0g9IJIo0DcC8h0YHAXKxjsL5E,10136
+model_forge_llm-0.2.0.dist-info/METADATA,sha256=fkH-IavtAegD3D4Uapef3eEfVdu372HPTjqavM6-43E,12515
+model_forge_llm-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+model_forge_llm-0.2.0.dist-info/entry_points.txt,sha256=y5CZ8kHJCfMVzoj4KX6dMnlMHb4DAvgRy6jUlM0a8wE,50
+model_forge_llm-0.2.0.dist-info/top_level.txt,sha256=ZyKkWfjMHbQ1mlQyLT2xZlbeT0M1jOjB4nRWVR_YiI8,11
+model_forge_llm-0.2.0.dist-info/RECORD,,

model_forge_llm-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

model_forge_llm-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+modelforge = modelforge.cli:cli

model_forge_llm-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shuhai Miao
+
+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.

model_forge_llm-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+modelforge

modelforge/__init__.py

@@ -0,0 +1,7 @@
+"""ModelForge: A reusable library for managing LLM providers and authentication."""
+
+__version__ = "0.2.0"
+
+from .registry import ModelForgeRegistry
+
+__all__ = ["ModelForgeRegistry"]