semvec/pypi-packages huggingface dataset:
contentful-webhook-receiver 0.9.0
A Django package to receive Webhooks from Contentful as signals
License: MIT
Requires Python: <3.15,>=3.10

# Contentful Webhook Receiver

[![image](https://badge.fury.io/py/contentful-webhook-receiver.svg)](https://badge.fury.io/py/contentful-webhook-receiver)

[![image](https://github.com/MarcoGlauser/contentful-webhook-receiver/actions/workflows/ci.yml/badge.svg)](https://github.com/MarcoGlauser/contentful-webhook-receiver/actions/workflows/ci.yml)

[![image](https://codecov.io/gh/MarcoGlauser/contentful-webhook-receiver/branch/master/graph/badge.svg)](https://codecov.io/gh/MarcoGlauser/contentful-webhook-receiver)

A Django package to receive Webhooks from Contentful as signals

## Documentation

The full documentation is at
<https://contentful-webhook-receiver.readthedocs.io>.

## Quickstart

Install Contentful Webhook Receiver:

    pip install contentful-webhook-receiver

Add it to your \`INSTALLED_APPS\`:

``` python
INSTALLED_APPS = (
    ...
    'contentful_webhook_receiver.apps.ContentfulWebhookReceiverConfig',
    ...
)
```

Add Contentful Webhook Receiver\'s URL patterns:

``` python
from contentful_webhook_receiver import urls as contentful_webhook_receiver_urls


urlpatterns = [
    ...
    path(r'^', include(contentful_webhook_receiver_urls)),
    ...
]
```

Listen for the Contentful Webhook Receiver signal:

``` python
@receiver(contentful_publish_entry)
def entry_published(sender, instance: WebhookInvocation, **kwargs):
    print(instance.data['sys']['content_type']['id'])
```

Register a Webhook on Contentful:

The path added to the urlpatterns is [contentful-webhook/]{.title-ref}.
If you\'re adding it to the root url configuration the path will be
[https://example.com/contentful-webook/]{.title-ref}

## Features

-   TODO

## Running Tests

Does the code actually work?

    poetry run tox

## Development commands

    poetry install --with=dev

Cutting new release

    poetry version <patch|minor|major>
    # Update changelog
    git add CHANGELOG.md pyproject.toml contentful_webhook_receiver/__init__.py
    NEW_RELEASE=$(poetry version --short)
    git commit -m "Release $NEW_RELEASE"
    git push
    git tag $NEW_RELEASE
    git push --tags

## Credits

Tools used in rendering this package:

-   [Cookiecutter](https://github.com/audreyr/cookiecutter)
-   [cookiecutter-djangopackage](https://github.com/pydanny/cookiecutter-djangopackage)