strapi-kit 0.0.1__tar.gz

strapi_kit-0.0.1/.coderabbit.yaml

@@ -0,0 +1,83 @@
+# CodeRabbit Configuration for strapi-kit
+# AI-powered code review for pull requests
+# Configuration follows CodeRabbit v2 schema
+
+# Language configuration
+language: en-US
+
+# Early access features
+early_access: false
+
+# Tone and style
+tone_instructions: |
+  - Be constructive and helpful
+  - Focus on code quality, security, and maintainability
+  - Suggest improvements with examples when possible
+  - Acknowledge good practices
+  - Be concise but clear
+
+# Review settings
+reviews:
+  high_level_summary: true
+  review_status: true
+  collapse_walkthrough: false
+
+  auto_review:
+    enabled: true
+    drafts: false
+    base_branches:
+      - main
+      - dev
+
+  # Path-based filters (files to skip reviewing)
+  path_filters:
+    - "!**/*.md"
+    - "!**/*.txt"
+    - "!**/*.json"
+    - "!**/*.yaml"
+    - "!**/*.yml"
+    - "!**/__pycache__/**"
+    - "!**/*.pyc"
+    - "!**/dist/**"
+    - "!**/build/**"
+    - "!**/.venv/**"
+
+  # Path-specific instructions
+  path_instructions:
+    - path: "tests/**"
+      instructions: |
+        - Focus on test correctness and coverage
+        - Ensure both sync and async tests are present
+        - Check for proper use of fixtures and mocks
+        - Verify async tests use proper asyncio patterns
+
+    - path: "src/strapi_kit/**"
+      instructions: |
+        - Verify type hints are complete and accurate (mypy strict mode)
+        - Check for proper exception handling with specific exception types
+        - Ensure docstrings follow Google style
+        - Look for security issues (injection, secrets, etc.)
+        - Verify both sync and async implementations are consistent
+        - Check Pydantic models have proper validation
+
+    - path: "**/*.py"
+      instructions: |
+        - Python 3.12+ features are encouraged
+        - Use type hints for all functions
+        - Follow project's exception hierarchy
+        - Keep functions focused and single-purpose
+        - Avoid over-engineering or premature abstraction
+
+# AI chat
+chat:
+  auto_reply: true
+
+# Knowledge base
+knowledge_base:
+  learnings:
+    scope: local
+  code_guidelines:
+    enabled: true
+    filePatterns:
+      - "CLAUDE.md"
+      - "AGENTS.md"

strapi_kit-0.0.1/.env.example

@@ -0,0 +1,37 @@
+# Strapi Configuration Example
+# Copy this file to .env and fill in your values
+
+# Required: Strapi instance URL
+STRAPI_BASE_URL=http://localhost:1337
+
+# Required: API authentication token
+# Get this from Strapi Admin Panel → Settings → API Tokens
+STRAPI_API_TOKEN=your-api-token-here
+
+# Optional: API version (v4, v5, or auto-detect)
+# STRAPI_API_VERSION=auto
+
+# Optional: Request timeout in seconds (default: 30.0)
+# STRAPI_TIMEOUT=30.0
+
+# Optional: Maximum concurrent connections (default: 10)
+# STRAPI_MAX_CONNECTIONS=10
+
+# Optional: Verify SSL certificates (default: true)
+# STRAPI_VERIFY_SSL=true
+
+# Optional: Rate limit per second (default: None/unlimited)
+# STRAPI_RATE_LIMIT_PER_SECOND=10.0
+
+# Retry Configuration
+# Optional: Maximum retry attempts (default: 3, range: 1-10)
+# STRAPI_RETRY_MAX_ATTEMPTS=3
+
+# Optional: Initial wait time before first retry in seconds (default: 1.0)
+# STRAPI_RETRY_INITIAL_WAIT=1.0
+
+# Optional: Maximum wait time between retries in seconds (default: 60.0)
+# STRAPI_RETRY_MAX_WAIT=60.0
+
+# Optional: Exponential backoff multiplier (default: 2.0)
+# STRAPI_RETRY_EXPONENTIAL_BASE=2.0

strapi_kit-0.0.1/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    target-branch: "dev"
+    allow:
+      - dependency-type: "all"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    target-branch: "dev"

strapi_kit-0.0.1/.github/pull_request_template.md

