Wagtail links provides a consistent way to refer to links in a wagtail page.
Verified details
These details have been verified by PyPIProject links
GitLab Statistics
Maintainers
Project description
wagtail-links
Purpose
Wagtail links has two goals:
- Provide a consistent way to refer to links, which may be of different types, so as to reduce decision fatigue
- Minimize broken links as much as possible.
Install
Install wagtail-links via Pip.
pip install wagtail-links
Add wagtail_links to your Django project's INSTALLED_APPS setting.
Run database migrations.
python manage.py migrate
Usage
Add a foreign key to the page you wish to add links to.
my_link = models.ForeignKey(
'wagtail_links.Link',
null=True,
blank=True,
on_delete=models.SET_NULL,
related_name='+'
)
Neat:
You may use it like:
<a href="{{ self.link.url }}">Link here</a>
From a template, you can also load a link by its name:
{% load get_wagtail_link_url from wagtail_links %}
<a href="{% get_wagtail_link_url 'my-link' %}">Link here</a>
This is useful for global page links, navigation, etc.
Validation and logging
The Link model will validate that one and only one field is set. It will also disallow invalid Django reverse view names.
If a URL cannot be determined, we'll log the issue as a warning. We won't throw an exception as that would be bad for users. You are responsible for capturing this log warning, perhaps using Sentry.
For example - let's say you make a Django view name called admin:index. This would typically give you /admin/. Later the admin application is removed from the program, now this link fails. It will now display "" and generate a warning in your server logs.
Project details
Verified details
These details have been verified by PyPIProject links
GitLab Statistics
Maintainers
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file wagtail_links-2.9.0.tar.gz.
File metadata
- Download URL: wagtail_links-2.9.0.tar.gz
- Upload date:
- Size: 9.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fc07ac0efbd3fcc885863725d11b7e1da5dcff77289d097833f98ccf70ba4fc2 |
|
| MD5 | b2e61021acb0be0e3d9b0630eed0a4be |
|
| BLAKE2b-256 | 75e59f91defbbe28ecb4b36ea1dc9e55b2290f7f675ae41b81773b033f4bfa6c |
File details
Details for the file wagtail_links-2.9.0-py3-none-any.whl.
File metadata
- Download URL: wagtail_links-2.9.0-py3-none-any.whl
- Upload date:
- Size: 15.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d3371774117bdd063c6d98b6b3b9a8219e84c01c7136c289712f0e927a940429 |
|
| MD5 | 02a98472a3c0c75c8af46a40c03df8cd |
|
| BLAKE2b-256 | e6a02861e04b3be5f3aac888c77fbaef02c65d5bc1aaa57b4e1bdc8c31e0bfef |
