pdfgate 0.0.2__tar.gz

pdfgate-0.0.2/.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: Deploy PDFGate Python SDK documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+  workflow_dispatch:
+    inputs:
+      logLevel:
+        description: 'Log level'
+        required: true
+        default: 'warning'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs mkdocs-material "mkdocstrings[python]"
+      - run: mkdocs gh-deploy --force

pdfgate-0.0.2/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,89 @@
+name: Publish package to PyPI
+
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - main
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+*"
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+      - name: Install hatch
+        run: >-
+          python3 -m
+          pip install
+          hatch
+          --user
+      - name: Build package
+        run: hatch build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-testpypi:
+    name: Publish distribution 📦 to TestPyPI
+    if: >-
+      ((github.event_name == 'workflow_dispatch') || (github.event_name == 'push')) &&
+      startsWith(github.ref, 'refs/tags/v') && endsWith(github.ref, '-beta')
+    needs:
+      - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/pdfgate-sdk-python
+
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-to-pypi:
+    name: Publish distribution 📦 to PyPI
+    if: >-
+      ((github.event_name == 'workflow_dispatch') || (github.event_name == 'push')) &&
+      startsWith(github.ref, 'refs/tags/v')
+    needs:
+      - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pdfgate-sdk-python
+
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pdfgate-0.0.2/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

pdfgate-0.0.2/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-merge-conflict
+    -   id: check-added-large-files
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.0
+    hooks:
+    -   id: ruff
+        args: [--fix]
+    -   id: ruff-format
+-   repo: local
+    hooks:
+    -   id: hatch-mypy
+        name: hatch mypy
+        language: system
+        entry: hatch run dev:check
+        types: [python]
+        pass_filenames: false  # Mypy usually works better on the whole project

pdfgate-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PDFGate
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pdfgate-0.0.2/PKG-INFO

