Metadata-Version: 2.5
Name: render-lab-tasks-contentful
Version: 0.1.0
Summary: contentful tasks for Render Workflows
Project-URL: Repository, https://github.com/render-lab/render-tasks-python
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: httpx<0.29,>=0.28
Requires-Dist: render-lab-tasks-core<0.2,>=0.1.1
Requires-Dist: render-lab-triggers<0.2,>=0.1.0
Requires-Dist: render==1.0.1
Description-Content-Type: text/markdown

# render-lab-tasks-contentful

Python port of all 11 registered tasks in the pinned TypeScript pack at
`45f9c2d44bd28e01ae9813e0d2ff56ee6c533816`. Python 3.12+.

Install this distribution and its dependencies:

```sh
pip install render-lab-tasks-contentful==0.1.0
```

Import definitions from `render_lab_tasks_contentful.tasks`; combine `app` objects
with `Workflows.from_workflows(...)`. JSON fields retain TS spelling; functions
use snake_case. Package root imports are inert.

## Tasks

| Registered name | Python export (also exposes `_impl`) |
| --- | --- |
| `contentful.createAsset` | `create_asset` |
| `contentful.createEntry` | `create_entry` |
| `contentful.deleteEntry` | `delete_entry` |
| `contentful.getAssets` | `get_assets` |
| `contentful.getContentTypes` | `get_content_types` |
| `contentful.getEntries` | `get_entries` |
| `contentful.getEntry` | `get_entry` |
| `contentful.publishAsset` | `publish_asset` |
| `contentful.publishEntry` | `publish_entry` |
| `contentful.unpublishEntry` | `unpublish_entry` |
| `contentful.updateEntry` | `update_entry` |

## Dependencies and retries

Raw implementations accept context first and keyword-only `deps`. The `.client`
module exports typed `Port`, `Deps`, and `Client` classes. Inject a fake port, or
pass a caller-owned `httpx.AsyncClient` to `Client`. Default dependencies close
their client after one operation. Credentials resolve at first use. Transport
retries are disabled; `retry.py` owns durable policies. DTO types are in `.types`.
Requires core >=0.1.1.

## Environment

| Variable | Contract |
| --- | --- |
| `CONTENTFUL_SPACE_ID` | Required space. |
| `CONTENTFUL_ENVIRONMENT` | Optional environment; defaults to `master`. |
| `CONTENTFUL_CDA_TOKEN` | Required for delivery reads: getEntries/getAssets. |
| `CONTENTFUL_CMA_TOKEN` | Required for management reads and writes. |

## Verification and limitations

Delivery and management credentials are separate. DTOs flatten sys metadata and
preserve localized fields. Versioned writes and creates disable durable retries;
delete treats 404 as already deleted. Asset creation processes each requested
locale and rereads its version, but does not wait for processing completion.
Collection results at or above 4 MiB are rejected. Each read is a single page.

Shared fixtures execute the actual pinned TS implementations and compare Python
outputs and requests. Sanity's SDK calls are translated into separately asserted
REST requests. These are hermetic checks, not real account or hosted verification.
See [the testing backlog](https://github.com/render-lab/render-tasks-python/issues/1)
and the root verification tracker. Licensed under MIT.

## Webhook adapter

`render_lab_tasks_contentful.webhooks.contentful_adapter(on_event, ...)` returns a
registration-free adapter for `render_lab_triggers`. The callback receives the
verified event and returns `{"task": "namespace.task", "args": [event]}` or `None`.
The signing credential `CONTENTFUL_WEBHOOK_SECRET` is read inside verification unless
provided explicitly. Importing this module does not register tasks. Signature
checks use the raw body; live delivery remains in the testing backlog.
