https://github.com/jcarbaugh/django-wellknown

Easy administration of /.well-known/ resources, robots.txt, and crossdomain.xml
https://github.com/jcarbaugh/django-wellknown

Last synced: 2 months ago
JSON representation

Easy administration of /.well-known/ resources, robots.txt, and crossdomain.xml

• Host: GitHub
• URL: https://github.com/jcarbaugh/django-wellknown
• Owner: jcarbaugh
• License: bsd-3-clause
• Created: 2009-11-12T20:34:57.000Z (about 15 years ago)
• Default Branch: master
• Last Pushed: 2012-11-02T17:04:00.000Z (about 12 years ago)
• Last Synced: 2024-04-14T07:57:31.074Z (9 months ago)
• Language: Python
• Homepage:
• Size: 120 KB
• Stars: 12
• Watchers: 3
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
================

django-wellknown

================

Django application to provide easy administration of site-meta URIs. Includes robots.txt and crossdomain.xml.

http://tools.ietf.org/html/draft-nottingham-site-meta-03

http://tools.ietf.org/html/draft-hammer-hostmeta-04

Requirements

============

python >= 2.5

django >= 1.0

django-robots (optional)

python-xrd

iso8601

Installation

============

Be sure to add ``wellknown`` to ``INSTALLED_APPS`` in settings.py. Additionally, add the following entry to urls.py::

	urls(r'^', include('wellknown.urls')),

Run ``./manage.py syncdb``

Usage

=====

Register resources

------------------

::

	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::

	http://example.com/.well-known/host-meta

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

#. use ``text/plain`` if no content_type can be guessed

Model resources

---------------

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 ``text/plain``

When a resource is saved, it is updated in the cache.

host-meta

---------

A default ``host-meta`` file is automatically handled by wellknown. To register an entry in ``host-meta``::

	wellknown.hostmeta.links.append(Link(rel=..., ...))

Refer to the python-xrd documentation for instructions on creating XRD Link elements.

The ``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')

django-robots

-------------

wellknown will defer to `django-robots `_ if it is installed. To use django-robots to render robots.txt, add ``robots`` to ``INSTALLED_APPS`` in settings.py and wellknown will take care of the rest.