/django-castle

Django integration with the castle.io service

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

django-castle

A django integration for the castle.io service

Documentation

Using the http://castle.io service this package allows for simple user tracking.

Quickstart

Install django-castle:

pip install django-castle

Then use it in a project:

  1. Add the package django_castle to settings.INSTALLED_APPS

  2. Set the following setting variables:

    CASTLE_API_KEY = "your key"
    CASTLE_API_SECRET = "your secret"
    
  3. Add the {% load castle %} template tag on the top of your templates where you want to track users

  4. Add the following tags to the templates in the bottom of the head:

    {% castle_load user=request.user secure=True track=True %}
    

Features

  • API wrapper
  • Settings for API Key and Secret
  • Hook for the login and logout signals
  • template tags for user tracking

Cookiecutter Tools Used in Making This Package

  • cookiecutter
  • cookiecutter-djangopackage