Webmention support for Django.
Project description
django-wm
django-wm
lets you add Webmention functionality to your Django project with minimal setup.
Upgrading
Please check the changelog before upgrading, especially between major versions.
After upgrading remember to run the makemigrations
and migrate
management commands so that any changes in model/mixin definitions can be applied.
Getting started
All done? You can use the testing tool to make sure it works.
Features
-
Endpoints:
/webmention
: Receives incoming Webmentions from other sites./webmention/get
: Used to retrieve Webmentions for a page on your site.
e.g./webmention/get?url=/my-article
will return any received Webmentions that target/my-article
on your site.// /webmention/get?url=/my-article { "target_url": "https://my-site.org/my-article", "mentions": [ { "hcard": { "name": "Jane Bloggs", "avatar": "https://gravatar.com/janebloggs", "homepage": "https://jane-bloggs-example.org" }, "quote": null, "source_url": "https://jane-bloggs-example.org/some-article", "published": "2020-01-17T21:45:24.542Z", "type": "webmention" } ] }
/webmention/dashboard/
: a simple overview of recent mentions (accessible with permissionmentions.view_webmention_dashboard
or publicly viasettings.WEBMENTIONS_DASHBOARD_PUBLIC
)
-
WebmentionHeadMiddleware
adds your/webmention
endpoint to the headers of your pages so that it can be discovered by other sites. -
{% webmentions_endpoint %}
template tag to include your/webmention
endpoint to your Django templates HTML element. -
MentionableMixin
enables automatic submission of Webmentions to other sites when you mention them in your content.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_wm-3.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69294f66b1704a7d2677820026bd6b3ed2a69f2cdb6379f6042ae3220feac062 |
|
MD5 | d3c438537bc62b110d057b0445cdf66f |
|
BLAKE2b-256 | 41313ce73a39097282d6e4e3574e6e489a6d6536a8836060968fab18249e90a7 |