Integration with briteverify API
Project description
Helper for easy integration between django and briteverify.com service.
It supports Python2.6+, Django1.4+
Installation
$ pip install django-briteverify
Usage
In common case as you need is use BriteverifyFormMixin for your forms and specify a BRITEVERIFY_API_KEY:
# your_app/forms.py from django import forms from django_briteverify import BriteverifyFormMixin class RegisterForm(BriteverifyFormMixin, forms.Form): email = forms.EmailField()
Set BRITEVERIFY_API_KEY as environment variable:
$ export BRITEVERIFY_API_KEY='YOUR_API_KEY'
Or define it directly in settings
# settings.py BRITEVERIFY_API_KEY = 'YOUR_API_KEY'
You can specify field name which be used as source for verifying:
class RegisterForm(BriteverifyFormMixin, forms.Form): another_email = forms.EmailField() EMAIL_FIELD_NAME = 'another_email'
Also you can override error messages which raised if validation didn’t pass:
class RegisterForm(BriteverifyFormMixin, forms.Form): error_messages = { 'invalid_email': _('This is an invalid email address. ' 'Maybe you mistyped?'), 'disposable_email': _('Please provide your real email address.') }
Contributing
- Fork the django-briteverify repo on GitHub.
- Clone your fork locally:
$ git clone git@github.com:your_name_here/django-briteverify.git
- Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv django-briteverify
$ cd django-briteverify/
$ python setup.py develop
- Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature Now you can make your changes locally.
- When you’re done making changes, check that your changes pass the tests, including testing other Python versions with tox:
$ pip install tox $ tox
- Commit your changes and push your branch to GitHub:
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
- Submit a pull request through the GitHub website.
Project details
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
django-briteverify-1.0.tar.gz
(4.6 kB
view hashes)