Add tldr example

.github/workflows/test-examples.yml

@@ -0,0 +1,90 @@
+name: Test Examples
+
+on:
+  push:
+    branches: [ main, master ]
+    paths:
+      - 'examples/**'
+      - '.github/workflows/test-examples.yml'
+  pull_request:
+    branches: [ main, master ]
+    paths:
+      - 'examples/**'
+      - '.github/workflows/test-examples.yml'
+
+jobs:
+  test-tldr-example:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        version: "latest"
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Install dependencies for tldr example
+      run: |
+        cd examples/tldr
+        uv sync
+
+    - name: Run comprehensive tldr tests
+      run: |
+        cd examples/tldr
+        uv run python test_tldr.py
+
+    - name: Test URL functionality
+      run: |
+        cd examples/tldr
+        echo "Testing URL input with a simple robots.txt file..."
+        # Test URL functionality - this may work if API keys are available
+        output=$(uv run python tldr.py https://httpbin.org/robots.txt 2>&1)
+        exit_code=$?
+
+        if [ $exit_code -eq 0 ] && [ -n "$output" ]; then
+          echo "✓ URL fetching and summarization successful"
+          echo "  Generated summary: $output"
+        elif echo "$output" | grep -E "(api key|credentials|authentication|provider)" -i > /dev/null; then
+          echo "✓ URL fetching works, failed at LLM creation due to missing API keys"
+        else
+          echo "⚠ URL test output: $output"
+          # Don't fail the test if it's just an API-related issue
+        fi
+
+  test-tldr-syntax:
+    # Test basic syntax and imports
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        version: "latest"
+
+    - name: Set up Python 3.11
+      run: uv python install 3.11
+
+    - name: Install dependencies
+      run: |
+        cd examples/tldr
+        uv sync
+
+    - name: Test Python syntax
+      run: |
+        cd examples/tldr
+        python -m py_compile tldr.py
+        echo "✓ tldr.py has valid Python syntax"
+
+    - name: Test that script has valid Python structure
+      run: |
+        cd examples/tldr
+        python -c "import ast; ast.parse(open('tldr.py').read()); print('✓ tldr.py has valid Python AST structure')"

examples/tldr/.python-version

@@ -0,0 +1 @@
+3.11

examples/tldr/pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+name = "tldr"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "langchain==0.3.27",
+    "python-dotenv==1.0.1",
+    "langchaingang[all]",
+]
+
+[tool.uv.sources]
+langchaingang = { workspace = true }

examples/tldr/test_sample.txt

@@ -0,0 +1,11 @@
+The History of Artificial Intelligence
+
+Artificial intelligence (AI) has been a subject of fascination and research for decades. The field began in earnest in the 1950s when computer scientists started exploring whether machines could be made to think like humans.
+
+Early pioneers like Alan Turing proposed the famous Turing Test as a way to measure machine intelligence. In 1956, the Dartmouth Conference is often cited as the birth of AI as a formal academic discipline.
+
+Throughout the 1960s and 1970s, researchers developed various approaches to AI, including symbolic reasoning and expert systems. However, the field experienced several "AI winters" - periods of reduced funding and interest due to overpromising and underdelivering on capabilities.
+
+The 1980s saw a resurgence with expert systems, and the 1990s brought machine learning to the forefront. The 2000s introduced more sophisticated algorithms and the 2010s ushered in the era of deep learning.
+
+Today, AI is ubiquitous in our daily lives, powering everything from search engines to recommendation systems to autonomous vehicles. The field continues to evolve rapidly with new breakthroughs in natural language processing, computer vision, and general artificial intelligence.

examples/tldr/test_tldr.py

