Skip to content
This repository has been archived by the owner on May 14, 2024. It is now read-only.

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
docs
  • Loading branch information
adrianmaurer committed Apr 21, 2015
1 parent a82d793 commit f676ba7
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.rst
Expand Up @@ -87,6 +87,18 @@ If something ever goes wrong - a request times out, the ``sixpack`` server disap
calls will return the control alternative, and all ``convert`` calls will seem successful (and we'll note this happend
in the log).

-----------------
Tracking Locally
-----------------

By passing in the argument `local` in the SixpackTest constructor you can tell the django-sixpack to create a db record for each participant.

.. code:: python
experiment = ButtonColorTest(local=True)
Make sure you run a migration for the django-sixpack's `SixpackParticipant` model.

Suported Versions
-----------------

Expand Down
3 changes: 2 additions & 1 deletion setup.py
@@ -1,6 +1,6 @@
from setuptools import setup, find_packages

install_reqs = ["Django>=1.4", "sixpack-client==1.1.1"]
install_reqs = ["Django>=1.4"]

setup(
name='django-sixpack',
Expand All @@ -15,6 +15,7 @@
description='A django-friendly wrapper for sixpack-py',
long_description=open('README.rst').read(),
install_requires=install_reqs,
dependency_links=["https://github.com/seatgeek/sixpack-py/archive/master.zip"],
tests_require=install_reqs + ["mock==1.0.1"],
test_suite='runtests.runtests',
classifiers=(
Expand Down

0 comments on commit f676ba7

Please sign in to comment.