Metadata-Version: 2.1
Name: django-intl-tel-input
Version: 0.1.5
Summary: A Django form widget implementing intl-tel-input.
Home-page: https://github.com/benmurden/django-intl-tel-input
Author: Benjamin Murden
Author-email: benmurden@github.com
License: BSD License
Description: Django intl-tel-input
        =====================
        
        [![Build Status](https://travis-ci.org/benmurden/django-intl-tel-input.svg?branch=master)](https://travis-ci.org/benmurden/django-intl-tel-input)
        [![Code coverage](https://img.shields.io/codecov/c/github/benmurden/django-intl-tel-input.svg)](https://codecov.io/gh/benmurden/django-intl-tel-input)
        
        A Django form widget for international telephone numbers based on the
        jQuery plugin
        [intl-tel-input](https://github.com/jackocnr/intl-tel-input).
        
        This package is pre 1.0, so doesn't implement every feature of intl-tel-input. However, it is well tested, and has been stable in production.
        
        ## Version support
        
        Tested on the following versions of Python and Django.
        
        | Package | Version support      |
        | ------- | ---------------      |
        | Python  | 2.7, 3.4, 3.5, 3.6   |
        | Django  | 1.8, 1.9, 1.10, 1.11 |
        
        ## Installation
        
        Install from PyPI.
        
        ```shell
        pip install django-intl-tel-input
        ```
        
        Add intl-tel-input to your INSTALLED\_APPS, so Django can find the init
        script.
        
        ```python
        ...
        INSTALLED_APPS += ('intl_tel_input',)
        ...
        ```
        
        ## Usage
        
        Simply add `IntlTelInputWidget` to your form field.
        
        ```python
        from intl_tel_input.widgets import IntlTelInputWidget
        
        class MyForm(forms.ModelForm):
            class Meta:
                model = MyModel
                fields = ['foo', 'bar']
                widgets = {
                    'bar': IntlTelInputWidget()
                }
        ...
        ```
        
        With a standard form:
        
        ```python
        class MyForm(forms.Form):
            tel_number = forms.CharField(widget=IntlTelInputWidget())
        
        ...
        ```
        
        ## Form media
        
        Include `{{ form.media.css }}` in the `<head>` of your template. This
        will ensure all styles are parsed before the widget is displayed.
        
        If you have included jQuery at the end of your document, then don't
        forget to update the template where this widget appears with a
        `{{ form.media.js }}`. Put it in a block that allows it to come after
        jQuery.
        
        If you're using
        [crispy-forms](https://github.com/django-crispy-forms/django-crispy-forms),
        the static content will be inserted automatically beside the input. To
        prevent this, be sure to set `include_media = False` on your form
        helper.
        
        ```python
        class MyForm(forms.Form):
        ...
            def __init__(self, *args, **kwargs):
                self.helper = FormHelper()
                self.helper.include_media = False
        ...
        ```
        
        If you need to load all JS in the head, you can make the `init.js`
        script wait for the document to be ready with the following snippet.
        
        ```javascript
        jQuery(document).ready(
          {{ form.media.js }}
        );
        ```
        
        All this assumes your form context variable is called `form`.
        
        ## Options
        
        The widget can be invoked with keyword arguments which translate to the
        options available in intl-tel-input.
        
        ### allow\_dropdown
        Shows the country dropdown.
        Default: `True`
        
        ### default\_code
        Country code selected by default. Overridden when using `auto_geo_ip`.
        Default: `'us'`
        
        ### preferred\_countries
        Array of countries that will always appear at the top of the dropdown.
        Default: `['us', 'gb']`
        
        ### auto\_geo\_ip
        When True, [freegeoip](https://freegeoip.net) will be used to autodetect the user's country via Ajax. There is a limit of 15,000 queries per hour, so it should not be used on high-traffic sites. Alternatively use [pygeoip](https://pypi.python.org/pypi/pygeoip), detect server-side, then set the `default_code`.
        Default: `False`
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