@@ -0,0 +1,231 @@
+#!/usr/bin/env python3
+"""
+Basic tests for the tldr script to ensure it functions correctly.
+"""
+import os
+import subprocess
+import sys
+import tempfile
+from pathlib import Path
+
+
+def run_command(cmd, cwd=None, expect_failure=False):
+    """Run a command and return the result."""
+    try:
+        result = subprocess.run(
+            cmd, shell=True, capture_output=True, text=True, cwd=cwd
+        )
+        if not expect_failure and result.returncode != 0:
+            print(f"Command failed: {cmd}")
+            print(f"STDOUT: {result.stdout}")
+            print(f"STDERR: {result.stderr}")
+            return None
+        return result
+    except Exception as e:
+        print(f"Error running command {cmd}: {e}")
+        return None
+
+
+def test_help():
+    """Test that the help command works."""
+    print("Testing --help option...")
+    result = run_command("uv run python tldr.py --help")
+    if result and "summarize a document" in result.stdout.lower():
+        print("✓ Help command works correctly")
+        return True
+    else:
+        print("✗ Help command failed")
+        return False
+
+
+def test_imports():
+    """Test that all required imports work."""
+    print("Testing imports...")
+    test_script = """
+try:
+    import argparse
+    import urllib.request
+    from dotenv import load_dotenv
+    from langchain_core.output_parsers import StrOutputParser
+    from langchain_core.prompts import ChatPromptTemplate
+    from langchaingang import get_chat_model, get_provider_list
+    print("SUCCESS: All imports work")
+except ImportError as e:
+    print(f"FAILED: Import error: {e}")
+    sys.exit(1)
+"""
+
+    with tempfile.NamedTemporaryFile(mode="w", suffix=".py", delete=False) as f:
+        f.write(test_script)
+        f.flush()
+
+        result = run_command(f"uv run python {f.name}")
+        os.unlink(f.name)
+
+        if result and "SUCCESS" in result.stdout:
+            print("✓ All imports work correctly")
+            return True
+        else:
+            print("✗ Import test failed")
+            if result:
+                print(f"Output: {result.stdout}")
+                print(f"Error: {result.stderr}")
+            return False
+
+
+def test_provider_list():
+    """Test that the provider list function works."""
+    print("Testing provider list...")
+    test_script = """
+from langchaingang import get_provider_list
+providers = get_provider_list()
+print(f"Available providers: {providers}")
+if isinstance(providers, list):
+    print("SUCCESS: Provider list is a list")
+else:
+    print("FAILED: Provider list is not a list")
+    sys.exit(1)
+"""
+
+    with tempfile.NamedTemporaryFile(mode="w", suffix=".py", delete=False) as f:
+        f.write(test_script)
+        f.flush()
+
+        result = run_command(f"uv run python {f.name}")
+        os.unlink(f.name)
+
+        if result and "SUCCESS" in result.stdout:
+            print("✓ Provider list works correctly")
+            return True
+        else:
+            print("✗ Provider list test failed")
+            return False
+
+
+def test_file_reading():
+    """Test that the script can read a file and either generate a summary or fail gracefully."""
+    print("Testing file reading and basic functionality...")
+
+    # Check if test file exists
+    if not os.path.exists("test_sample.txt"):
+        print("✗ test_sample.txt not found")
+        return False
+
+    # Run the script - it might work if API keys are available, or fail gracefully
+    result = run_command("uv run python tldr.py test_sample.txt")
+
+    if result is None:
+        print("✗ Command execution failed")
+        return False
+
+    output = result.stdout + result.stderr
+
+    # Check for various successful scenarios
+    if result.returncode == 0 and len(output.strip()) > 0:
+        # Script ran successfully and produced output (likely a summary)
+        print("✓ Script successfully generated a summary")
+        print(f"  Summary length: {len(output.strip())} characters")
+        return True
+    elif any(
+        phrase in output.lower()
+        for phrase in [
+            "api key",
+            "credentials",
+            "authentication",
+            "provider",
+            "token",
+            "key",
+            "auth",
+            "access",
+        ]
+    ):
+        print(
+            "✓ File reading successful (failed at LLM creation due to missing API keys)"
+        )
+        return True
+    elif "no such file" in output.lower() or "file not found" in output.lower():
+        print("✗ File reading failed")
+        print(f"Output: {output}")
+        return False
+    else:
+        # Script ran but with unexpected output
+        print(f"⚠ Script ran with unexpected output: {output[:100]}...")
+        # If it didn't crash, we'll consider this a pass
+        return result.returncode == 0
+
+
+def test_argument_parsing():
+    """Test various argument combinations."""
+    print("Testing argument parsing...")
+
+    # Test invalid provider
+    result = run_command(
+        "uv run python tldr.py test_sample.txt --provider invalid_provider",
+        expect_failure=True,
+    )
+    if result and "invalid choice" in result.stderr.lower():
+        print("✓ Invalid provider correctly rejected")
+    else:
+        print("⚠ Invalid provider test inconclusive")
+
+    # Test valid providers (might work or fail depending on API keys)
+    providers_to_test = ["openai", "anthropic"]
+    for provider in providers_to_test:
+        result = run_command(
+            f"uv run python tldr.py test_sample.txt --provider {provider}"
+        )
+        if result:
+            output = result.stdout + result.stderr
+            if result.returncode == 0 and len(output.strip()) > 0:
+                print(f"✓ Provider {provider} successfully generated output")
+            elif any(
+                phrase in output.lower()
+                for phrase in ["api key", "credentials", "auth"]
+            ):
+                print(f"✓ Provider {provider} argument accepted (missing credentials)")
+            else:
+                print(f"⚠ Provider {provider} test inconclusive: {output[:50]}...")
+
+    return True
+
+
+def main():
+    """Run all tests."""
+    print("Running TLDR script tests...")
+    print("=" * 50)
+
+    # Change to the script directory
+    script_dir = Path(__file__).parent
+    os.chdir(script_dir)
+
+    tests = [
+        test_help,
+        test_imports,
+        test_provider_list,
+        test_file_reading,
+        test_argument_parsing,
+    ]
+
+    passed = 0
+    total = len(tests)
+
+    for test in tests:
+        try:
+            if test():
+                passed += 1
+        except Exception as e:
+            print(f"✗ Test {test.__name__} raised exception: {e}")
+        print("-" * 30)
+
+    print(f"\nResults: {passed}/{total} tests passed")
+
+    if passed == total:
+        print("🎉 All tests passed!")
+        return 0
+    else:
+        print("❌ Some tests failed")
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())