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 details)

Uploaded Source

File details

Details for the file django-botscout-0.0.2.tar.gz.

File metadata

File hashes

Hashes for django-botscout-0.0.2.tar.gz
Algorithm Hash digest
SHA256 ae2f2b70211aef4adb9f2774047d36bf7922ea4f6bc76a55e8b14c1d12052237
MD5 faf38293be7c48ea75ad3114b13fb32d
BLAKE2b-256 d0c31b19357e4b8edb4db024a31a38538b2cfc4d3a1233586e5202af8728ae51

See more details on using hashes here.

Supported by

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