PDFCLOUD-5351 Initial Python API for pdfRest

.editorconfig

@@ -0,0 +1,28 @@
+root = true
+
+
+[*]
+charset = utf-8
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+indent_size = 2
+max_line_length = 80
+
+[{*.py,*.ipynb}]
+indent_size = 4
+max_line_length = 88
+
+[*.sh]
+# like -i=4
+indent_style = space
+indent_size = 4
+
+shell_variant      = bash # --language-variant
+binary_next_line   = true
+switch_case_indent = true  # --case-indent
+space_redirects    = true
+keep_padding       = false
+function_next_line = true  # --func-next-line

.editorconfig-checker.json

@@ -0,0 +1,19 @@
+{
+  "Version": "v3.4.0",
+  "Verbose": false,
+  "Debug": false,
+  "IgnoreDefaults": false,
+  "SpacesAfterTabs": false,
+  "NoColor": false,
+  "Exclude": ["^\\.idea/", "\\.md$", "\\.py$", "\\.ipynb$"],
+  "AllowedContentTypes": [],
+  "PassedFiles": [],
+  "Disable": {
+    "EndOfLine": false,
+    "Indentation": false,
+    "InsertFinalNewline": false,
+    "TrimTrailingWhitespace": false,
+    "IndentSize": true,
+    "MaxLineLength": false
+  }
+}

.gitattributes

@@ -0,0 +1,108 @@
+# Common settings that generally should always be used with your language specific settings
+
+# Auto detect text files and perform LF normalization
+# https://www.davidlaing.com/2012/09/19/customise-your-gitattributes-to-become-a-git-ninja/
+*          text=auto
+
+#
+# The above will handle all files NOT found below
+#
+
+# Documents
+*.bibtex   text diff=bibtex
+*.doc	        diff=astextplain
+*.DOC	        diff=astextplain
+*.docx          diff=astextplain
+*.DOCX          diff=astextplain
+*.dot           diff=astextplain
+*.DOT           diff=astextplain
+*.pdf           diff=astextplain
+*.PDF           diff=astextplain
+*.rtf           diff=astextplain
+*.RTF	        diff=astextplain
+*.md       text
+*.tex      text diff=tex
+*.adoc     text
+*.textile  text
+*.mustache text
+*.csv      text
+*.tab      text
+*.tsv      text
+*.txt      text
+*.sql      text
+
+# Graphics
+*.png      binary
+*.jpg      binary
+*.jpeg     binary
+*.gif      binary
+*.tif      binary
+*.tiff     binary
+*.ico      binary
+# SVG treated as an asset (binary) by default.
+*.svg      text
+# If you want to treat it as binary,
+# use the following line instead.
+# *.svg    binary
+*.eps      binary
+
+# Scripts
+*.bash     text eol=lf
+*.fish     text eol=lf
+*.sh       text eol=lf
+# These are explicitly windows files and should use crlf
+*.bat      text eol=crlf
+*.cmd      text eol=crlf
+*.ps1      text eol=crlf
+
+# Serialisation
+*.json     text
+*.toml     text
+*.xml      text
+*.yaml     text
+*.yml      text
+
+# Archives
+*.7z       binary
+*.gz       binary
+*.tar      binary
+*.tgz      binary
+*.zip      binary
+
+# Text files where line endings should be preserved
+*.patch    -text
+
+#
+# Exclude files from exporting
+#
+
+.gitattributes export-ignore
+.gitignore     export-ignore
+# Basic .gitattributes for a python repo.
+
+# Source files
+# ============
+*.pxd    text diff=python
+*.py     text diff=python
+*.py3    text diff=python
+*.pyw    text diff=python
+*.pyx    text diff=python
+*.pyz    text diff=python
+
+# Binary files
+# ============
+*.db     binary
+*.p      binary
+*.pkl    binary
+*.pickle binary
+*.pyc    binary
+*.pyd    binary
+*.pyo    binary
+
+# Jupyter notebook
+*.ipynb  text
+
+# Note: .db, .p, and .pkl files are associated
+# with the python modules ``pickle``, ``dbm.*``,
+# ``shelve``, ``marshal``, ``anydbm``, & ``bsddb``
+# (among others).

.github/workflows/pre-commit.yml

@@ -0,0 +1,48 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - develop
+      - feature-*
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+      packages: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: 0.8.22
+          python-version: 3.11
+          enable-cache: true
+          cache-suffix: pre-commit
+          cache-dependency-glob: uv.lock
+      - name: Restore venv cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            .venv
+          key: ${{ runner.os }}-uv-${{ hashFiles('uv.lock') }}
+      - name: Restore mypy cache
+        uses: actions/cache@v4
+        with:
+          path: .mypy_cache
+          key: mypy_cache|${{ hashFiles('pyproject.toml') }}
+      - name: Restore pre-commit cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-4|${{ hashFiles('.pre-commit-config.yaml') }}
+      - name: Synchronize project dependencies
+        run: uv sync --group dev
+      - name: Run pre-commit checks
+        run: uv run pre-commit run --show-diff-on-failure --all-files --hook-stage manual

.github/workflows/test-and-publish.yml

@@ -0,0 +1,80 @@
+name: Test and Publish
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - develop
+      - feature-*
+  release:
+    types:
+      - published
+
+jobs:
+  tests:
+    name: Tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    permissions:
+      id-token: write
+      contents: read
+      packages: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: 0.8.22
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+          cache-suffix: test-and-publish
+          cache-dependency-glob: uv.lock
+      - name: Run tests with nox
+        run: uvx nox --python ${{ matrix.python-version }} --session tests -- --no-parallel
+        env:
+          PDFREST_API_KEY: ${{ secrets.PDFREST_API_KEY }}
+
+  publish:
+    name: Publish to CodeArtifact
+    needs: tests
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+      packages: write
+    env:
+      UV_PROJECT_ENVIRONMENT: .venv-release
+    steps:
+      - uses: actions/checkout@v4
+      - name: Assume AWS role for repository CI
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: arn:aws:iam::304774597385:role/cit-oidc-role-${{ github.event.repository.name }}-ci
+          aws-region: us-east-2
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: 0.8.22
+          enable-cache: true
+          cache-suffix: pre-commit
+          cache-dependency-glob: uv.lock
+      - name: Restore venv cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ${{ env.UV_PROJECT_ENVIRONMENT }}
+          key: ${{ runner.os }}-uv-release-${{ hashFiles('pyproject.toml') }}
+      - name: Install keyring
+        run: uv tool install keyring --with keyrings.codeartifact
+      - name: Synchronize project dependencies
+        run: uv sync --group dev
+      - name: Build distribution artifacts
+        run: uv build --python 3.11
+      - name: Publish package to CodeArtifact
+        run: uv publish --index cit-pypi