@@ -0,0 +1,264 @@
+Metadata-Version: 2.4
+Name: pdfgate
+Version: 0.0.2
+Summary: PDFGate's official Python SDK
+Project-URL: Documentation, https://github.com/pdfgate/pdfgate-sdk-python#readme
+Project-URL: Issues, https://github.com/pdfgate/pdfgate-sdk-python/issues
+Project-URL: Source, https://github.com/pdfgate/pdfgate-sdk-python
+Author-email: Fernando Gasperi <fgasperijabalera@gmail.com>, Demetra Theodorou <demtra@pdfgate.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.9
+Requires-Dist: httpx
+Description-Content-Type: text/markdown
+
+# PDFGate's official Python SDK
+
+PDFGate lets you generate, process, and secure PDFs via a simple API:
+
+- HTML or URL to PDF
+- Fillable forms
+- Flatten, compress, watermark, protect PDFs
+- Extract PDF form data
+
+📘 Documentation: https://pdfgate.com/documentation<br>
+🔑 Dashboard & API keys: https://dashboard.pdfgate.com
+
+## pdfgate-sdk-python
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pdfgate-sdk-python.svg)](https://pypi.org/project/pdfgate-sdk-python)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pdfgate-sdk-python.svg)](https://pypi.org/project/pdfgate-sdk-python)
+
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick start](#quick-start)
+- [Sync & Async](#sync--async)
+- [Responses](#responses)
+- [Examples](#examples)
+- [Development](#development)
+- [Support](#support)
+- [License](#license)
+
+# Installation
+
+```sh
+pip install pdfgate
+```
+
+# Quick start
+
+```python
+import os
+
+from pdfgate import PDFGate, GeneratePDFParams
+
+
+client = PDFGate(api_key=os.getenv("PDFGATE_API_KEY"))
+params = GeneratePDFParams(url="https://example.com")
+pdf = client.generate_pdf(params)
+
+with open("output.pdf", "wb") as f:
+  f.write(pdf)
+```
+
+# Sync & Async
+
+There are sync and async versions of all methods, the only difference is that the method name has an `async` suffix:
+
+```python
+document_response = client.get_document(GetDocumentParams(document_id=document_id))
+
+# VS
+
+document_response = await client.get_document_async(GetDocumentParams(document_id=document_id))
+```
+
+Other than that, nothing changes and the interfaces are the same.
+
+# Responses
+
+The two response types for most endpoints are either the raw bytes of the
+PDF file or the documents metadata that you can use to query or download later:
+
+- file: this is represented by `bytes` and it can be saved directly into a file.
+- `PDFGateDocument`: this is a `TypedDict` that holds all the metadata of the file including its `id`,  and a `file_url` to download it if it was requested by specifying `pre_signed_url_expires_in` in the request.
+
+# Examples
+
+## Generate PDF
+
+```python
+params = GeneratePDFParams(html="<h1>Hello from PDFGate!</h1>")
+pdf = client.generate_pdf(params)
+
+with open("output.pdf", "wb") as f:
+  f.write(pdf)
+```
+
+## Get document metadata
+
+```python
+document_response = client.get_document(GetDocumentParams(document_id=document_id))
+
+assert document_response = {
+    "id" : "6642381c5c61"
+    "status" : DocumentStatus.COMPLETED
+    "type" : DocumentType.FROM_HTML,
+    "file_url" : "https://api.pdfgate.com/file/open/:preSignedUrlToken"
+    "size" : 1620006
+    "createdAt" : datetime(2024,02,13, 15, 56, 12, 607)"
+}
+```
+
+## Download a stored PDF file
+
+```python
+file_content = client.get_file(GetFileParams(document_id=document_id))
+
+with open("output.pdf", "wb") as f:
+  f.write(pdf)
+```
+
+## Flatten a PDF (make form-fields non-editable)
+
+```python
+flatten_pdf_params = FlattenPDFDocumentParams(
+    document_id=document_id, json_response=True
+)
+flattened_document = client.flatten_pdf(flatten_pdf_params)
+```
+
+## Compress a PDF
+
+```python
+compress_pdf_params = CompressPDFByDocumentIdParams(
+    document_id=document_id, json_response=True
+)
+response = client.compress_pdf(compress_pdf_params)
+```
+
+## Watermark a PDF
+
+```python
+watermark_pdf_params = WatermarkPDFByFileParams(
+    file=FileParam(name="input.pdf", data=pdf_file),
+    type=WatermarkType.IMAGE,
+    watermark=FileParam(name="watermark.jpg", data=jpg_file),
+)
+watermarked_pdf = cast(PDFGateDocument, client.watermark_pdf(watermark_pdf_params))
+```
+
+## Protect (encrypt) a PDF
+
+```python
+protect_pdf_params = ProtectPDFByDocumentIdParams(
+    document_id=document_id,
+    user_password=str(uuid.uuid4()),
+    owner_password=str(uuid.uuid4()),
+    json_response=True,
+)
+response = client.protect_pdf(protect_pdf_params)
+```
+
+## Extract PDF form fields values
+
+```python
+html_form = """
+    <form>
+        <input type='text' name='first_name' value='John'/>
+        <input type='text' name='last_name' value='Doe'/>
+    </form>
+    """
+generate_pdf_params = GeneratePDFParams(
+    html=html_form, enable_form_fields=True, json_response=True
+)
+document_response = cast(PDFGateDocument, client.generate_pdf(generate_pdf_params))
+document_id = cast(str, document_response.get("id"))
+
+extract_form_params = ExtractPDFFormDataByDocumentIdParams(document_id=document_id)
+response = cast(dict[str, Any], client.extract_pdf_form_data(extract_form_params))
+```
+
+# Development
+
+Before doing anything, install [pre-commit](https://pre-commit.com/) by running:
+
+```sh
+hatch run dev:pre-commit install
+```
+
+This will run several checks every time you try to `git commit` including:
+
+- linting and formatting with `Ruff`
+- type checking with `mypy`
+
+If you are on VS Code, it's recommended to install the `Ruff` extension so you'll get formatting on the fly.
+
+Hatch is used as a build system and for dependency management, so all main actions are configured to be run with Hatch.
+
+## Tests
+
+Unit tests:
+```sh
+hatch run test:test
+```
+
+Acceptance tests hit the PDFGate API so they are slower, and require an API key that is expected to be set as an env var named `PDFGATE_API_KEY`. You can set it on your Bash/zsh/fish profile or inline as in:
+
+```sh
+PDFGATE_API_KEY="test_123" hatch run test:test_acceptance
+```
+
+## Manually run Ruff
+
+Linting:
+```sh
+hatch run dev:lint
+```
+
+Formatting:
+```sh
+hatch run dev:ruff format .
+```
+
+## Type checking
+
+Manually mypy for type checking:
+
+```sh
+hatch run dev:check
+```
+
+## Docs
+
+Docs are build using [MkDocs](https://www.mkdocs.org/), they live in the `docs/` folder, and in the code. If you make any changes, and would like to see them live before publishing them, spin up a server locally with:
+
+```sh
+hatch run docs:serve
+```
+
+Changes to `docs/**` and `mkdocs.yml` trigger a new deployment of the docs site. If you change the code's documentation and want to manually update the docs site you can do it from the _Actions_ tab of the repo or by running:
+
+```sh
+hatch run docs:mkdocs gh-deploy
+```
+
+# Support
+
+📧 Email: support@pdfgate.com<br>
+📘 Docs: https://pdfgate.com/documentation
+
+## License
+
+`pdfgate-sdk-python` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.