genai-otel-instrument 0.1.1.dev0__tar.gz

genai_otel_instrument-0.1.1.dev0/.claude/settings.local.json

@@ -0,0 +1,10 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(python -m pytest tests/test_logging_config.py::test_setup_logging_closes_existing_handlers -v --cov=genai_otel/logging_config --cov-report=term-missing)",
+      "Bash(pytest:*)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}

genai_otel_instrument-0.1.1.dev0/.github/workflows/README.md

@@ -0,0 +1,203 @@
+# CI/CD Workflows
+
+This directory contains GitHub Actions workflows for automated testing, validation, and publishing.
+
+## Workflows
+
+### 1. `test.yml` - Continuous Integration Tests
+
+**Triggers:**
+- Push to `main` or `develop` branches
+- Pull requests to `main` or `develop` branches
+
+**Jobs:**
+
+#### `test` job
+- **Matrix:** Runs on Ubuntu, macOS, and Windows with Python 3.8-3.12
+- **Steps:**
+  1. Lint with pylint
+  2. Check formatting with black
+  3. Check import sorting with isort
+  4. Type check with mypy
+  5. Run pytest with coverage
+  6. Upload coverage to Codecov
+
+#### `build-and-install-test` job
+- **Matrix:** Runs on Ubuntu and Windows with Python 3.9 and 3.12
+- **Purpose:** Validates that the package can be built and installed correctly
+- **Steps:**
+  1. Build the package using `python -m build`
+  2. Check package with `twine check`
+  3. Install in isolated virtual environment
+  4. Test core imports
+  5. Verify CLI tool works (`genai-instrument --help`)
+
+#### `security` job
+- **Platform:** Ubuntu with Python 3.11
+- **Steps:**
+  1. Run safety check for dependency vulnerabilities
+  2. Run bandit security scan
+
+### 2. `publish.yml` - PyPI Publication
+
+**Triggers:**
+- Release published on GitHub
+- Manual workflow dispatch (for testing)
+
+**Steps:**
+1. **Test Suite:** Runs full pytest suite to ensure all tests pass
+2. **Code Quality:** Validates formatting and import sorting
+3. **Build:** Creates wheel and sdist packages
+4. **Validation:** Checks package with twine
+5. **Installation Test:** Tests package installation in clean environment
+6. **Publish to Test PyPI:** Uploads to Test PyPI (if release event)
+7. **Publish to PyPI:** Uploads to production PyPI (if release event)
+
+**Required Secrets:**
+- `TEST_PYPI_API_TOKEN`: API token for Test PyPI
+- `PYPI_API_TOKEN`: API token for production PyPI
+
+### 3. `pre-release-check.yml` - Pre-Release Validation
+
+**Triggers:**
+- Manual workflow dispatch
+- Push of version tags (`v*`)
+
+**Purpose:** Comprehensive validation before creating a release (mimics `scripts/test_release.sh`)
+
+**Matrix:** Runs on Ubuntu, Windows, and macOS with Python 3.9 and 3.12
+
+**Steps:**
+1. Display environment information
+2. Install development dependencies
+3. Auto-format code (isort + black)
+4. Run full test suite with coverage
+5. Perform code quality checks
+6. Build package
+7. Validate package with twine
+8. Test installation in isolated environment
+9. Verify CLI functionality
+10. Upload build artifacts (Ubuntu + Python 3.12 only)
+
+**Use this workflow:**
+- Before creating a new release
+- To validate your changes work across all platforms
+- As a final check that everything is ready for publication
+
+## Usage Examples
+
+### Running Pre-Release Validation Manually
+
+1. Go to "Actions" tab in GitHub
+2. Select "Pre-Release Validation" workflow
+3. Click "Run workflow"
+4. Select branch and click "Run workflow"
+
+This will run all validation checks across all platforms.
+
+### Creating a Release
+
+1. **Run Pre-Release Validation:**
+   ```bash
+   # Locally, you can use:
+   ./scripts/test_release.sh
+
+   # Or trigger the GitHub Action manually
+   ```
+
+2. **Ensure all checks pass**
+
+3. **Create and push a version tag:**
+   ```bash
+   git tag v0.2.0
+   git push origin v0.2.0
+   ```
+   This triggers the pre-release-check workflow.
+
+4. **Create GitHub Release:**
+   - Go to "Releases" → "Draft a new release"
+   - Select the tag you created
+   - Fill in release notes
+   - Click "Publish release"
+
+   This triggers the publish workflow which will:
+   - Run tests
+   - Build package
+   - Publish to Test PyPI
+   - Publish to PyPI
+
+### Manual Testing Before Release
+
+Use the local script for faster iteration:
+
+```bash
+# From project root
+./scripts/test_release.sh
+```
+
+This script provides colored output and validates:
+- Project structure
+- Python environment
+- Code formatting (auto-applies)
+- Full test suite
+- Package build
+- Package validation
+- Installation in isolated environment
+- CLI functionality
+
+## Workflow Dependencies
+
+All workflows require these tools (automatically installed):
+- `pytest` - Testing framework
+- `pytest-cov` - Coverage plugin
+- `black` - Code formatter
+- `isort` - Import sorter
+- `pylint` - Linter
+- `mypy` - Type checker
+- `build` - Package builder
+- `twine` - Package uploader
+
+## Best Practices
+
+1. **Before committing:**
+   - Run `black genai_otel tests`
+   - Run `isort genai_otel tests`
+   - Run `pytest tests/`
+
+2. **Before creating a PR:**
+   - Ensure all CI checks pass
+   - Review coverage report
+
+3. **Before releasing:**
+   - Run `./scripts/test_release.sh` locally
+   - Trigger "Pre-Release Validation" workflow
+   - Verify all platforms pass
+   - Update CHANGELOG.md
+   - Update version in `genai_otel/__version__.py`
+
+4. **After releasing:**
+   - Test installation from PyPI: `pip install genai-otel-instrument`
+   - Verify functionality with example code
+   - Monitor for any user-reported issues
+
+## Troubleshooting
+
+### Tests fail only on specific OS
+- Check for platform-specific path handling
+- Review file permission issues (especially on Windows)
+- Check line ending differences (CRLF vs LF)
+
+### Package build fails
+- Ensure `pyproject.toml` is valid
+- Check MANIFEST.in includes all necessary files
+- Verify dependencies are correctly specified
+
+### Installation test fails
+- Check entry points in `pyproject.toml`
+- Verify all required files are included in the package
+- Test locally with: `pip install dist/*.whl`
+
+### CLI tool not found after installation
+- Verify `[project.scripts]` section in `pyproject.toml`
+- Check that console_scripts entry point is correct
+- Test with: `python -m genai_otel.cli`

