printeasy-sdk 0.1.0__tar.gz

printeasy_sdk-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: ci
+on: { push: {}, pull_request: {} }
+permissions: { contents: read }
+env:
+  GENERATE: uv run openapi-python-client generate --path openapi/openapi.json --config openapi-python-client.yml --meta none --output-path src/printeasy/_generated --overwrite
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with: { version: "0.10.12" }
+      - run: uv sync --locked && $GENERATE
+      - run: uv run ruff check && uv run pytest
+      # The lowest supported Python, in its own environment.
+      - run: uv run --locked --python 3.10 pytest
+        env: { UV_PROJECT_ENVIRONMENT: .venv-py310 }
+      # Intent to add makes new generated files show up in the diff too.
+      - if: github.event_name == 'pull_request'
+        run: git add -N src/printeasy/_generated && git diff --exit-code src/printeasy/_generated
+  # On main, commit the client regenerated after the API sync bot pushes a new openapi.json.
+  regenerate:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: ci
+    runs-on: ubuntu-latest
+    permissions: { contents: write }
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with: { version: "0.10.12" }
+      - run: uv sync --locked && $GENERATE
+      - run: |
+          git config user.name "Gaurav" && git config user.email "gaurav@adfinite.com"
+          git add src/printeasy/_generated
+          git diff --cached --quiet || { git commit -m "Regenerate client from openapi.json" -m "Co-Authored-By: Gaurav <gaurav@adfinite.com>" && git push; }

printeasy_sdk-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,23 @@
+name: release
+on: { push: { tags: ["v*"] } }
+permissions: { contents: read }
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with: { version: "0.10.12" }
+      # The tag must match the version in pyproject.toml.
+      - run: test "v$(uv version --short)" = "$GITHUB_REF_NAME" && uv sync --locked && uv run pytest && uv build
+      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with: { name: dist, path: dist/ }
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions: { id-token: write }
+    steps:
+      - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
+        with: { name: dist, path: dist/ }
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

printeasy_sdk-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+.venv/
+.venv-*/
+dist/
+__pycache__/
+.pytest_cache/
+.ruff_cache/

printeasy_sdk-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

printeasy_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Adfinite
+
+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.

