Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Python
branch: develop

Merge pull request #47 from romantolkachyov/develop

Fix translation and include it in package data
latest commit 7228f253a6
@thedrow thedrow authored

README.rst

django-phonenumber-field

https://travis-ci.org/GaretJax/django-phonenumber-field.svg?branch=develop https://coveralls.io/repos/GaretJax/django-phonenumber-field/badge.png?branch=develop

A Django library which interfaces with python-phonenumbers to validate, pretty print and convert phone numbers. python-phonenumbers is a port of Google's libphonenumber library, which powers Android's phone number handling.

Included are:

  • PhoneNumber, a pythonic wrapper around python-phonenumbers' PhoneNumber class
  • PhoneNumberField, a model field
  • PhoneNumberField, a form field
  • PhoneNumberPrefixWidget, a form widget

Installation

pip install django-phonenumber-field

Basic usage

Use it like any regular model field:

from phonenumber_field.modelfields import PhoneNumberField

class MyModel(models.Model):
    name = models.CharField(max_length=255)
    phone_number = PhoneNumberField()
    fax_number = PhoneNumberField(blank=True)

Internally, PhoneNumberField is based upon CharField and represents the number as a string of an international phonenumber in the database (e.g '+41524204242'). As with CharField's, it is discouraged to use null=True.

The object returned is a PhoneNumber instance, not a string. If strings are used to initialize it, e.g. via MyModel(phone_number='+41524204242') or form handling, it has to be a phone number with country code.

Something went wrong with that request. Please try again.