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/jezdez/django-hosts.svg https://img.shields.io/coveralls/jezdez/django-hosts.svg https://readthedocs.org/projects/django-hosts/badge/?version=latest&style=plastic

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.1.tar.gz (31.5 kB view details)

Uploaded Source

Built Distribution

django_hosts-1.1-py2.py3-none-any.whl (30.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for django-hosts-1.1.tar.gz
Algorithm Hash digest
SHA256 71c6d1425e68c9dace0aef7cae9d67570690de75118d2c69d1ff8b384d8edafd
MD5 d805e86e826f7ad00cd7bf6a14b8fbab
BLAKE2b-256 d2f4d7432bb2c131604a618753a61262de7b43a87d03cbb47d959a834f8e5a78

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_hosts-1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d911c593a54c48a35f71a29e110b5eea733464df3f26d81da87beb852f1915cf
MD5 1f355448b9dcc12da48b87db0e4f90d3
BLAKE2b-256 0814dadde67dd27276f379e50a2a652898eaab221c296f0410e9e5232fa87faa

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