An improved URL selector to choose between internal models and external URLs
Project description
django-any-urlfield
The any_urlfield module provides an improved URL selector that supports both URLs to internal models and external URLs.
This addresses is a common challenge in CMS interfaces; where providing a URLField makes it hard to enter internal URLs, while providing a ModelChoiceField makes it too inflexible. This package provides the both of both worlds.
For more details, see the documentation at Read The Docs.
Screenshot
Installation
First install the module, preferably in a virtual environment. It can be installed from PyPI:
pip install django-any-urlfield
Or the current folder can be installed:
pip install .
Configuration
Add the module to the installed apps:
INSTALLED_APPS += (
'any_urlfield',
)
Usage
In a Django model, the field can be included:
from django.db import models
from any_urlfield.models import AnyUrlField
class MyModel(models.Model):
title = models.CharField("Title", max_length=200)
url = AnyUrlField("URL")
By default, the AnyUrlField only supports linking to external pages. To add support for your own models (e.g. an Article model), include the following code in models.py:
from any_urlfield.models import AnyUrlField AnyUrlField.register_model(Article)
Now, the AnyUrlField offers users a dropdown field to directly select an article. By default, it uses a django.forms.models.ModelChoiceField field with a django.forms.widgets.Select widget to render the field. This can be customized using the form_field and widget parameters:
from any_urlfield.models import AnyUrlField from any_urlfield.forms import SimpleRawIdWidget AnyUrlField.register_model(Article, widget=SimpleRawIdWidget(Article))
Now, the Article model will be displayed as raw input field with a browse button.
Contributing
This module is designed to be generic. In case there is anything you didn’t like about it, or think it’s not flexible enough, please let us know. We’d love to improve it!
If you have any other valuable contribution, suggestion or idea, please let us know as well because we will look into it. Pull requests are welcome too. :-)
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
File details
Details for the file django-any-urlfield-1.0.5.tar.gz.
File metadata
- Download URL: django-any-urlfield-1.0.5.tar.gz
- Upload date:
- Size: 15.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1f99bad2470c1ca55bddd865dffc37cd3ba34b5392f779c269681ce111f2a530 |
|
| MD5 | 1f670123588bc693e73249c23adfd8be |
|
| BLAKE2b-256 | 3f9e5f4328a500d2de5b55c22a8e3e32caaddf3712fb92ca6fe4f01ebf5b9a3c |
