traffik 1.0.0b1__tar.gz

traffik-1.0.0b1/.dockerignore

@@ -0,0 +1,111 @@
+# .dockerignore for traffik library
+
+# Git
+.git
+.gitignore
+
+# Python cache
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.cache
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Documentation
+docs/_build/
+
+# CI/CD
+.github/
+
+# Docker
+Dockerfile*
+docker-compose*.yml
+.dockerignore
+
+# Package manager
+node_modules/
+npm-debug.log*
+
+# Security
+*.pem
+*.key
+
+# Logs
+*.log
+
+# Temporary files
+tmp/
+temp/
+
+# Editor backups
+*.bak
+*.tmp
+
+# Coverage reports
+htmlcov/
+.coverage.*
+coverage.xml
+*.cover
+.hypothesis/
+
+# Ruff cache
+.ruff_cache/
+
+# MyPy cache
+.mypy_cache/
+
+# UV cache
+.uv_cache/

traffik-1.0.0b1/.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @tioluwa

traffik-1.0.0b1/.github/workflows/code-quality.yaml

@@ -0,0 +1,83 @@
+name: Code Quality
+
+on:
+  # push:
+  #   branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+  workflow_dispatch:  # Allow manual triggering
+  workflow_call: # Allow referencing
+
+concurrency:
+  group: code-quality-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  quality:
+    name: Code Quality Checks
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Check code formatting
+        run: |
+          echo "Checking code formatting..."
+          uv run ruff format src/ tests/
+
+      - name: Run security analysis
+        run: |
+          echo "Running Bandit security analysis..."
+          uv run bandit -r src/ -f json -o bandit-report.json || true
+          uv run bandit -r src/
+        continue-on-error: false
+
+      - name: Upload security reports
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: security-reports
+          path: |
+            bandit-report.json
+          retention-days: 30
+
+  type-check:
+    name: Type Checking
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run type checking
+        run: |
+          echo "Running mypy type checking..."
+          uv run python -m mypy src/ --ignore-missing-imports --no-strict-optional
+        continue-on-error: true  # Optional since you might not have mypy setup yet

traffik-1.0.0b1/.github/workflows/enforce-pr-source.yaml

