pdfdancer-client-python 0.3.10__tar.gz → 0.3.12__tar.gz

pdfdancer_client_python-0.3.12/.api-url

@@ -0,0 +1 @@
+http://46.225.120.69:8080

{pdfdancer_client_python-0.3.10 → pdfdancer_client_python-0.3.12}/.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: CI
 
 on:
   push:
-    branches: [ '**' ]
+    branches: [ 'main' ]
   pull_request:
     branches: [ '**' ]
   workflow_dispatch:
@@ -20,6 +20,19 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Detect API URL override
+        if: github.event_name == 'pull_request'
+        id: api-url
+        run: |
+          if [ -f .api-url ]; then
+            url=$(cat .api-url | tr -d '[:space:]')
+            if [ -n "$url" ]; then
+              echo "base_url=$url" >> "$GITHUB_OUTPUT"
+            fi
+          fi
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
@@ -40,7 +53,7 @@ jobs:
 
       - name: Run tests
         run: |
-          PDFDANCER_BASE_URL=https://api-staging.pdfdancer.com \
+          PDFDANCER_BASE_URL=${{ steps.api-url.outputs.base_url || 'https://api-staging.pdfdancer.com' }} \
           PDFDANCER_TOKEN=42 \
           venv/bin/python -m pytest tests/ -v --maxfail=3
 
@@ -64,6 +77,20 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Detect API URL override
+        if: github.event_name == 'pull_request'
+        id: api-url
+        shell: bash
+        run: |
+          if [ -f .api-url ]; then
+            url=$(cat .api-url | tr -d '[:space:]')
+            if [ -n "$url" ]; then
+              echo "base_url=$url" >> "$GITHUB_OUTPUT"
+            fi
+          fi
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
@@ -88,7 +115,7 @@ jobs:
       - name: Run tests (Unix)
         if: runner.os != 'Windows'
         run: |
-          PDFDANCER_BASE_URL=https://api-staging.pdfdancer.com \
+          PDFDANCER_BASE_URL=${{ steps.api-url.outputs.base_url || 'https://api-staging.pdfdancer.com' }} \
           PDFDANCER_TOKEN=42 \
           venv/bin/python -m pytest tests/ -v --maxfail=3
 
@@ -119,7 +146,7 @@ jobs:
         if: runner.os == 'Windows'
         shell: cmd
         run: |
-          set PDFDANCER_BASE_URL=https://api-staging.pdfdancer.com
+          set PDFDANCER_BASE_URL=${{ steps.api-url.outputs.base_url || 'https://api-staging.pdfdancer.com' }}
           set PDFDANCER_TOKEN=42
           venv\Scripts\python -m pytest tests/ -v --maxfail=3
 

{pdfdancer_client_python-0.3.10 → pdfdancer_client_python-0.3.12}/.github/workflows/daily-tests.yml

@@ -18,6 +18,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5

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

@@ -0,0 +1,84 @@
+name: Release to PyPI
+
+on:
+  push:
+    tags: ['v*']
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Create virtual environment
+        run: python -m venv venv
+
+      - name: Install dependencies
+        run: |
+          venv/bin/pip install --upgrade pip
+          venv/bin/pip install -e ".[dev]"
+
+      - name: Run linter
+        run: venv/bin/python -m flake8 src/
+
+      - name: Run tests
+        run: venv/bin/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 }}
+
+  publish:
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Verify tag matches package version
+        run: |
+          TAG_VERSION="${GITHUB_REF_NAME#v}"
+          PKG_VERSION=$(python -c "import re; print(re.search(r'version\s*=\s*\"([^\"]+)\"', open('pyproject.toml').read()).group(1))")
+          if [ "$TAG_VERSION" != "$PKG_VERSION" ]; then
+            echo "Tag version ($TAG_VERSION) does not match pyproject.toml version ($PKG_VERSION)"
+            exit 1
+          fi
+          echo "Version verified: $TAG_VERSION"
+
+      - name: Install build dependencies
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Create GitHub Release
+        run: gh release create "$GITHUB_REF_NAME" --generate-notes
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{pdfdancer_client_python-0.3.10 → pdfdancer_client_python-0.3.12}/.gitignore

