pdfdancer-client-python 0.3.13__tar.gz → 3.0.1__tar.gz

pdfdancer_client_python-3.0.1/.autosnap.toml

@@ -0,0 +1,10 @@
+check = "make check"
+idle_seconds = 60
+snapshot_mode = "both"
+commit_mode = "checkpoint"
+msg_source_cmd = 'gommit -A -n --diff-base "$AUTOSNAP_DIFF_BASE"'
+log_max_bytes = 1048576
+
+[watch]
+mode = "recursive"
+poll_interval = "5s"

pdfdancer_client_python-3.0.1/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly

{pdfdancer_client_python-0.3.13 → pdfdancer_client_python-3.0.1}/.github/workflows/ci.yml

@@ -9,8 +9,8 @@ on:
 
 jobs:
   test:
-    # Quick minimal test on non-main branches
-    if: github.ref != 'refs/heads/main'
+    # Run the minimal matrix for automatic non-main events.
+    if: github.event_name != 'workflow_dispatch' && github.ref != 'refs/heads/main'
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -23,15 +23,15 @@ jobs:
         python-version: [ '3.12' ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
         with:
           submodules: true
 
       - name: Resolve API base URL
         id: resolve-api-base-url
-        uses: actions/github-script@v7
+        uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
         with:
-          github-token: ${{ secrets.PROPAGATE_TOKEN }}
+          github-token: ${{ secrets.PROPAGATE_TOKEN || github.token }}
           script: |
             const fallbackUrl = 'https://api-staging.pdfdancer.com';
             const pr = context.payload.pull_request;
@@ -41,7 +41,7 @@ jobs:
             }
 
             const body = pr.body || '';
