Metadata-Version: 1.1
Name: contentful-webhook-receiver
Version: 0.2.0
Summary: A Django package to receive Webhooks from Contentful as signals
Home-page: https://github.com/MarcoGlauser/contentful-webhook-receiver
Author: Marco Glauser
Author-email: github@mglauser.ch
License: MIT
Description: =============================
        Contentful Webhook Receiver
        =============================
        
        .. image:: https://badge.fury.io/py/contentful-webhook-receiver.svg
            :target: https://badge.fury.io/py/contentful-webhook-receiver
        
        .. image:: https://travis-ci.org/MarcoGlauser/contentful-webhook-receiver.svg?branch=master
            :target: https://travis-ci.org/MarcoGlauser/contentful-webhook-receiver
        
        .. image:: https://codecov.io/gh/MarcoGlauser/contentful-webhook-receiver/branch/master/graph/badge.svg
            :target: 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`:
        
        .. code-block:: python
        
            INSTALLED_APPS = (
                ...
                'contentful_webhook_receiver.apps.ContentfulWebhookReceiverConfig',
                ...
            )
        
        Add Contentful Webhook Receiver's URL patterns:
        
        .. code-block:: python
        
            from contentful_webhook_receiver import urls as contentful_webhook_receiver_urls
        
        
            urlpatterns = [
                ...
                url(r'^', include(contentful_webhook_receiver_urls)),
                ...
            ]
        
        
        Listen for the Contentful Webhook Receiver signal:
        
        .. code-block:: 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/$`.
        If you're adding it to the root url configuration the path will be `https://example.com/contentful-webook/`
        
        
        Features
        --------
        
        * TODO
        
        Running Tests
        -------------
        
        Does the code actually work?
        
        ::
        
            source <YOURVIRTUALENV>/bin/activate
            (myenv) $ pip install tox
            (myenv) $ tox
        
        
        Development commands
        ---------------------
        
        ::
        
            pip install -r requirements_dev.txt
            invoke -l
        
        
        Credits
        -------
        
        Tools used in rendering this package:
        
        *  Cookiecutter_
        *  `cookiecutter-djangopackage`_
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
        
        
        
        
        History
        -------
        
        0.1.0 (2021-02-15)
        ++++++++++++++++++
        
        * First release on PyPI.
        
Keywords: contentful-webhook-receiver
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