@@ -19,3 +19,5 @@ __pycache__/
 /.run/
 /build
 .env
+.propagate*md
+/.last-message.txt

pdfdancer_client_python-0.3.12/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "tests/fixtures/examples"]
+	path = tests/fixtures/examples
+	url = https://github.com/MenschMachine/pdfdancer-examples.git

{pdfdancer_client_python-0.3.10 → pdfdancer_client_python-0.3.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pdfdancer-client-python
-Version: 0.3.10
+Version: 0.3.12
 Summary: Python client for PDFDancer API
 Author-email: "The Famous Cat Ltd." <hi@thefamouscat.com>
 License: 
@@ -210,7 +210,7 @@ Project-URL: Homepage, https://www.pdfdancer.com/
 Project-URL: Documentation, https://www.pdfdancer.com/
 Project-URL: Source, https://github.com/MenschMachine/pdfdancer-client-python
 Project-URL: Issues, https://github.com/MenschMachine/pdfdancer-client-python/issues
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3.10
@@ -359,7 +359,7 @@ with PDFDancer.open("contract.pdf") as pdf:
 ```
 
 Selectors return typed objects (`ParagraphObject`, `TextLineObject`, `ImageObject`, `FormFieldObject`, `PageClient`, …)
-with helpers such as `delete()`, `move_to(x, y)`, `redact()`, or `edit()` depending on the object type.
+with helpers such as `delete()`, `move_to(x, y)`, `clear_clipping()`, `redact()`, or `edit()` depending on the object type.
 
 **Singular selection methods** return the first match (or `None`) for convenience:
 
@@ -571,15 +571,16 @@ Artifacts will be created in the `dist/` directory.
 
 #### Publishing to PyPI
 
-```bash
-# Test upload to TestPyPI (recommended first)
-python -m twine upload --repository testpypi dist/*
+Releases are published automatically to PyPI when a `v*` tag is pushed to GitHub (via GitHub Actions with Trusted Publishers).
 
-# Upload to PyPI
-python -m twine upload dist/*
+```bash
+# Set version, commit, and push tag — GitHub Actions handles the rest
+python release.py tag --version 1.1.0
 
-# Or use the release script
-python release.py
+# Or manually:
+# 1. Update version in pyproject.toml and src/pdfdancer/__init__.py
+# 2. Commit
+# 3. git tag v1.1.0 && git push origin HEAD && git push origin v1.1.0
 ```
 
 #### Code Quality

{pdfdancer_client_python-0.3.10 → pdfdancer_client_python-0.3.12}/README.md

@@ -120,7 +120,7 @@ with PDFDancer.open("contract.pdf") as pdf:
 ```
 
 Selectors return typed objects (`ParagraphObject`, `TextLineObject`, `ImageObject`, `FormFieldObject`, `PageClient`, …)
-with helpers such as `delete()`, `move_to(x, y)`, `redact()`, or `edit()` depending on the object type.
+with helpers such as `delete()`, `move_to(x, y)`, `clear_clipping()`, `redact()`, or `edit()` depending on the object type.
 
 **Singular selection methods** return the first match (or `None`) for convenience:
 
@@ -332,15 +332,16 @@ Artifacts will be created in the `dist/` directory.
 
 #### Publishing to PyPI
 
-```bash
-# Test upload to TestPyPI (recommended first)
-python -m twine upload --repository testpypi dist/*
+Releases are published automatically to PyPI when a `v*` tag is pushed to GitHub (via GitHub Actions with Trusted Publishers).
 
-# Upload to PyPI
-python -m twine upload dist/*
+```bash
+# Set version, commit, and push tag — GitHub Actions handles the rest
+python release.py tag --version 1.1.0
 
-# Or use the release script
-python release.py
+# Or manually:
+# 1. Update version in pyproject.toml and src/pdfdancer/__init__.py
+# 2. Commit
+# 3. git tag v1.1.0 && git push origin HEAD && git push origin v1.1.0
 ```
 
 #### Code Quality

pdfdancer_client_python-0.3.12/docs/capabilities/CLEAR_CLIPPING.md

@@ -0,0 +1,61 @@
+# Clear Clipping Capability
+
+Most of the PDF model classes including container classes like PDFParagraph/PDFTextLine/PDFPathGroup now implement ClippingDetachable with the method clearClipping().
+This removes any clipping path which was active for this element.
+
+This is useful in case clients want to move an element but the new position is hidden by the clipping path. clearing it makes the element visible again.
+
+The new backend is version 1.8.6-rc2, available in the local m2 repository
+
+## Test PDFs to use
+
+examples/clipping/invisible-content-clipping-test.pdf
+
+- A PDF where content is present but not visible due to clipping paths that exclude the content areas. Contains an image clipped away by one clipping path and vector paths clipped away by another clipping path.
+
+
+## Api Docs
+
+Explain for all elements and under the clipping-section.
+
+## Website and Marketing
+
+Not to mention there.
+
+## What's new Newsletter
+
+include
+
+## Changelog
+
+include
+
+## Implementation in pdfdancer-api
+
+- Updated backend dependency to `com.tfc.pdf:pdfdancer-backend:1.8.6-rc2` in `build.gradle.kts` to use the clipping-detach support.
+- Added client-facing helpers:
+  - `BaseReference.clearClipping()` for any object reference implementing clipping detach semantics via the API.
+  - `PathGroupReference.clearClipping()` for grouped vector paths.
+  - `PDFDancer.clearClipping(ObjectRef)` calling `PUT /pdf/clipping/clear`.
+  - `PDFDancer.clearPathGroupClipping(pageIndex, groupId)` calling `PUT /pdf/path-group/clipping/clear`.
+  - Both client calls invalidate local snapshot caches after mutation.
+- Added server endpoints in both controllers:
+  - `PDFController` and `PDFControllerV1` expose `PUT /pdf/clipping/clear` and `PUT /pdf/path-group/clipping/clear`.
+  - V1 uses `ClearClippingRequestV1` and `ClearPathGroupClippingRequestV1`, converting both to internal requests via `toInternal()`.
+- Added controller orchestration in `ControllerOps`:
+  - `clearClipping(...)` validates `objectRef`, executes `ClearObjectClippingCommand`, and publishes `PDF_OBJECT_MODIFIED` metric with operation `clear_clipping`.
+  - `clearPathGroupClipping(...)` validates `groupId` and `pageIndex`, executes `ClearPathGroupClippingCommand`, and publishes `VECTOR_MANIPULATION` metric with operation `clear_path_group_clipping`.
+- Wired session and replay support:
+  - `Session.clearClipping(...)` and `Session.clearPathGroupClipping(...)` execute commands inside `SessionContext` and record commands for session history.
+  - `CommandDeserializer` now reconstructs `ClearObjectClippingCommand` and `ClearPathGroupClippingCommand` for debug archive replay.
+- Added tests and assertions:
+  - `ClippingTest` verifies clearing clipping on `PathReference`, `PathGroupReference`, and `TextLineReference`.
+  - `DirectPDFAssertions`/`PDFAssertions` gained helpers to detect clipped paths and assert clipping present/removed.
+
+## Implementation in pdfdancer-client-python
+
+- Added top-level client methods in `src/pdfdancer/pdfdancer_v1.py`: `PDFDancer.clear_clipping(object_ref)` calls `PUT /pdf/clipping/clear`, and `PDFDancer.clear_path_group_clipping(page_number, group_id)` calls `PUT /pdf/path-group/clipping/clear`.
+- The Python client validates required inputs before sending the request: `object_ref` must be present, `page_number` is a 1-based integer for path groups, and `group_id` must be non-empty. Both methods coerce the API response to `bool` and invalidate cached snapshots after a successful mutation.
+- Added object-level convenience methods in `src/pdfdancer/types.py`. `PDFObjectBase.clear_clipping()` makes the capability available on typed selections that expose `object_ref()` such as paths, images, and text lines, while `PathGroupObject.clear_clipping()` forwards to the path-group API using `self._page_index + 1` to convert the internal 0-based index to the public 1-based page number.
+- Updated `README.md` to list `clear_clipping()` alongside other typed-object helper methods so the feature is discoverable from the main usage guide.
+- Added end-to-end coverage in `tests/e2e/test_clipping.py` for direct object calls and top-level client calls on paths, grouped paths, images, and clipped text lines, including a case where clipping spans multiple content streams. `tests/e2e/pdf_assertions.py` was extended with PDF draw-event inspection helpers that assert whether clipping is present or removed.

{pdfdancer_client_python-0.3.10 → pdfdancer_client_python-0.3.12}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pdfdancer-client-python"
-version = "0.3.10"
+version = "0.3.12"
 description = "Python client for PDFDancer API"
 readme = "README.md"
 authors = [
@@ -12,7 +12,7 @@ authors = [
 ]
 license = { file = "LICENSE" }
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: Apache Software License",
     "Programming Language :: Python :: 3.10",

{pdfdancer_client_python-0.3.10 → pdfdancer_client_python-0.3.12}/release.py

@@ -20,10 +20,12 @@ class ReleaseError(Exception):
 
 
 class VersionBumper:
-    """Handles version bumping in pyproject.toml."""
+    """Handles version bumping in pyproject.toml and __init__.py."""
 
-    def __init__(self, pyproject_path: Path = Path("pyproject.toml")):
+    def __init__(self, pyproject_path: Path = Path("pyproject.toml"),
+                 init_path: Path = Path("src/pdfdancer/__init__.py")):
         self.pyproject_path = pyproject_path
+        self.init_path = init_path
         if not self.pyproject_path.exists():
             raise ReleaseError(f"pyproject.toml not found at {pyproject_path}")
 
@@ -36,7 +38,8 @@ class VersionBumper:
         return match.group(1)
 
     def set_version(self, new_version: str) -> None:
-        """Set a new version in pyproject.toml."""
+        """Set a new version in pyproject.toml and __init__.py."""
+        # Update pyproject.toml
         content = self.pyproject_path.read_text()
         new_content = re.sub(
             r'^version\s*=\s*"[^"]+"',
@@ -48,6 +51,18 @@ class VersionBumper:
             raise ReleaseError("Failed to update version in pyproject.toml")
         self.pyproject_path.write_text(new_content)
 
+        # Update __init__.py
+        if self.init_path.exists():
+            init_content = self.init_path.read_text()
+            new_init = re.sub(
+                r'^__version__\s*=\s*"[^"]+"',
+                f'__version__ = "{new_version}"',
+                init_content,
+                flags=re.MULTILINE
+            )
+            self.init_path.write_text(new_init)
+            print(f"Updated {self.init_path} to {new_version}")
+
     def bump_version(self, bump_type: str) -> str:
         """Bump version by type (major, minor, patch)."""
         current = self.get_current_version()
@@ -159,8 +174,8 @@ def main():
     parser = argparse.ArgumentParser(description="PDFDancer Python Client Release Tool")
     parser.add_argument(
         "action",
-        choices=["bump", "upload", "release"],
-        help="Action to perform: bump (version only), upload (build+upload), release (bump+test+build+upload)"
+        choices=["bump", "upload", "release", "tag"],
+        help="Action to perform: bump (version only), upload (build+upload), release (bump+test+build+upload), tag (set version + commit + push tag)"
     )
     parser.add_argument(
         "--bump-type",
@@ -230,6 +245,37 @@ def main():
 
             print(f"New version: {new_version}")
 
+        if args.action == "tag":
+            if not args.version:
+                raise ReleaseError("--version is required for the tag action")
+
+            new_version = args.version
+            current_version = version_bumper.get_current_version()
+            print(f"Current version: {current_version}")
+
+            if not args.dry_run:
+                version_bumper.set_version(new_version)
+                print(f"Version set to {new_version}")
+
+                # Commit the version bump
+                uploader.run_command(
+                    ["git", "add", "pyproject.toml", "src/pdfdancer/__init__.py"]
+                )
+                uploader.run_command(
+                    ["git", "commit", "-m", f"release: v{new_version}"]
+                )
+                print(f"Committed version bump")
+
+                # Create and push tag
+                tag_name = f"v{new_version}"
+                uploader.run_command(["git", "tag", tag_name])
+                uploader.run_command(["git", "push", "origin", "HEAD"])
+                uploader.run_command(["git", "push", "origin", tag_name])
+                print(f"Pushed tag {tag_name}")
+            else:
+                print(f"Would set version to {new_version}")
+                print(f"Would commit and push tag v{new_version}")
+
         if args.action in ["upload", "release"]:
             if args.action == "release" and not args.skip_tests:
                 if not args.dry_run:

{pdfdancer_client_python-0.3.10 → pdfdancer_client_python-0.3.12}/src/pdfdancer/__init__.py

@@ -12,6 +12,7 @@ from .exceptions import (
     PdfDancerException,
     RateLimitException,
     SessionException,
+    SessionNotFoundException,
     ValidationException,
 )
 from .models import (
@@ -34,6 +35,7 @@ from .models import (
     PageSize,
     Paragraph,
     Path,
+    PathGroupInfo,
     PathSegment,
     Point,
     Position,
@@ -47,12 +49,13 @@ from .models import (
     TextObjectRef,
     TextStatus,
 )
+from .types import PathGroupObject
 from .page_builder import PageBuilder
 from .paragraph_builder import ParagraphBuilder
 from .path_builder import BezierBuilder, LineBuilder, PathBuilder
 from .text_line_builder import TextLineBuilder
 
-__version__ = "1.0.0"
+__version__ = "0.3.12"
 __all__ = [
     "PDFDancer",
     "ParagraphBuilder",
@@ -89,6 +92,8 @@ __all__ = [
     "Line",
     "Bezier",
     "Path",
+    "PathGroupInfo",
+    "PathGroupObject",
     "RedactTarget",
     "RedactResponse",
     "ReflowPreset",
@@ -97,6 +102,7 @@ __all__ = [
     "ValidationException",
     "HttpClientException",
     "SessionException",
+    "SessionNotFoundException",
     "RateLimitException",
     "set_ssl_verify",
 ]

{pdfdancer_client_python-0.3.10 → pdfdancer_client_python-0.3.12}/src/pdfdancer/exceptions.py

@@ -55,6 +55,15 @@ class SessionException(PdfDancerException):
     pass
 
 
+class SessionNotFoundException(SessionException):
+    """
+    Exception raised when a session is not found (expired or invalid).
+    """
+
+    def __init__(self, message: str):
+        super().__init__(message)
+
+
 class ValidationException(PdfDancerException):
     """
     Exception raised for input validation errors.

{pdfdancer_client_python-0.3.10 → pdfdancer_client_python-0.3.12}/src/pdfdancer/models.py

@@ -1643,6 +1643,25 @@ class Size:
         return {"width": self.width, "height": self.height}
 
 
+@dataclass
+class PathGroupInfo:
+    group_id: str
+    path_count: int
+    bounding_box: Optional[Dict[str, Any]]
+    x: float
+    y: float
+
+    @staticmethod
+    def from_dict(d: Dict[str, Any]) -> "PathGroupInfo":
+        return PathGroupInfo(
+            group_id=d.get("groupId", ""),
+            path_count=d.get("pathCount", 0),
+            bounding_box=d.get("boundingBox"),
+            x=d.get("x", 0.0),
+            y=d.get("y", 0.0),
+        )
+
+
 class ImageTransformType(Enum):
     """Type of image transformation operation."""