genai_otel_instrument-0.1.1.dev0/.github/workflows/pre-release-check.yml

@@ -0,0 +1,128 @@
+name: Pre-Release Validation
+
+# This workflow mimics the manual test_release.sh script
+# Run it before creating a release to validate everything works
+
+on:
+  workflow_dispatch:  # Manual trigger only
+  push:
+    tags:
+      - 'v*'  # Trigger on version tags
+
+jobs:
+  pre-release-validation:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.9", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Display environment info
+      run: |
+        echo "=========================================="
+        echo "Pre-Release Validation"
+        echo "=========================================="
+        python --version
+        python -c "import sys; print(f'Python path: {sys.executable}')"
+
+    - name: Install development dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+
+    - name: Auto-format code
+      run: |
+        echo "→ Auto-formatting code with isort and black..."
+        isort genai_otel tests
+        black genai_otel tests
+        echo "✓ Code formatting applied"
+
+    - name: Run full test suite
+      run: |
+        echo "→ Running tests..."
+        pytest tests/ -v --cov=genai_otel --cov-report=term --cov-report=html --cov-report=term-missing
+        echo "✓ All tests passed"
+
+    - name: Code quality checks
+      run: |
+        echo "→ Running code quality checks..."
+        black --check genai_otel tests --exclude='__version__\.py'
+        isort --check-only --skip-glob='*/__version__.py' genai_otel tests
+        pylint genai_otel --rcfile=.pylintrc --exit-zero || true
+        echo "✓ Code quality checks complete"
+
+    - name: Build package
+      run: |
+        echo "→ Building package..."
+        pip install build twine
+        python -m build
+        echo "✓ Package built successfully"
+
+    - name: Check package with twine
+      run: |
+        echo "→ Checking package with twine..."
+        twine check dist/*
+        echo "✓ Package check passed"
+
+    - name: Test installation in isolated environment
+      shell: bash
+      run: |
+        echo "→ Testing installation in temporary environment..."
+
+        # Create temporary virtual environment
+        python -m venv test_release_env
+
+        # Activate based on OS
+        if [[ "$RUNNER_OS" == "Windows" ]]; then
+          source test_release_env/Scripts/activate
+        else
+          source test_release_env/bin/activate
+        fi
+
+        # Install the built wheel
+        pip install dist/*.whl
+
+        # Test imports
+        python -c 'import genai_otel; print(f"Successfully imported genai_otel version: {genai_otel.__version__}")'
+        python -c 'from genai_otel.config import OTelConfig; from genai_otel.cost_calculator import CostCalculator; from genai_otel.auto_instrument import setup_auto_instrumentation; print("All core components imported successfully")'
+
+        # Test CLI tool
+        genai-instrument --help > /dev/null 2>&1
+        echo "✓ CLI tool works"
+
+        # Cleanup
+        deactivate
+
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v4
+      if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+      with:
+        name: dist-packages
+        path: dist/
+
+    - name: Summary
+      if: success()
+      run: |
+        echo ""
+        echo "=========================================="
+        echo "✓ All Pre-Release Checks Passed!"
+        echo "=========================================="
+        echo ""
+        echo "Release Checklist:"
+        echo "✅ All tests passing"
+        echo "✅ Code formatting applied"
+        echo "✅ Import sorting applied"
+        echo "✅ Package builds successfully"
+        echo "✅ Installation tested"
+        echo "✅ CLI tool works"
+        echo ""
+        echo "Ready for release! 🚀"

genai_otel_instrument-0.1.1.dev0/.github/workflows/publish.yml

@@ -0,0 +1,77 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:  # Allow manual triggering for testing
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+
+    # Run full test suite before publishing
+    - name: Install dev dependencies and run tests
+      run: |
+        pip install -e ".[dev]"
+        pytest tests/ -v --cov=genai_otel --cov-report=term
+        echo "✓ All tests passed"
+
+    # Code quality checks
+    - name: Format and lint checks
+      run: |
+        black --check genai_otel tests --exclude='__version__\.py'
+        isort --check-only --skip-glob='*/__version__.py' genai_otel tests
+        echo "✓ Code quality checks passed"
+
+    - name: Build package
+      run: python -m build
+
+    - name: Check package with twine
+      run: twine check dist/*
+
+    # Test installation before publishing
+    - name: Test package installation
+      run: |
+        python -m venv test_env
+        source test_env/bin/activate
+        pip install dist/*.whl
+
+        # Test imports
+        python -c 'import genai_otel; print(f"Successfully imported genai_otel version: {genai_otel.__version__}")'
+        python -c 'from genai_otel.config import OTelConfig; from genai_otel.cost_calculator import CostCalculator; print("All core components imported successfully")'
+
+        # Test CLI
+        genai-instrument --help
+        echo "✓ CLI tool works"
+
+        deactivate
+        rm -rf test_env
+
+    - name: Publish to Test PyPI
+      if: github.event_name == 'release'
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+      run: |
+        twine upload --repository testpypi dist/* --skip-existing || echo "Package may already exist on Test PyPI"
+
+    - name: Publish to PyPI
+      if: github.event_name == 'release'
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: |
+        twine upload dist/*

genai_otel_instrument-0.1.1.dev0/.github/workflows/test.yml

@@ -0,0 +1,135 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+
+    - name: Lint with pylint
+      run: |
+        pylint genai_otel --rcfile=.pylintrc || true
+
+    - name: Check formatting with black
+      run: |
+        black --check genai_otel tests --exclude='__version__\.py'
+
+    - name: Check import sorting with isort
+      run: |
+        isort --check-only --skip-glob='*/__version__.py' genai_otel tests
+
+    - name: Type check with mypy
+      run: |
+        mypy genai_otel || true
+
+    - name: Run tests
+      run: |
+        pytest tests/ -v --cov=genai_otel --cov-report=xml --cov-report=term
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        fail_ci_if_error: false
+
+  # New job: Test package build and installation
+  build-and-install-test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.9", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+
+    - name: Build package
+      run: python -m build
+
+    - name: Check package with twine
+      run: twine check dist/*
+
+    - name: Test installation in isolated environment
+      shell: bash
+      run: |
+        # Create a temporary directory for testing
+        python -m venv test_env
+
+        # Activate virtual environment
+        if [[ "$RUNNER_OS" == "Windows" ]]; then
+          source test_env/Scripts/activate
+        else
+          source test_env/bin/activate
+        fi
+
+        # Install the built wheel
+        pip install dist/*.whl
+
+        # Test imports
+        python -c 'import genai_otel; print(f"Successfully imported genai_otel version: {genai_otel.__version__}")'
+        python -c 'from genai_otel.config import OTelConfig; from genai_otel.cost_calculator import CostCalculator; from genai_otel.auto_instrument import setup_auto_instrumentation; print("All core components imported successfully")'
+
+        # Test CLI tool
+        genai-instrument --help
+        echo "CLI tool works"
+
+        # Cleanup
+        deactivate
+
+  security:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install safety bandit
+
+    - name: Run safety check
+      run: |
+        safety check || true
+
+    - name: Run bandit security check
+      run: |
+        bandit -r genai_otel -ll || true