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/pypi/pyversions/django-hosts.svg https://img.shields.io/pypi/djversions/django-hosts.svg https://github.com/jazzband/django-hosts/workflows/Test/badge.svg https://codecov.io/gh/jazzband/django-hosts/branch/master/graph/badge.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 setting.

  3. Add 'django_hosts.middleware.HostsResponseMiddleware' to the end of your MIDDLEWARE 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-5.1.tar.gz (35.9 kB view details)

Uploaded Source

Built Distribution

django_hosts-5.1-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django-hosts-5.1.tar.gz
  • Upload date:
  • Size: 35.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for django-hosts-5.1.tar.gz
Algorithm Hash digest
SHA256 395ea0017389eb509ac8df58fa8a93c287935a9bf47cb11d36540ee241b2e81b
MD5 623120c1d50d9f32d2209ce6180d13ed
BLAKE2b-256 e2b6d7b6bab4b1c92781f699763173cdd5313e46252039f75671ac52050aa78d

See more details on using hashes here.

Provenance

File details

Details for the file django_hosts-5.1-py3-none-any.whl.

File metadata

  • Download URL: django_hosts-5.1-py3-none-any.whl
  • Upload date:
  • Size: 27.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for django_hosts-5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 56d14958defcd513098953931ea36e691a6a5b87340d281ff818bc81f0810075
MD5 306ee23be95d9e69ad245d85cbb2b57b
BLAKE2b-256 68a76ad40e5a2037db4dfc104d0f0d55e28128934cf387c4a94c39a9c5cbb75f

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