Skip to main content

Adds three template tags to Django: `fullurl`, `fullstatic` and `buildfullurl`. The template tag `fullurl` acts just like `url`, but it always prints absolute URLs with scheme and domain

Project description

django-fullurl on PyPI django-fullurl on PyPI django-fullurl on PyPI django-fullurl on PyPI Travis CI for django-fullurl (master branch) Say Thanks!

Introduction

django-fullurl adds three new template tags to Django: fullurl, fullstatic, and buildfullurl.

fullurl and fullstatic behave like url and static respectively, but they always return an absolute URL with the scheme and authority/domain parts.

For example, take this url tag:

{% url "articles:article" slug="hello" %}

In our example, this prints:

/articles/hello

This is called by some an absolute URL, because it begins with a forward-slash. However, it is not an absolute absolute URL, because it does not contain the scheme and authority parts.

If we replace url with fullurl, it will print this result:

http://example.com/articles/hello

Behind the scenes, it uses request.build_absolute_uri to determine the correct scheme and authority/domain parts.

In the same way that fullurl extends url, fullstatic extends the static template tag.

buildfullurl takes a relative URL as an argument, and prints an absolute URL with the scheme and authority parts. For example:

{% buildfullurl article.cover.url %}

Installation

Run on the command-line:

$ pip install django-fullurl

Make sure these two apps are included in your INSTALLED_APPS settings:

INSTALLED_APPS = [
    'django.contrib.staticfiles',
    'fullurl',
    # ...
]

Make sure django.template.context_processors.request is included in your context processors.

Example usage

OpenGraph

OpenGraph URLs need to be absolute, including scheme and authority parts. Here’s how you can use fullurl and fullstatic to help with this:

{% load fullurl %}

<meta property="og:url" content="{% fullurl "articles:article" article=article %}">
<meta property="og:image" content="{% fullstatic "cat.jpg" %}">

You can convert a URL from relative to absolute using buildfullurl tag:

{% load fullurl %}

<meta property="og:url" content="{% buildfullurl article.get_absolute_url %}">
<meta property="og:image" content="{% buildfullurl article.image.url %}">

See also

Here are some alternatives, in alphabetical order:

  • django-absoluteuri (GitHub, Django Packages) provides two template tags: absoluteuri and absolutize. Unlike this app, it uses the site framework to determine the domain to use, which could be an additional database query. This can be useful in some situations, for instance when creating emails.
  • django-absoluteurl (GitHub, Django Packages) provides a template tag absoluteurl that works in a similar fashion as fullurl. It does not seem to work in Python 2, or with newer Django versions, however.
  • django-full-url (GitHub) allows you to get specific parts of the current URL using code like {{ url_parts.domain }}, among other things. It does not provide the same functionality as this app, the naming similarity was unintentional.
  • django-urltags (Django Packages) provides a few template tags, including absurl, but it hasn’t been updated since 2012 and it doesn’t seem to work on recent Django versions.

Changelog

1.0

  • First release marked as stable
  • Support Django 2.0 and 2.1
  • Support Python 3.7

0.5

  • Add new template tag: buildfullurl
  • Relicense to MIT
  • Support Django 1.11

Thank you to Jakub Dolejšek for the contribution of the new template tage buildfullurl.

0.4

  • Fix RST syntax errors in README.rst

0.3

  • Fix and improve documentation
  • Add CHANGELOG.rst to MANIFEST.in

0.2

  • Add support for Django 1.8 and Django 1.9, in addition to Django 1.10.
  • Add support for Python 2.7, Python 3.2, 3.3, 3.4 and 3.5, in addition to Python 3.6.

0.1

  • 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.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_fullurl-1.0-py2.py3-none-any.whl (6.5 kB) Copy SHA256 hash SHA256 Wheel py2.py3
django-fullurl-1.0.tar.gz (5.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page