@@ -0,0 +1,47 @@
+name: Enforce PR Source Branch and Origin
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  enforce-branch-policy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required to access full history
+
+      - name: Add summary
+        run: |
+            echo "## 🔒 Branch Policy Enforcement" >> $GITHUB_STEP_SUMMARY
+            echo "- ✅ Only \`release/*\` and \`hotfix/*\` branches can PR into \`main\`" >> $GITHUB_STEP_SUMMARY
+            echo "- ✅ \`release/*\` must originate from \`develop\`" >> $GITHUB_STEP_SUMMARY
+            echo "- ✅ \`hotfix/*\` must originate from \`main\`" >> $GITHUB_STEP_SUMMARY
+
+      - name: Validate PR source branch and origin
+        run: |
+          SOURCE_BRANCH="${{ github.head_ref }}"
+          TARGET_BRANCH="${{ github.base_ref }}"
+
+          echo "🔍 Checking source: $SOURCE_BRANCH -> target: $TARGET_BRANCH"
+
+          if [[ "$SOURCE_BRANCH" == release/* ]]; then
+            BASE_BRANCH="develop"
+          elif [[ "$SOURCE_BRANCH" == hotfix/* ]]; then
+            BASE_BRANCH="main"
+          else
+            echo "❌ Invalid source branch name: must start with release/ or hotfix/"
+            exit 1
+          fi
+
+          git fetch origin $BASE_BRANCH
+          MERGE_BASE=$(git merge-base origin/$SOURCE_BRANCH origin/$BASE_BRANCH)
+
+          if [[ "$(git rev-parse origin/$BASE_BRANCH)" != "$MERGE_BASE" ]]; then
+            echo "❌ $SOURCE_BRANCH must be based on $BASE_BRANCH"
+            exit 1
+          fi
+
+          echo "✅ $SOURCE_BRANCH is valid and based on $BASE_BRANCH"

traffik-1.0.0b1/.github/workflows/publish.yaml

@@ -0,0 +1,345 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'  # Trigger on version tags like v0.1.0, v1.0.0, etc.
+  release:
+    types: [published]
+  workflow_dispatch:  # Allow manual triggering
+    inputs:
+      test_only:
+        description: 'Publish to TestPyPI only'
+        type: boolean
+        default: true
+
+jobs:
+  # Run code quality workflow 
+  quality-gate:
+    name: Code Quality Assurance Gate
+    uses: ./.github/workflows/code-quality.yaml
+
+
+  # Run the full test suite first
+  test-gate:
+    name: Test Suite Gate
+    uses: ./.github/workflows/test.yaml
+
+
+  # Build and validate package
+  build:
+    name: Build Package
+    runs-on: ubuntu-latest
+    needs: [quality-gate, test-gate]
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      
+      - name: Verify version consistency
+        run: |
+          # Extract version from pyproject.toml and git tag
+          PROJECT_VERSION=$(uv run python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")
+          if [[ "$GITHUB_REF_TYPE" == "tag" ]]; then
+            TAG_VERSION=${GITHUB_REF_NAME#v}
+            if [[ "$PROJECT_VERSION" != "$TAG_VERSION" ]]; then
+              echo "Version mismatch: pyproject.toml has $PROJECT_VERSION but tag is $TAG_VERSION"
+              exit 1
+            fi
+          fi
+          echo "Version: $PROJECT_VERSION"
+
+      - name: Build package
+        run: uv build
+
+      - name: Validate build artifacts
+        run: |
+          ls -la dist/
+          # Verify both wheel and sdist are created
+          test -f dist/*.whl || (echo "No wheel found" && exit 1)
+          test -f dist/*.tar.gz || (echo "No source distribution found" && exit 1)
+          
+          # Check package contents
+          uv run python -m zipfile -l dist/*.whl
+          uv run python -m tarfile -l dist/*.tar.gz
+
+          echo "✅ Build artifacts created successfully"
+
+      - name: Install and test built package
+        run: |
+          # Install the wheel in a clean environment
+          uv venv test-env
+          uv pip install dist/*.whl
+          uv run python -c "
+          import traffik
+          from traffik.backends.inmemory import InMemoryBackend
+          from traffik.throttles import HTTPThrottle
+          print('✅ Built package works correctly')
+          "
+      
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ github.sha }}
+          path: dist/
+          retention-days: 30
+
+
+  # Publish to TestPyPI for testing
+  publish-testpypi:
+    name: Publish to TestPyPI
+    runs-on: ubuntu-latest
+    needs: build
+    if: >
+      github.event_name == 'workflow_dispatch' || 
+      (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')) ||
+      github.event_name == 'release'
+    
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/traffik
+
+    outputs:
+      published: ${{ steps.publish-step.outputs.published || steps.skip-step.outputs.published || 'false' }}
+      version: ${{ steps.get-version.outputs.version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Install jq for version parsing
+        run: uv pip install jq --system
+
+      - name: Get project version
+        id: get-version
+        run: |
+          VERSION=$(uv run python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+
+      - name: Check if version already exists on TestPyPI
+        id: version-check
+        run: |
+          VERSION="${{ steps.get-version.outputs.version }}"
+          if curl -sSf https://test.pypi.org/pypi/traffik/json | jq -e ".releases[\"$VERSION\"]" > /dev/null; then
+            echo "exists=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "exists=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Skip publishing (version exists)
+        if: steps.version-check.outputs.exists == 'true'
+        run: echo "⚠️ Version already exists on TestPyPI. Skipping publish."
+        
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist-${{ github.sha }}
+          path: dist/
+
+      - name: Publish to TestPyPI
+        id: publish-step
+        if: steps.version-check.outputs.exists == 'false'
+        run: |
+          uv publish --index testpypi
+          echo "published=true" >> "$GITHUB_OUTPUT"
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.TEST_PYPI_API_TOKEN }}
+
+      - name: Mark as skipped
+        if: steps.version-check.outputs.exists == 'true'
+        id: skip-step
+        run: echo "published=false" >> "$GITHUB_OUTPUT"
+
+  
+  # Verify TestPyPI installation
+  verify-testpypi:
+    name: Verify TestPyPI Installation
+    runs-on: ubuntu-latest
+    needs: publish-testpypi
+    if: needs.publish-testpypi.result == 'success' && needs.publish-testpypi.outputs.published == 'true'
+    continue-on-error: true
+
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Wait for TestPyPI availability
+        run: |
+          echo "⏳ Waiting for package to be available on TestPyPI..."
+          sleep 60  # Give TestPyPI time to process
+
+      - name: Install from TestPyPI
+        run: |
+          pip install --index-url https://test.pypi.org/simple/ \
+                      --extra-index-url https://pypi.org/simple/ \
+                      traffik[all] --prefer-binary
+
+      - name: Test installation and functionality
+        run: |
+          python -c "
+          import asyncio
+          import traffik
+          from traffik.backends.inmemory import InMemoryBackend
+          from traffik.throttles import HTTPThrottle
+          
+          print('✅ Package imported successfully')
+          print(f'Version: {getattr(traffik, \"__version__\", \"unknown\")}')
+          
+          async def test():
+              backend = InMemoryBackend()
+              async with backend():
+                  throttle = HTTPThrottle(limit=5, seconds=60)
+                  print('✅ Basic functionality works')
+          
+          asyncio.run(test())
+          "
+
+
+  # Publish to PyPI (production)
+  publish-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [build, publish-testpypi]
+    if: >
+      github.event_name == 'release' && 
+      github.event.action == 'published' &&
+      !github.event.release.prerelease &&
+      (github.event.inputs.test_only != 'true' || github.event.inputs.test_only == '') &&
+      always() &&
+      needs.build.result == 'success' &&
+      needs.publish-testpypi.result == 'success'
+    
+    environment:
+      name: pypi
+      url: https://pypi.org/p/traffik
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Install jq for version parsing
+        run: uv pip install jq --system
+
+      - name: Get project version
+        id: get-version
+        run: |
+          VERSION=$(uv run python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+
+      - name: Check if version already exists on PyPI
+        id: version-check
+        run: |
+          VERSION="${{ steps.get-version.outputs.version }}"
+          if curl -sSf https://pypi.org/pypi/traffik/json | jq -e ".releases[\"$VERSION\"]" > /dev/null; then
+            echo "exists=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "exists=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Skip publishing (version exists)
+        if: steps.version-check.outputs.exists == 'true'
+        run: echo "⚠️ Version already exists on PyPI. Skipping publish."
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist-${{ github.sha }}
+          path: dist/
+
+      - name: Final validation before PyPI
+        if: steps.version-check.outputs.exists == 'false'
+        run: |
+          echo "🚀 Publishing to PyPI..."
+          ls -la dist/
+          
+          # Double-check we're not publishing a dev version
+          if uv run python -c "import tomllib; version=tomllib.load(open('pyproject.toml', 'rb'))['project']['version']; exit(1 if 'dev' in version or 'alpha' in version or 'beta' in version or 'rc' in version else 0)"; then
+            echo "✅ Version looks stable for PyPI"
+          else
+            echo "❌ Version appears to be a pre-release"
+            exit 1
+          fi
+
+      - name: Publish to PyPI
+        if: steps.version-check.outputs.exists == 'false'
+        run: uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+
+
+  # Post-publish verification
+  verify-pypi:
+    name: Verify PyPI Installation
+    runs-on: ubuntu-latest
+    needs: publish-pypi
+    if: success()
+    
+    steps:
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Wait for PyPI availability
+        run: |
+          echo "⏳ Waiting for package to be available on PyPI..."
+          sleep 120  # Give PyPI time to process
+
+      - name: Install from PyPI
+        run: pip install traffik[all]
+
+      - name: Verify installation
+        run: |
+          python -c "
+          import traffik
+          print(f'✅🎉 Successfully installed traffik {getattr(traffik, \"__version__\", \"unknown\")} from PyPI')
+          "
+      
+      - name: Create release summary
+        run: |
+          echo "## 🎉 Release Summary" >> $GITHUB_STEP_SUMMARY
+          echo "- ✅ Quality checks passed" >> $GITHUB_STEP_SUMMARY
+          echo "- ✅ All tests passed" >> $GITHUB_STEP_SUMMARY
+          echo "- ✅ Security checks passed" >> $GITHUB_STEP_SUMMARY
+          echo "- ✅ Package built successfully" >> $GITHUB_STEP_SUMMARY
+          echo "- ✅ Published to TestPyPI" >> $GITHUB_STEP_SUMMARY
+          echo "- ✅ TestPyPI installation verified" >> $GITHUB_STEP_SUMMARY
+          echo "- ✅ Published to PyPI" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "📦 Package is now available: \`pip install traffik\`" >> $GITHUB_STEP_SUMMARY