Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Flimm/django-fullurl

Adds three template tags: `fullurl`, `fullstatic` and `buildfullurl`. The template tag `fullurl` acts just like `url`, but it always prints absolute URLs with scheme and domain
https://github.com/Flimm/django-fullurl

django python

Last synced: about 1 month ago
JSON representation

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

Host: GitHub
URL: https://github.com/Flimm/django-fullurl
Owner: Flimm
License: mit
Created: 2017-03-01T19:49:53.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-03-30T08:18:50.000Z (over 1 year ago)
Last Synced: 2024-07-31T15:40:05.103Z (about 2 months ago)
Topics: django, python
Language: Python
Homepage: https://pypi.org/project/django-fullurl/
Size: 201 KB
Stars: 57
Watchers: 4
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE.txt

Awesome Lists containing this project

starred-awesome - django-fullurl - Adds three template tags: `fullurl`, `fullstatic` and `buildfullurl`. The template tag `fullurl` acts just like `url`, but it always prints absolute URLs with scheme and domain (Python)

README

.. image:: https://img.shields.io/pypi/v/django-fullurl.svg
:target: https://pypi.org/project/django-fullurl/
:alt: django-fullurl on PyPI

.. image:: https://img.shields.io/pypi/l/django-fullurl.svg
:target: https://pypi.org/project/django-fullurl/
:alt: django-fullurl on PyPI

.. image:: https://img.shields.io/pypi/wheel/django-fullurl.svg
:target: https://pypi.org/project/django-fullurl/
:alt: django-fullurl on PyPI

.. image:: https://img.shields.io/pypi/pyversions/django-fullurl.svg
:target: https://pypi.org/project/django-fullurl/
:alt: django-fullurl on PyPI

.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
:target: https://saythanks.io/to/Flimm
:alt: Say Thanks!

------

Template tags summary
=====================

- ``{% fullurl "some-url-name" v1 v2 %}`` This behaves like the ``url`` Django template tag (`doc `__), but it returns a full URL instead of a relative one.
- ``{% fullstatic "images/hi.jpg" %}`` This behaves like the ``static`` Django template tag (`doc `__), but it returns a full URL instead of a relative one.
- ``{% buildfullurl "/foobar" %}`` This will convert a relative URL into a full URL using ``request.build_absolute_uri`` (`doc `__).

Description
===========

**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:

.. code:: html+django

{% 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:

.. code:: html+django

{% 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:

.. code:: python

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:

.. code:: html+django

{% load fullurl %}

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

.. code:: html+django

{% load fullurl %}

Facebook static share link
--------------------------

If you want to create a Facebook share button using a link, you can use the ``sharer.php`` feature. The value for the ``u`` query parameter needs to be an absolute URL, encoded using the ``urlencode`` filter, like this:

.. code:: html+django

{% load fullurl %}