Skip to main content

Dynamic and static host resolving for Django. Maps hostnames to URLconfs.

Project description

https://img.shields.io/pypi/v/django-hosts.svg https://img.shields.io/travis/jazzband/django-hosts.svg https://img.shields.io/coveralls/jazzband/django-hosts.svg https://readthedocs.org/projects/django-hosts/badge/?version=latest&style=flat https://jazzband.co/static/img/badge.svg

This Django app routes requests for specific hosts to different URL schemes defined in modules called “hostconfs”.

For example, if you own example.com but want to serve specific content at api.example.com and beta.example.com, add the following to a hosts.py file:

from django_hosts import patterns, host

host_patterns = patterns('path.to',
    host(r'api', 'api.urls', name='api'),
    host(r'beta', 'beta.urls', name='beta'),
)

This causes requests to {api,beta}.example.com to be routed to their corresponding URLconf. You can use your urls.py as a template for these hostconfs.

Patterns are evaluated in order. If no pattern matches, the request is processed in the usual way, ie. using the standard ROOT_URLCONF.

The patterns on the left-hand side are regular expressions. For example, the following ROOT_HOSTCONF setting will route foo.example.com and bar.example.com to the same URLconf.

from django_hosts import patterns, host

host_patterns = patterns('',
    host(r'(foo|bar)', 'path.to.urls', name='foo-or-bar'),
)

Installation

First, install the app with your favorite package manager, e.g.:

pip install django-hosts

Alternatively, use the repository on Github.

You can find the full docs here: django-hosts.rtfd.org

Then configure your Django site to use the app:

  1. Add 'django_hosts' to your INSTALLED_APPS setting.

  2. Add 'django_hosts.middleware.HostsRequestMiddleware' to the beginning of your MIDDLEWARE_CLASSES setting.

  3. Add 'django_hosts.middleware.HostsResponseMiddleware' to the end of your MIDDLEWARE_CLASSES setting.

  4. Create a new module containing your default host patterns, e.g. in the hosts.py file next to your urls.py.

  5. Set the ROOT_HOSTCONF setting to the dotted Python import path of the module containing your host patterns, e.g.:

    ROOT_HOSTCONF = 'mysite.hosts'
  6. Set the DEFAULT_HOST setting to the name of the host pattern you want to refer to as the default pattern. It’ll be used if no other pattern matches or you don’t give a name to the host_url template tag.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-hosts-1.3.tar.gz (32.4 kB view details)

Uploaded Source

Built Distribution

django_hosts-1.3-py2.py3-none-any.whl (28.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-hosts-1.3.tar.gz.

File metadata

  • Download URL: django-hosts-1.3.tar.gz
  • Upload date:
  • Size: 32.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-hosts-1.3.tar.gz
Algorithm Hash digest
SHA256 62c11415b8f1f457071e2d449e6d485d66e10ccf90bb1c3b6cd5e6e3488d0533
MD5 07acddc967581b05ee38308abd24d638
BLAKE2b-256 8852c2cb6af1dc272d779b1d8ea63b79ff34adb5593446d6328747c8b8926e52

See more details on using hashes here.

Provenance

File details

Details for the file django_hosts-1.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_hosts-1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 00b092a3585cd08b6c0c4fe4290113f35b4328ce1ef550afe9579ebd0977b51c
MD5 35759aac583749c18c9d68c3d32fa486
BLAKE2b-256 08ae03cea526da9763f5e92d3895b6ce6b992fd9841b03c11fd4f2276a1e2f45

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page