Documentation / release note for #12

torchbox · Nov 28, 2018 · e0851bc · e0851bc
1 parent 867c0c9
commit e0851bc
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
@@ -5,7 +5,7 @@ Changelog
 ~~~~~~~~~~~~~~~~~~
 
  * Add support for Wagtail 1.8 - 2.3 and Django 1.11 - 2.1
-
+ * Added experiment-data management command
 
 0.1.2 (10.11.2016)
 ~~~~~~~~~~~~~~~~~~

diff --git a/README.rst b/README.rst
@@ -106,3 +106,17 @@ Returns report data for ``experiment``, consisting of a dict containing:
 
   ``history``
     A list of dicts showing the breakdown of participants and completions over time; each dict contains ``date``, ``participant_count`` and ``completion_count``.
+
+
+Test data
+---------
+
+wagtail-experiments provides a management command ``experiment-data``, to allow populating an experiment with dummy data for testing or demonstration purposes, and purging existing data. This command is called with the experiment's slug::
+
+    # Populate the experiment 'homepage-banner' with 5 days of test data,
+    # with 100-200 views per variation. All parameters other than experiment slug
+    # are optional
+    ./manage.py experiment-data homepage-banner --days 5 --min=100 --max=200
+
+    # Purge data for the experiment 'homepage-banner'
+    ./manage.py experiment-data homepage-banner --purge