djextra 1.0.0

Additional Functions for Django

What this?

This repository contains additional code for Django.

Why I create this?

Because I love Django, and usually using it. However, I found some essential code is lacked for modern web development. For example, you might want to send Ajax Payload like this:

{
  "name": "John Doe",
  "age": 49,
  "email": "[e-mail]",
  "email_aliases": [
    "[e-mail]",
    "[e-mail]",
    "[e-mail]"
  ]
}

In this case, you can validate name, age, and email field by using Form layer on Django. However, email_aliases cannot be validated because it’s a list and it should validate each value whether it is email-formatted or not.

To support this case (and some other cases that Django can’t handle), I wrote some code to support List validation.

How To Use It

ListField

ListField is used to handle a list of values like above example. To use ListField, you can write a form like this:

forms.py

from django import forms
from djextra import forms as exforms


class ExampleForm(forms.Form):
  name = forms.CharField()
  age = forms.IntegerField()
  email = forms.EmailField()
  email_aliases = exforms.ListField(field=forms.EmailField())

Then, Inputting the data as usual, the validation will start. If you don’t specify field keyword argument, django.forms.CharField object is specified.

Contribution

Contribution of code is welcome, and the code is tested with tox. Before sending your pull request, please check you tested your code very well.

License

This repository is licensed under the terms of MIT License. Please check LICENSE.md for the detail.