Skip to main content

A pluggable implementation of webmention for Django projects

Project description

django-webmention PyPI version Build Status

webmention for Django projects.

What this project is

This package provides a way to integrate webmention endpoint discovery and webmention receipts into your project. Once you follow the installation instructions, you should be able to use something like webmention.rocks to generate a test webmention and see it in the Django admin panel.

Once you receive a webmention, you can click through to the page the webmention was sent from and see what people are saying about your site. Afterward, you can mark the webmention as reviewed in the Django admin so you can more easily see the latest webmentions you receive.

Once you verify that you're receiving webmentions successfully, you can use the webmention information as you like. As an example, you could query the webmentions that are responses to a specific page and display them on that page.

What this project isn't

This package does not currently provide functionality for sending webmentions.

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

Setup

Running Tests

You can run tests using tox:

$ tox --parallel=auto

Download files

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

Files for django-webmention, version 2.0.2
Filename, size File type Python version Upload date Hashes
Filename, size django_webmention-2.0.2-py3-none-any.whl (7.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-webmention-2.0.2.tar.gz (6.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page