Metadata-Version: 2.1
Name: django-webmention
Version: 1.0.1
Summary: A pluggable implementation of webmention for Django projects.
Home-page: https://github.com/easy-as-python/django-webmention
Author: Dane Hillard
Author-email: github@danehillard.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Requires-Dist: Django (>=1.8.2)
Requires-Dist: requests (>=2.7.0)
Requires-Dist: pytz (==2015.4)

# 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
```


