Django application to provide easy administration of site-meta URIs. Includes robots.txt and crossdomain.xml.
python >= 2.5
django >= 1.0
Be sure to add
INSTALLED_APPS in settings.py. Additionally, add the following entry to urls.py:
import wellknown wellknown.register('host-meta', ...)
The first argument is the path that will be exposed for the resource. A path of
host-meta will map to:
At least one of the following arguments is required:
content: a string or unicode representation of the resource, cached on startup
template: the path to a template that will be rendered for the resource, rendered and cached on startup
handler: a handler method that will be used to render the resource, invoked on each request
Handler methods must have the following signature and return a string or unicode object:
def handler(request, *args, **kwargs): pass
The register method takes one optional parameter,
content_type. This is the content type that will be used to return the rendered resource. The following rules are used to determine the content_type to use:
- if a content_type parameter was passed to register, use it
- attempt to infer content_type from the path using the mimetypes package
text/plainif no content_type can be guessed
Resources may be stored in the database to make it easy for non-technical users to edit. The following fields are available on a Resource:
path: the path that maps to the resource
content: the content that will be served when the resource is requested
content_type: the content_type with which the content will be returned, defaults to
When a resource is saved, it is updated in the cache.
host-meta file is automatically handled by wellknown. To register an entry in
Refer to the python-xrd documentation for instructions on creating XRD Link elements.
Host element of
host-meta is inferred from the domain of the current Django Site object. To override the hosts, edit settings.py:
WELLKNOWN_HOSTMETA_SITES = ('example.com', 'www.example.com')
wellknown will defer to django-robots if it is installed. To use django-robots to render robots.txt, add
INSTALLED_APPS in settings.py and wellknown will take care of the rest.