django-pin-passcode 0.1.4

A simple django app that provides site-wide easy password authentication for 1 user

django-pin-passcode
===================

<p align="center"><img src="https://github.com/ckcollab/django-pin-passcode/raw/master/docs/screenshot.png" alt="Django Pin Passcode Example"></p>

This is a simple app that adds a site-wide pin-passcode for quick authentication. I wrote this originally for my personal
motivation tracker [chin up](https://github.com/ckcollab/chin-up) so I could quickly login from my phone.

You enter a PIN passcode (using 0-9 and #) and when you have entered the correct pin you will be logged in as `PIN_PASSCODE_USERNAME`
and forwarded either the index or the page you were trying to request.


Installation
============

### settings.py

```python
INSTALLED_APPS += (
'pin_passcode',
)
```

```python
MIDDLEWARE_CLASSES += (
'pin_passcode.middleware.PinPasscodeMiddleware',
)
```

```python
# user to sign in as, leave blank to use a session variable instead
#PIN_PASSCODE_USERNAME = 'eric' # uncomment this to login as "eric" after valid pin code is entered
PIN_PASSCODE_PIN = 1234 # the passcode required to login as the above user, using 0-9 and '#'
```

### urls.py

```python
urlpatterns = patterns(
...
url(r'^', include('pin_passcode.urls')),
...
)
```


Testing
=======

`pip install -r requirements.txt`

`py.test`