Skip to main content

UNKNOWN

Project description

django-botscout
===============

This provides an easy hook into the Botscout system for Django forms

Available Settings
------------------
```python
# All settings are optional. They are displayed here with their defaults
BOTSCOUT_API_KEY = None
BOTSCOUT_API_URL = 'http://botscout.com/test/'
BOTSCOUT_CACHE_TIMEOUT = 1800
BOTSCOUT_NETWORK_TIMEOUT = 5
```

Additionally, you can set the following variables on individual forms to alter
their behavior:

```python
BOTSCOUT_NAME_FIELD = 'name'
BOTSCOUT_EMAIL_FIELD = 'email'
BOTSCOUT_ERROR_MESSAGE = 'This request was matched in the BotScout database'
```


Basic Usage
-----------
In forms.py:

```python
from botscout import BotScoutForm
from django import forms


class ContactForm(BotScoutForm, forms.Form):
name = forms.CharField('Name')
email = forms.EmailField('Email')
```

In views.py:

```python
from .forms import ContactForm


def contact(request):
if request.method == 'POST':
form = ContactForm(request=request, data=request.POST)
if form.is_valid():
...
else:
form = ContactForm(request=request)
...
```

Advanced Usage
--------------
```python
from botscout import BotScoutForm
from django import forms
from django.db import models


class Person(models.Model):
full_name = models.CharField('Full name', max_length=255)
email_address = models.EmailField('Email')


class MyForm(BotScoutForm, forms.ModelForm):
BOTSCOUT_NAME_FIELD = 'full_name'
BOTSCOUT_EMAIL_FIELD = 'email_address'
BOTSCOUT_ERROR_MESSAGE = 'GO AWAY SPAM BOT!'

class Meta:
model = Person
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-botscout-0.0.2.tar.gz (3.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page