offprint 0.0.0__tar.gz → 0.0.3__tar.gz

{offprint-0.0.0 → offprint-0.0.3}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Package authors
+Copyright (c) 2026 Péter Ferenc Gyarmati
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

offprint-0.0.3/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: offprint
+Version: 0.0.3
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Rust
+Classifier: Typing :: Typed
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.txt
+Summary: Capture rendered web pages as verified self-contained artifacts
+License-Expression: MIT
+Requires-Python: >=3.10, <3.15
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Documentation, https://peter-gy.github.io/offprint/
+Project-URL: Issues, https://github.com/peter-gy/offprint/issues
+Project-URL: Source, https://github.com/peter-gy/offprint
+
+# `offprint` for Python
+
+The `offprint` package captures rendered pages through the native Offprint
+service and returns canonical capture records as dictionaries.
+
+It supports Python 3.10 through 3.14 on Linux x86-64 with glibc, macOS arm64
+and x86-64, and Windows x86-64.
+
+Linux hosts also need Chromium's
+[shared runtime libraries](https://peter-gy.github.io/offprint/start/install.html#linux-runtime-libraries).
+
+## Capture from the command line
+
+Run with [`uvx`](https://docs.astral.sh/uv/guides/tools/), uv's Python command runner:
+
+```console
+uvx offprint capture https://example.com --output example.html --quiet
+```
+
+## Use in an application
+
+Install version 0.0.3:
+
+```console
+python -m pip install offprint==0.0.3
+```
+
+```python
+import asyncio
+
+from offprint import Offprint
+
+
+async def main() -> None:
+    async with Offprint() as offprint:
+        receipt = await offprint.capture(
+            "https://example.com",
+            output="example.html",
+        )
+        artifact = receipt["artifact"]
+        assert artifact["kind"] == "file"
+        print(artifact["path"])
+
+
+asyncio.run(main())
+```
+
+The first capture discovers a compatible Chrome, Chromium, or Microsoft Edge
+installation. When discovery and the managed cache are empty, Offprint
+downloads and verifies its pinned
+[Chrome for Testing](https://googlechromelabs.github.io/chrome-for-testing/)
+build.
+
+## Requests and jobs
+
+Inside the service context, create a request with native defaults, choose
+memory output, and start a job:
+
+```python
+request = offprint.captures.request("https://example.com")
+request["output"] = {"kind": "memory", "maxBytes": 16 * 1024 * 1024}
+job = await offprint.captures.start(request)
+receipt = await job.result()
+```
+
+Use `job.events()` for progress and `job.cancel()` to request cancellation.
+Use `async with` for a bounded lifetime, or await `close()` during shutdown.
+`offprint.artifacts` inspects, verifies, and exports saved captures.
+`offprint.browsers` manages browser discovery and installations.
+
+Methods and keyword arguments use snake_case. Request and result dictionaries
+use camelCase. Failures raise `OffprintError` subclasses with a stable `code`,
+`stage`, and `retryable` flag.
+
+Read the complete [Python integration guide](https://peter-gy.github.io/offprint/integrations/python.html),
+[record reference](https://peter-gy.github.io/offprint/reference/records.html),
+and [troubleshooting guide](https://peter-gy.github.io/offprint/operations/troubleshooting.html).
+
+[`src/offprint/__init__.pyi`](./src/offprint/__init__.pyi) owns exact host
+signatures. [`src/offprint/contracts.py`](./src/offprint/contracts.py)
+owns importable generated canonical dictionary shapes.
+
+Source contributors can follow the
+[contributor setup](https://github.com/peter-gy/offprint/blob/main/development_docs/setup.md).
+

offprint-0.0.3/README.md

@@ -0,0 +1,84 @@
+# `offprint` for Python
+
+The `offprint` package captures rendered pages through the native Offprint
+service and returns canonical capture records as dictionaries.
+
+It supports Python 3.10 through 3.14 on Linux x86-64 with glibc, macOS arm64
+and x86-64, and Windows x86-64.
+
+Linux hosts also need Chromium's
+[shared runtime libraries](https://peter-gy.github.io/offprint/start/install.html#linux-runtime-libraries).
+
+## Capture from the command line
+
+Run with [`uvx`](https://docs.astral.sh/uv/guides/tools/), uv's Python command runner:
+
+```console
+uvx offprint capture https://example.com --output example.html --quiet
+```
+
+## Use in an application
+
+Install version 0.0.3:
+
+```console
+python -m pip install offprint==0.0.3
+```
+
+```python
+import asyncio
+
+from offprint import Offprint
+
+
+async def main() -> None:
+    async with Offprint() as offprint:
+        receipt = await offprint.capture(
+            "https://example.com",
+            output="example.html",
+        )
+        artifact = receipt["artifact"]
+        assert artifact["kind"] == "file"
+        print(artifact["path"])
+
+
+asyncio.run(main())
+```
+
+The first capture discovers a compatible Chrome, Chromium, or Microsoft Edge
+installation. When discovery and the managed cache are empty, Offprint
+downloads and verifies its pinned
+[Chrome for Testing](https://googlechromelabs.github.io/chrome-for-testing/)
+build.
+
+## Requests and jobs
+
+Inside the service context, create a request with native defaults, choose
+memory output, and start a job:
+
+```python
+request = offprint.captures.request("https://example.com")
+request["output"] = {"kind": "memory", "maxBytes": 16 * 1024 * 1024}
+job = await offprint.captures.start(request)
+receipt = await job.result()
+```
+
+Use `job.events()` for progress and `job.cancel()` to request cancellation.
+Use `async with` for a bounded lifetime, or await `close()` during shutdown.
+`offprint.artifacts` inspects, verifies, and exports saved captures.
+`offprint.browsers` manages browser discovery and installations.
+
+Methods and keyword arguments use snake_case. Request and result dictionaries
+use camelCase. Failures raise `OffprintError` subclasses with a stable `code`,
+`stage`, and `retryable` flag.
+
+Read the complete [Python integration guide](https://peter-gy.github.io/offprint/integrations/python.html),
+[record reference](https://peter-gy.github.io/offprint/reference/records.html),
+and [troubleshooting guide](https://peter-gy.github.io/offprint/operations/troubleshooting.html).
+
+[`src/offprint/__init__.pyi`](./src/offprint/__init__.pyi) owns exact host
+signatures. [`src/offprint/contracts.py`](./src/offprint/contracts.py)
+owns importable generated canonical dictionary shapes.
+
+Source contributors can follow the
+[contributor setup](https://github.com/peter-gy/offprint/blob/main/development_docs/setup.md).