printeasy_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.5
+Name: printeasy-sdk
+Version: 0.1.0
+Summary: Python client for the PrintEasy cloud printing API
+Project-URL: Repository, https://github.com/GauravBR/printeasy-sdk-python
+Project-URL: Documentation, https://docs.printeasy.adfinite.com/sdks/python
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: attrs>=23.1
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: python-dateutil>=2.8
+Requires-Dist: typing-extensions>=4.7
+Description-Content-Type: text/markdown
+
+# printeasy-sdk-python
+
+Python client for the [PrintEasy](https://printeasy.adfinite.com) cloud printing API.
+
+## Install
+
+```sh
+pip install printeasy-sdk
+```
+
+The distribution is named `printeasy-sdk`; the import package is `printeasy`. Python 3.10 or newer.
+
+## Usage
+
+```python
+from printeasy import PrintEasy
+
+pe = PrintEasy("pe_test_...")  # or set PRINTEASY_API_KEY
+
+job = pe.print_jobs.create_and_wait(
+    {
+        "printerId": "0192f1a0-7c00-7000-8000-0000000000bb",
+        "title": "Invoice 1042",
+        "contentType": "pdf_uri",
+        "content": "https://example.com/invoice-1042.pdf",
+    },
+    timeout_s=60,
+)
+print(job["state"])
+
+for printer in pe.printers.iterate(limit=100):
+    print(printer["id"], printer["name"])
+```
+
+Resources: `computers`, `printers`, `print_jobs` and `webhooks` have `list`, `iterate` and `get`; `events` has `list` and `iterate`. `print_jobs.create` always sends an Idempotency-Key (a random one unless you pass `idempotency_key=`), so retries never print twice. The client retries 429 responses, and 5xx or network errors for replay safe requests, up to `max_retries` (default 3). Errors raise `PrintEasyError` with `status`, `code` and `request_id`.
+
+`pe.raw` is the generated, fully typed client (`printeasy._generated`) sharing the same retrying connection:
+
+```python
+from printeasy._generated.api.account import get_whoami
+
+who = get_whoami.sync(client=pe.raw)
+```
+
+Caveats: only the sync functions on `pe.raw` itself retry. `pe.raw.with_headers(...)` (and `with_cookies`, `with_timeout`) adds the change to the shared client but returns a copy that builds its own httpx client without retries, and the `asyncio` variants use a separate async client that does not retry.
+
+## Webhooks
+
+Verify each request with the endpoint's signing secret before trusting it. Pass the raw body, not parsed JSON:
+
+```python
+from printeasy import WebhookVerificationError, webhooks
+
+try:
+    webhooks.verify(request.body, request.headers, "whsec_...")
+except WebhookVerificationError:
+    return 400
+```
+
+## Development
+
+```sh
+uv sync
+uv run openapi-python-client generate --path openapi/openapi.json --config openapi-python-client.yml --meta none --output-path src/printeasy/_generated --overwrite
+uv run ruff check && uv run pytest
+uv build
+```
+
+`openapi/openapi.json` is synced from printeasy-api, and `src/printeasy/_generated` is generated from it; do not edit either by hand. CI regenerates the client on every push and fails a pull request whose generated code is stale.
+
+## Releasing
+
+Set `version` in `pyproject.toml`, merge, then push a matching tag (`git tag v0.1.0 && git push origin v0.1.0`). The `release` workflow checks that the tag matches the version, runs the tests, builds and publishes to PyPI through trusted publishing (GitHub environment `pypi`).
+
+## License
+
+MIT

printeasy_sdk-0.1.0/README.md

@@ -0,0 +1,77 @@
+# printeasy-sdk-python
+
+Python client for the [PrintEasy](https://printeasy.adfinite.com) cloud printing API.
+
+## Install
+
+```sh
+pip install printeasy-sdk
+```
+
+The distribution is named `printeasy-sdk`; the import package is `printeasy`. Python 3.10 or newer.
+
+## Usage
+
+```python
+from printeasy import PrintEasy
+
+pe = PrintEasy("pe_test_...")  # or set PRINTEASY_API_KEY
+
+job = pe.print_jobs.create_and_wait(
+    {
+        "printerId": "0192f1a0-7c00-7000-8000-0000000000bb",
+        "title": "Invoice 1042",
+        "contentType": "pdf_uri",
+        "content": "https://example.com/invoice-1042.pdf",
+    },
+    timeout_s=60,
+)
+print(job["state"])
+
+for printer in pe.printers.iterate(limit=100):
+    print(printer["id"], printer["name"])
+```
+
+Resources: `computers`, `printers`, `print_jobs` and `webhooks` have `list`, `iterate` and `get`; `events` has `list` and `iterate`. `print_jobs.create` always sends an Idempotency-Key (a random one unless you pass `idempotency_key=`), so retries never print twice. The client retries 429 responses, and 5xx or network errors for replay safe requests, up to `max_retries` (default 3). Errors raise `PrintEasyError` with `status`, `code` and `request_id`.
+
+`pe.raw` is the generated, fully typed client (`printeasy._generated`) sharing the same retrying connection:
+
+```python
+from printeasy._generated.api.account import get_whoami
+
+who = get_whoami.sync(client=pe.raw)
+```
+
+Caveats: only the sync functions on `pe.raw` itself retry. `pe.raw.with_headers(...)` (and `with_cookies`, `with_timeout`) adds the change to the shared client but returns a copy that builds its own httpx client without retries, and the `asyncio` variants use a separate async client that does not retry.
+
+## Webhooks
+
+Verify each request with the endpoint's signing secret before trusting it. Pass the raw body, not parsed JSON:
+
+```python
+from printeasy import WebhookVerificationError, webhooks
+
+try:
+    webhooks.verify(request.body, request.headers, "whsec_...")
+except WebhookVerificationError:
+    return 400
+```
+
+## Development
+
+```sh
+uv sync
+uv run openapi-python-client generate --path openapi/openapi.json --config openapi-python-client.yml --meta none --output-path src/printeasy/_generated --overwrite
+uv run ruff check && uv run pytest
+uv build
+```
+
+`openapi/openapi.json` is synced from printeasy-api, and `src/printeasy/_generated` is generated from it; do not edit either by hand. CI regenerates the client on every push and fails a pull request whose generated code is stale.
+
+## Releasing
+
+Set `version` in `pyproject.toml`, merge, then push a matching tag (`git tag v0.1.0 && git push origin v0.1.0`). The `release` workflow checks that the tag matches the version, runs the tests, builds and publishes to PyPI through trusted publishing (GitHub environment `pypi`).
+
+## License
+
+MIT