@@ -0,0 +1,63 @@
+## Description
+
+<!-- Provide a brief description of the changes in this PR -->
+
+## Type of Change
+
+<!-- Mark the relevant option with an "x" -->
+
+- [ ] 🐛 Bug fix (non-breaking change that fixes an issue)
+- [ ] ✨ New feature (non-breaking change that adds functionality)
+- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] 📝 Documentation update
+- [ ] 🔧 Configuration change
+- [ ] ♻️ Code refactoring
+- [ ] ✅ Test update
+- [ ] 🎨 Style/formatting change
+
+## Changes Made
+
+<!-- List the main changes made in this PR -->
+
+-
+-
+-
+
+## Testing
+
+<!-- Describe how you tested these changes -->
+
+- [ ] Added new tests
+- [ ] Updated existing tests
+- [ ] All tests pass locally
+- [ ] Tested both sync and async variants (if applicable)
+
+## Checklist
+
+<!-- Mark completed items with an "x" -->
+
+- [ ] My code follows the project's style guidelines
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] I have run `make pre-commit` successfully
+- [ ] Type checking passes (`mypy src/strapi_kit/`)
+- [ ] Linting passes (`ruff check src/ tests/`)
+
+## Related Issues
+
+<!-- Link related issues here -->
+
+Closes #
+Related to #
+
+## Additional Notes
+
+<!-- Any additional information or context -->
+
+---
+
+**Note:** This PR will be automatically reviewed by CodeRabbit AI. Please address any concerns raised before requesting human review.

strapi_kit-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,106 @@
+name: Test-Matrix
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python:
+          - "3.12"
+          - "3.13"
+          - "3.14"
+
+    steps:
+      - name: 🛎️  Checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: 🐍  Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: ⚡  Install uv (with cache)
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: ▶️  Run Tests
+        env:
+          CI: "true"
+        run: |
+          # Install project with dev dependencies
+          uv pip install --system -e ".[dev]"
+
+          # Run tests
+          echo "Running tests for Python ${{ matrix.python }}"
+          pytest -v
+
+      - name: 🔍 Quality Gates
+        if: matrix.python == '3.13'
+        run: |
+          # Run linting
+          ruff check src/ tests/
+
+          # Run type checking
+          mypy src/strapi_kit/
+
+          # Run security checks
+          bandit -c pyproject.toml -r src/
+
+  # Coverage job - run all tests in one job for simplicity
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🛎️  Checkout
+        uses: actions/checkout@v6
+
+      - name: 🐍  Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: ⚡  Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: 📊 Run all tests with coverage
+        run: |
+          # Install project with dev dependencies
+          uv pip install --system -e ".[dev]"
+
+          # Run tests with coverage
+          pytest --cov=strapi_kit --cov-report=xml --cov-report=term -v
+
+      - name: 📈 Coverage upload
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
+          flags: unittests
+          fail_ci_if_error: false
+
+  test-matrix-expected:
+    name: Test-MatrixExpected
+    runs-on: ubuntu-latest
+    needs: [tests, coverage]
+    if: ${{ always() }}
+    steps:
+      - name: ✅ Verify matrix results
+        run: |
+          if [[ "${{ needs.tests.result }}" != "success" || "${{ needs.coverage.result }}" != "success" ]]; then
+            echo "Upstream checks failed"
+            exit 1
+          fi
+          echo "All required checks passed"

strapi_kit-0.0.1/.github/workflows/dev-release.yml

