Skip to main content

A pluggable implementation of webmention for Django projects.

Project description

# django-webmention [![PyPI version](https://badge.fury.io/py/django-webmention.svg)](https://badge.fury.io/py/django-webmention) [![Build Status](https://travis-ci.org/easy-as-python/django-webmention.svg?branch=master)](https://travis-ci.org/easy-as-python/django-webmention)

[webmention](https://www.w3.org/TR/webmention/) for Django projects.

## Installation

$ pip install django-webmention

  • Add ‘webmention’ to INSTALLED_APPS

  • Run python manage.py migrate webmention

  • Add the URL patterns to your top-level urls.py
    • path(‘webmention/’, include(webmention.urls)) for Django >= 2.0

    • url(r’^webmention’, include(‘webmention.urls’, namespace=’webmention’)) for Django < 2.0

## Usage

  • Include webmention information by either:
    • Installing the middleware in settings.py (affects all views)
      • Use webmention.middleware.webmention_middleware in MIDDLEWARE for Django >= 1.10

      • Use webmention.middleware.WebMentionMiddleware in MIDDLEWARE_CLASSES for older projects

    • Decorating a specific view with webmention.middleware.include_webmention_information

  • View webmention responses in the Django admin interface and mark them as reviewed as needed

## Development

### Running Tests

You can run tests using the runtests.py module:

`shell $ python runtests.py `

You can also run the tests inside a consuming Django project:

` $ python manage.py test webmention `

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

django_webmention-1.0.0-py3-none-any.whl (10.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page