Skip to main content

Absolute URI functions and template tags for Django

Project description

django-absoluteuri

Tests

Absolute URI functions and template tags for Django.

Why

There are times when you need to output an absolute URL (for example, inside an email), but you don’t always have access to the request. These utilities use the Sites Framework if available in order to create absolute URIs.

Installation

Install django-absoluteuri:

pip install django-absoluteuri

Then add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    # ...
    'django.contrib.sites',
    'absoluteuri',
)

django-absoluteuri requires the Sites Framework to be in INSTALLED_APPS well and configured as well.

Settings

The protocol of the uris returned by this library defaults to http. You can specify the protocol with the ABSOLUTEURI_PROTOCOL setting.

# settings.py
ABSOLUTEURI_PROTOCOL = 'https'

# Elsewhere
>>> absoluteuri.build_absolute_uri('/some/path/')
'https://example.com/some/path/'

Template Tags

There are two template tags, absoluteuri and absolutize. absoluteuri works just like the url tag, but that it outputs absolute URLs.

{% load absoluteuri %}

<a href="{% absoluteuri 'my_view' kwarg1='foo' kwarg2='bar' %}">click here</a>

absolutize will take a relative URL and return an absolute URL.

{% load absoluteuri %}

<a href="{% absolutize url_from_context %}">click here</a>

Filter

Sometimes instead of template tags, it’s easier to use filters. You can do that as well.

{% load absoluteuri %}

<a href="{{ my_object.get_absolute_url|absolutize }}">click here</a>

But there are situations where tag can not be used but filter can.

{% load absoluteuri %}

{% include "some-other-template.html" with url=my_object.get_absolute_url|absolutize %}

Functions

There are also two functions that django-absoluteuri provides, build_absolute_uri and reverse, which are equivalents of request.build_absolute_url and urlresolvers.reverse.

>>> import absoluteuri

>>> my_relative_url = '/path/to/somewhere/'
>>> absoluteuri.build_absolute_uri(my_relative_url)
'http://example.com/path/to/somewhere/'
>>> absoluteuri.reverse('viewname', kwargs={'foo': 'bar'})
'http://example.com/path/to/bar/'

Changelog

2.0.0 (2026-02-18)

  • Drop support for Python < 3.8

  • Drop support for Django < 4.2.

  • Add support for Django 4.2, 5.0, 5.1, 5.2, and 6.0.

  • Add support for Python 3.10, 3.11, 3.12, 3.13, and 3.14.

1.3.0 (2018-09-04)

  • Add support for Django 2.1. Remove support for Django < 1.11.

1.2.0 (2016-02-29)

  • Add absolutize filter. This deprecates the absolutize tag. [#4]

1.1.0 (2015-03-23)

  • Added ABSOLUTEURI_PROTOCOL settings. [#1]

  • Documented sites framework requirement.

1.0.0 (2015-03-17)

  • First release on PyPI.

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_absoluteuri-2.0.0.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_absoluteuri-2.0.0-py2.py3-none-any.whl (9.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file django_absoluteuri-2.0.0.tar.gz.

File metadata

  • Download URL: django_absoluteuri-2.0.0.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for django_absoluteuri-2.0.0.tar.gz
Algorithm Hash digest
SHA256 c7fbfeac5be2a07c884803881e72d29c21d118817c83f5272ca42c2fec7f7ae3
MD5 65b02f83cc1dffff24d1112ffef8ab37
BLAKE2b-256 ce932cbc2c6d4fb93faf6749927c950bff3771fabbdf2c846e47691677b50cc3

See more details on using hashes here.

File details

Details for the file django_absoluteuri-2.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_absoluteuri-2.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 153ab4a658dfb25acbffe99883e7fbb587e61d4d60a6942610249731fbfc2a1f
MD5 0f57cd2f3db11bc63ecddd61a72476d7
BLAKE2b-256 193b1695495d1bb30e9bb87939b1f272b54a33f8a6d22bf2284b8cc41c4e8e92

See more details on using hashes here.

Supported by

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