@@ -0,0 +1,147 @@
+name: Dev Release
+
+on:
+  push:
+    branches:
+      - dev
+  workflow_dispatch:  # Allow manual triggering
+
+permissions:
+  id-token: write              # OIDC → Trusted Publishing
+  contents: read               # Read repository contents
+  pull-requests: read          # Read PR labels for version calculation
+
+jobs:
+  dev-release:
+    runs-on: ubuntu-latest
+    environment: testpypi
+    env:
+      PYTHON_VERSION: "3.12"
+
+    steps:
+      - name: 🛎️  Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0  # Needed for version calculation
+          fetch-tags: true
+
+      - name: 🐍  Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: ⚡  Install uv (with cache)
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: 📦  Install build tools
+        run: |
+          uv pip install --system build hatch
+
+      - name: 🔍  Check for PR with release labels
+        id: pr_labels
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          # Find open PR from dev to main
+          PR_JSON=$(gh pr list --head dev --base main --state open --json number,labels --limit 1)
+
+          if [ "$PR_JSON" = "[]" ]; then
+            echo "No open PR from dev to main found"
+            echo "RELEASE_TYPE=minor" >> $GITHUB_OUTPUT
+          else
+            PR_NUMBER=$(echo "$PR_JSON" | jq -r '.[0].number')
+            LABELS=$(echo "$PR_JSON" | jq -r '.[0].labels[].name' 2>/dev/null || echo "")
+
+            echo "Found PR #$PR_NUMBER with labels: $LABELS"
+
+            if echo "$LABELS" | grep -q "release:major"; then
+              echo "RELEASE_TYPE=major" >> $GITHUB_OUTPUT
+              echo "🏷️ Release type: MAJOR"
+            elif echo "$LABELS" | grep -q "release:minor"; then
+              echo "RELEASE_TYPE=minor" >> $GITHUB_OUTPUT
+              echo "🏷️ Release type: MINOR"
+            elif echo "$LABELS" | grep -q "release:patch"; then
+              echo "RELEASE_TYPE=patch" >> $GITHUB_OUTPUT
+              echo "🏷️ Release type: PATCH"
+            else
+              echo "RELEASE_TYPE=minor" >> $GITHUB_OUTPUT
+              echo "🏷️ Release type: minor (default)"
+            fi
+          fi
+
+      - name: 🏷️  Calculate dev version
+        id: version
+        run: |
+          # Get the latest tag
+          LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0")
+          CURRENT_VERSION=${LATEST_TAG#v}
+
+          # Parse version components
+          IFS='.' read -r MAJOR MINOR PATCH <<< "$CURRENT_VERSION"
+
+          # Create dev version with commit count since last tag
+          COMMIT_COUNT=$(git rev-list --count ${LATEST_TAG}..HEAD 2>/dev/null || echo "1")
+
+          # Calculate version based on release type from PR labels
+          RELEASE_TYPE="${{ steps.pr_labels.outputs.RELEASE_TYPE }}"
+
+          if [ "$RELEASE_TYPE" = "major" ]; then
+            DEV_VERSION="$((MAJOR + 1)).0.0.dev${COMMIT_COUNT}"
+          elif [ "$RELEASE_TYPE" = "patch" ]; then
+            DEV_VERSION="${MAJOR}.${MINOR}.$((PATCH + 1)).dev${COMMIT_COUNT}"
+          else
+            # Default to minor
+            DEV_VERSION="${MAJOR}.$((MINOR + 1)).0.dev${COMMIT_COUNT}"
+          fi
+
+          DEV_TAG="v${DEV_VERSION}"
+
+          echo "DEV_VERSION=$DEV_VERSION" >> $GITHUB_OUTPUT
+          echo "DEV_TAG=$DEV_TAG" >> $GITHUB_OUTPUT
+          echo "📦 Dev version: $DEV_VERSION (based on $RELEASE_TYPE release)"
+
+          # Create a temporary tag for hatch-vcs
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          git tag -a "$DEV_TAG" -m "Dev release $DEV_TAG"
+
+      - name: 📦  Build wheel & sdist
+        run: |
+          echo "🏷️ Current git state:"
+          git describe --tags --always
+          echo "📦 Building package..."
+
+          python -m build --wheel --sdist
+
+          echo "📦 Build completed. Contents of dist/:"
+          ls -la dist/
+
+          # Verify the version in the built package
+          echo "📋 Checking built package version:"
+          if ls dist/*.tar.gz 1> /dev/null 2>&1; then
+            tar -tf dist/*.tar.gz | grep -E "(PKG-INFO|METADATA)" | head -1 | xargs tar -xOf dist/*.tar.gz | grep "^Version:" || echo "Version not found in metadata"
+          fi
+
+      - name: 🧪  Upload to Test PyPI
+        uses: pypa/gh-action-pypi-publish@v1.13.0
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          packages-dir: dist
+          skip-existing: true
+          verbose: true
+
+      - name: 📝  Create summary
+        run: |
+          echo "## 🧪 Dev Release Published" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "**Version:** \`${{ steps.version.outputs.DEV_VERSION }}\`" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "### Installation" >> $GITHUB_STEP_SUMMARY
+          echo "\`\`\`bash" >> $GITHUB_STEP_SUMMARY
+          echo "pip install -i https://test.pypi.org/simple/ strapi-kit==${{ steps.version.outputs.DEV_VERSION }}" >> $GITHUB_STEP_SUMMARY
+          echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "### Changes" >> $GITHUB_STEP_SUMMARY
+          echo "Published from commit: \`$(git rev-parse --short HEAD)\`" >> $GITHUB_STEP_SUMMARY

strapi_kit-0.0.1/.github/workflows/document.yml

@@ -0,0 +1,140 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+      - 'src/strapi_kit/**'
+      - 'README.md'
+      - 'pyproject.toml'
+      - 'mkdocs.yml'
+      - '.github/workflows/document.yml'
+  pull_request:
+    branches: [main]
+    paths:
+      - 'docs/**'
+      - 'src/strapi_kit/**'
+      - 'README.md'
+      - 'pyproject.toml'
+      - 'mkdocs.yml'
+      - '.github/workflows/document.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+env:
+  PYTHON_VERSION: "3.12"
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Cache uv dependencies
+        uses: actions/cache@v5
+        with:
+          path: |
+            ~/.cache/uv
+            ~/.local/share/uv
+          key: ${{ runner.os }}-docs-${{ hashFiles('**/pyproject.toml', 'uv.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-docs-
+
+      - name: Install dependencies
+        run: |
+          echo "🚀 Installing with uv"
+          uv --version
+
+          # Generate lock file if it doesn't exist (it's gitignored)
+          if [ ! -f "uv.lock" ]; then
+            echo "📦 Generating uv.lock file"
+            uv lock
+          fi
+
+          # Install project with docs dependencies
+          uv sync --extra docs
+
+          # Install git for version detection
+          echo "📦 Installing git and hatchling for versioning"
+          uv pip install hatchling hatch-vcs
+
+      - name: Get package version
+        id: version
+        run: |
+          echo "📦 Getting package version"
+          VERSION=$(uv run python -c "import strapi_kit; print(strapi_kit.__version__)")
+          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+          echo "Package version: $VERSION"
+
+      - name: Build documentation
+        run: |
+          echo "📚 Building documentation with version ${{ steps.version.outputs.VERSION }}"
+          PACKAGE_VERSION="${{ steps.version.outputs.VERSION }}" uv run mkdocs build --strict
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+
+      - name: Generate docs summary
+        run: |
+          echo "## 📚 Documentation Build" >> $GITHUB_STEP_SUMMARY
+          echo "| Item | Value |" >> $GITHUB_STEP_SUMMARY
+          echo "|------|-------|" >> $GITHUB_STEP_SUMMARY
+          echo "| **Tool** | uv |" >> $GITHUB_STEP_SUMMARY
+          echo "| **Event** | ${{ github.event_name }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| **Branch** | ${{ github.ref_name }} |" >> $GITHUB_STEP_SUMMARY
+
+          if [ -d "site" ]; then
+            site_size=$(du -sh site | cut -f1)
+            echo "| **Site Size** | $site_size |" >> $GITHUB_STEP_SUMMARY
+            echo "| **Status** | ✅ Built successfully |" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "| **Status** | ❌ Build failed |" >> $GITHUB_STEP_SUMMARY
+          fi
+
+  deploy-docs:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: build-docs
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+      - name: Generate deployment summary
+        run: |
+          echo "## 🚀 Documentation Deployed" >> $GITHUB_STEP_SUMMARY
+          echo "Documentation has been successfully deployed to GitHub Pages." >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "🔗 **[View Documentation](${{ steps.deployment.outputs.page_url }})**" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "### Quick Links" >> $GITHUB_STEP_SUMMARY
+          echo "- [Installation Guide](${{ steps.deployment.outputs.page_url }}installation/)" >> $GITHUB_STEP_SUMMARY
+          echo "- [Quickstart](${{ steps.deployment.outputs.page_url }}quickstart/)" >> $GITHUB_STEP_SUMMARY
+          echo "- [Configuration](${{ steps.deployment.outputs.page_url }}configuration/)" >> $GITHUB_STEP_SUMMARY

strapi_kit-0.0.1/.github/workflows/guard-main-origin.yml

@@ -0,0 +1,26 @@
+# .github/workflows/guard-main-origin.yml
+name: Guard-Main-Origin
+
+on:
+  pull_request:
+    branches: [main]            # PRs whose *target* is main only
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  ensure-valid-origin:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check if PR is from allowed branch
+        env:
+          BRANCH: ${{ github.head_ref }}
+        run: |
+          # Allow PRs from dev, hotfix, or updates branches
+          if [[ "$BRANCH" == "dev" ]] || [[ "$BRANCH" =~ ^hotfix-.* ]] || [[ "$BRANCH" =~ ^updates-.* ]]; then
+            echo "✅ Origin branch '$BRANCH' is allowed"
+          else
+            echo "::error::Main only accepts PRs from 'dev', 'hotfix-*', or 'updates-*' branches. Current branch: $BRANCH"
+            exit 1
+          fi