Skip to content

easy-as-python/django-webmention

Repository files navigation

django-webmention PyPI version Build Status

webmention for Django projects.

Installation

$ pip install django-webmention

  • Add webmention to INSTALLED_APPS
  • Run manage.py migrate webmention
  • Add url(r'^webmention', include('webmention.urls', namespace='webmention')) to top-level urls.py
    • Use path('webmention/', include(webmention.urls)) for newer projects
  • Run manage.py test webmention to ensure unit tests all pass

Usage

  • Include webmention information by either:
    • Installing the middleware in settings.py (affects all views)
      • Use webmention.middleware.webmention_middleware in MIDDLEWARE for new projects and projects with 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 tool and mark them as reviewed as needed