-            const apiPrMatch = body.match(/## Source API PR[\s\S]*?^- Repository:\s*MenschMachine\/pdfdancer-api\s*$[\s\S]*?^- PR:\s*#?(\d+)\s*$/im);
+            const apiPrMatch = body.match(/## Source API PR[\s\S]*?^\s+- Repository:\s*MenschMachine\/pdfdancer-api\s*$[\s\S]*?^\s+- PR:\s*#?(\d+)\s*$/im);
             if (!apiPrMatch) {
               core.info('No Source API PR block found in the PR body; using staging API.');
               core.setOutput('base_url', fallbackUrl);
@@ -74,7 +74,7 @@ jobs:
             core.setOutput('base_url', urlMatch[1]);
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -92,9 +92,11 @@ jobs:
 
       - name: Run tests
         run: |
-          PDFDANCER_BASE_URL=${{ steps.resolve-api-base-url.outputs.base_url }} \
-          PDFDANCER_API_TOKEN=42 \
-          venv/bin/python -m pytest tests/ -v --maxfail=3
+          mkdir -p test-results
+          venv/bin/python -m pytest tests/ -v --maxfail=3 --junitxml=test-results/junit.xml
+        env:
+          PDFDANCER_BASE_URL: ${{ steps.resolve-api-base-url.outputs.base_url }}
+          PDFDANCER_API_TOKEN: 42
 
       - name: Build distribution packages
         run: venv/bin/python -m build
@@ -102,10 +104,21 @@ jobs:
       - name: Validate packages
         run: venv/bin/python -m twine check dist/*
 
+      - name: Upload test results
+        if: failure()
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: test-results-python-${{ matrix.python-version }}
+          path: |
+            test-results/
+            .pytest_cache/
+          if-no-files-found: ignore
+          retention-days: 7
+
 
   test-full-matrix:
-    # Full matrix only on main
-    if: github.ref == 'refs/heads/main'
+    # Run the full matrix on main and for every manual dispatch.
+    if: github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/main'
     runs-on: ${{ matrix.os }}
     permissions:
       contents: read
@@ -119,20 +132,12 @@ jobs:
         python-version: [ '3.10', '3.11', '3.12', '3.13' ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
         with:
           submodules: true
 
-      - name: Resolve API base URL
-        id: resolve-api-base-url
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.PROPAGATE_TOKEN }}
-          script: |
-            core.setOutput('base_url', 'https://api-staging.pdfdancer.com');
-
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -154,9 +159,11 @@ jobs:
       - name: Run tests (Unix)
         if: runner.os != 'Windows'
         run: |
-          PDFDANCER_BASE_URL=${{ steps.resolve-api-base-url.outputs.base_url }} \
-          PDFDANCER_API_TOKEN=42 \
-          venv/bin/python -m pytest tests/ -v --maxfail=3
+          mkdir -p test-results
+          venv/bin/python -m pytest tests/ -v --maxfail=3 --junitxml=test-results/junit.xml
+        env:
+          PDFDANCER_BASE_URL: https://api-staging.pdfdancer.com
+          PDFDANCER_API_TOKEN: 42
 
       - name: Build & Validate (Unix)
         if: runner.os != 'Windows'
@@ -185,9 +192,11 @@ jobs:
         if: runner.os == 'Windows'
         shell: cmd
         run: |
-          set PDFDANCER_BASE_URL=${{ steps.resolve-api-base-url.outputs.base_url }}
-          set PDFDANCER_API_TOKEN=42
-          venv\Scripts\python -m pytest tests/ -v --maxfail=3
+          if not exist test-results mkdir test-results
+          venv\Scripts\python -m pytest tests/ -v --maxfail=3 --junitxml=test-results/junit.xml
+        env:
+          PDFDANCER_BASE_URL: https://api-staging.pdfdancer.com
+          PDFDANCER_API_TOKEN: 42
 
       - name: Build & Validate (Windows)
         if: runner.os == 'Windows'
@@ -195,3 +204,14 @@ jobs:
         run: |
           venv\Scripts\python -m build
           venv\Scripts\python -m twine check dist/*
+
+      - name: Upload test results
+        if: failure()
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: test-results-${{ matrix.os }}-python-${{ matrix.python-version }}
+          path: |
+            test-results/
+            .pytest_cache/
+          if-no-files-found: ignore
+          retention-days: 7

{pdfdancer_client_python-0.3.13 → pdfdancer_client_python-3.0.1}/.github/workflows/daily-tests.yml

@@ -2,12 +2,14 @@ name: Daily Tests
 
 on:
   schedule:
-    # Run daily at 9:00 PM UTC
+    # Run daily at 10:40 UTC
     - cron: '40 10 * * *'
   workflow_dispatch: # Allow manual triggering
 
 jobs:
   daily-test:
+    permissions:
+      contents: read
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -17,12 +19,12 @@ jobs:
         python-version: [ '3.10', '3.11', '3.12', '3.13' ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
         with:
           submodules: true
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -44,9 +46,11 @@ jobs:
       - name: Run tests (Unix)
         if: runner.os != 'Windows'
         run: |
-          PDFDANCER_BASE_URL=https://api-staging.pdfdancer.com \
-          PDFDANCER_TOKEN=42 \
-          venv/bin/python -m pytest tests/ -v --maxfail=3
+          mkdir -p test-results
+          venv/bin/python -m pytest tests/ -v --maxfail=3 --junitxml=test-results/junit.xml
+        env:
+          PDFDANCER_BASE_URL: https://api-staging.pdfdancer.com
+          PDFDANCER_API_TOKEN: 42
 
       - name: Build & Validate (Unix)
         if: runner.os != 'Windows'
@@ -75,9 +79,11 @@ jobs:
         if: runner.os == 'Windows'
         shell: cmd
         run: |
-          set PDFDANCER_BASE_URL=https://api-staging.pdfdancer.com
-          set PDFDANCER_TOKEN=42
-          venv\Scripts\python -m pytest tests/ -v --maxfail=3
+          if not exist test-results mkdir test-results
+          venv\Scripts\python -m pytest tests/ -v --maxfail=3 --junitxml=test-results/junit.xml
+        env:
+          PDFDANCER_BASE_URL: https://api-staging.pdfdancer.com
+          PDFDANCER_API_TOKEN: 42
 
       - name: Build & Validate (Windows)
         if: runner.os == 'Windows'
@@ -86,34 +92,27 @@ jobs:
           venv\Scripts\python -m build
           venv\Scripts\python -m twine check dist/*
 
-  notify-on-failure:
+      - name: Upload test results
+        if: failure()
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: test-results-${{ matrix.os }}-python-${{ matrix.python-version }}
+          path: |
+            test-results/
+            .pytest_cache/
+          if-no-files-found: ignore
+          retention-days: 7
+
+  notify:
     needs: daily-test
     runs-on: ubuntu-latest
-    if: failure()
+    if: always() && needs.daily-test.result == 'failure'
+    permissions:
+      contents: read
     steps:
-      - name: Create issue on failure
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const title = `Daily Tests Failed - ${new Date().toISOString().split('T')[0]}`;
-            const body = `The daily test run has failed. Please check the workflow run for details.\n\n[Workflow Run](${context.payload.repository.html_url}/actions/runs/${context.runId})`;
-
-            // Check if an issue already exists
-            const issues = await github.rest.issues.listForRepo({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              state: 'open',
-              labels: 'daily-test-failure'
-            });
-
-            const existingIssue = issues.data.find(issue => issue.title === title);
-
-            if (!existingIssue) {
-              await github.rest.issues.create({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                title: title,
-                body: body,
-                labels: ['daily-test-failure', 'automated']
-              });
-            }
+      - name: Summarize failure
+        run: |
+          echo "## Daily Tests Failed" >> "$GITHUB_STEP_SUMMARY"
+          echo "" >> "$GITHUB_STEP_SUMMARY"
+          echo "Python SDK daily tests failed on $(date -u +%F)." >> "$GITHUB_STEP_SUMMARY"
+          echo "[Open workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})" >> "$GITHUB_STEP_SUMMARY"

pdfdancer_client_python-3.0.1/.github/workflows/release.yml

@@ -0,0 +1,56 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          fetch-depth: 0
+          submodules: true
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
+        with:
+          python-version: '3.12'
+
+      - name: Pin package version from tag
+        run: echo "SETUPTOOLS_SCM_PRETEND_VERSION=${GITHUB_REF_NAME#v}" >> "$GITHUB_ENV"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+
+      - name: Lint
+        run: python -m flake8 src/
+
+      - name: Tests
+        run: python -m pytest tests/ -v --maxfail=1 --ignore=tests/e2e/test_pdfdancer.py
+        env:
+          PDFDANCER_BASE_URL: https://api.pdfdancer.com
+          PDFDANCER_API_TOKEN: ${{ secrets.PDFDANCER_API_TOKEN_PRODUCTION }}
+
+      - name: Build package
+        run: python -m build
+
+      - name: Validate packages
+        run: python -m twine check dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # release/v1
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@3bb12739c298aeb8a4eeaf626c5b8d85266b0e65 # v2
+        with:
+          generate_release_notes: true
+          files: dist/*

{pdfdancer_client_python-0.3.13 → pdfdancer_client_python-3.0.1}/.github/workflows/sdk-backward-compat.yml

@@ -11,11 +11,14 @@ on:
         required: true
         type: string
       sdk_token:
-        description: 'API token for testing'
+        description: 'Non-secret test token; never enter production credentials'
         required: true
         type: string
         default: '42'
 
+permissions:
+  contents: read
+
 jobs:
   get-tags:
     runs-on: ubuntu-latest
@@ -47,14 +50,15 @@ jobs:
 
     steps:
       - name: Checkout SDK at ${{ matrix.tag }}
-        uses: actions/checkout@v4
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
         with:
           repository: MenschMachine/pdfdancer-client-python
           ref: ${{ matrix.tag }}
           path: sdk
+          submodules: true
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
         with:
           python-version: '3.12'
 
@@ -69,20 +73,20 @@ jobs:
       - name: Run e2e tests
         working-directory: sdk
         run: |
-          PDFDANCER_BASE_URL=${{ github.event.client_payload.api_url || inputs.api_url }} \
-          PDFDANCER_API_TOKEN=${{ github.event.client_payload.sdk_token || inputs.sdk_token }} \
           ../venv/bin/python -m pytest -v -x \
             -k "not test_redact_multiple_paths and not test_context_manager_vs_manual_apply" \
             --junitxml=test-results.xml
         env:
-          PYTHONWARNINGS: "ignore:Unverified HTTPS request"
+          PDFDANCER_BASE_URL: ${{ github.event.client_payload.api_url || inputs.api_url }}
+          PDFDANCER_API_TOKEN: ${{ github.event.client_payload.sdk_token || inputs.sdk_token }}
 
       - name: Upload test results
         if: failure()
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
           name: test-results-${{ matrix.tag }}
           path: |
             sdk/test-results.xml
             sdk/.pytest_cache/
-          retention-days: 7
+          if-no-files-found: ignore
+          retention-days: 7

{pdfdancer_client_python-0.3.13 → pdfdancer_client_python-3.0.1}/.gitignore

@@ -21,3 +21,6 @@ __pycache__/
 .env
 .propagate*md
 /.last-message.txt
+
+# Auto-generated by setuptools_scm
+src/pdfdancer/_version.py

pdfdancer_client_python-3.0.1/MANIFEST.in

@@ -0,0 +1 @@
+prune tests

pdfdancer_client_python-3.0.1/Makefile

@@ -0,0 +1,80 @@
+BASE_PYTHON ?= python
+VENV ?= venv
+TEST_PATH ?= tests
+PYTEST_ARGS ?= -v
+
+ifeq ($(OS),Windows_NT)
+VENV_PYTHON := $(VENV)/Scripts/python.exe
+else
+VENV_PYTHON := $(VENV)/bin/python
+endif
+
+PYTHON ?= $(VENV_PYTHON)
+
+CODE_DIRS := src tests
+FIXTURE_DIR := tests/fixtures
+UNIT_TEST_ARGS := --ignore=tests/e2e
+
+.DEFAULT_GOAL := help
+
+.PHONY: help venv install install-dev format format-check lint typecheck quality \
+	test test-unit test-e2e coverage check build check-dist package clean
+
+help: ## Show available targets and configurable variables
+	@awk 'BEGIN {FS = ":.*## "; printf "Usage: make <target> [BASE_PYTHON=python] [VENV=venv] [PYTHON=<venv-python>] [TEST_PATH=tests] [PYTEST_ARGS=\"-v\"]\n\nTargets:\n"} /^[a-zA-Z0-9_-]+:.*## / {printf "  %-14s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+venv: $(VENV_PYTHON) ## Create the project virtual environment
+
+$(VENV_PYTHON):
+	$(BASE_PYTHON) -m venv $(VENV)
+	$(VENV_PYTHON) -m pip install --upgrade pip
+
+install: venv ## Install the package in editable mode
+	$(PYTHON) -m pip install -e .
+
+install-dev: venv ## Install the package and development dependencies in editable mode
+	$(PYTHON) -m pip install -e ".[dev]"
+
+format: ## Format source code and tests with Black and isort
+	$(PYTHON) -m black --extend-exclude '(^|/)tests/fixtures/' $(CODE_DIRS)
+	$(PYTHON) -m isort --skip $(FIXTURE_DIR) $(CODE_DIRS)
+
+format-check: ## Check formatting without changing files
+	$(PYTHON) -m black --check --extend-exclude '(^|/)tests/fixtures/' $(CODE_DIRS)
+	$(PYTHON) -m isort --check-only --skip $(FIXTURE_DIR) $(CODE_DIRS)
+
+lint: ## Lint source code and tests with Flake8
+	$(PYTHON) -m flake8 --exclude=$(FIXTURE_DIR) $(CODE_DIRS)
+
+typecheck: ## Type-check the package with mypy
+	$(PYTHON) -m mypy src
+
+quality: format-check lint typecheck ## Run all non-mutating code-quality checks
+
+test: ## Run all tests; override TEST_PATH or PYTEST_ARGS as needed
+	$(PYTHON) -m pytest $(TEST_PATH) $(PYTEST_ARGS)
+
+test-unit: ## Run tests that do not require the PDFDancer API
+	$(PYTHON) -m pytest tests $(UNIT_TEST_ARGS) $(PYTEST_ARGS)
+
+test-e2e: ## Run API-dependent end-to-end tests
+	$(PYTHON) -m pytest tests/e2e $(PYTEST_ARGS)
+
+coverage: ## Run all tests and report package coverage
+	$(PYTHON) -m pytest $(TEST_PATH) $(PYTEST_ARGS) --cov=pdfdancer --cov-report=term-missing
+
+check: quality test-unit ## Run the local pre-commit checks
+
+build: ## Build the wheel and source distribution
+	$(PYTHON) -m build
+
+check-dist: ## Validate existing distribution artifacts with Twine
+	$(PYTHON) -m twine check dist/*
+
+package: clean ## Clean, build, and validate distribution artifacts
+	$(MAKE) build
+	$(MAKE) check-dist
+
+clean: ## Remove generated build, test, coverage, and Python cache artifacts
+	$(RM) -r build dist .pytest_cache .mypy_cache .coverage htmlcov src/*.egg-info
+	find src tests -type d -name __pycache__ -prune -exec $(RM) -r {} +