add instructions for demo app

Author: merwok

README.md

@@ -21,5 +21,7 @@ a set of Django apps to include and configure in your settings, but a
 collection of mixins, base classes, base views and simple templates
 that you can integrate and customize in your own apps.
 
+See the [demo](demo/) app for example usage.
+
 ⚠️ This library is not stable yet, make sure to pin your dependencies.
 Recommended form: `rest-framework-auth-toolkit == 0.9.*`

demo/README.md

@@ -0,0 +1,40 @@
+# Demo application for Rest-Framework-Auth-Toolkit
+
+This is a minimal Django project that shows how to use
+the package and helps checking if changes break usage.
+
+## How to install
+
+Run this command once from the repository root:
+
+```
+python setup-develop.py develop
+```
+
+This makes the package `rest_auth_toolkit` importable by the demo app,
+with local changes immediately seen.
+
+Go in the `demo` directory and install the other dependencies:
+
+```
+pip install -r requirements.txt
+```
+
+# How to run
+
+Define the environment variables needed by the app:
+
+```
+export DEMO_FACEBOOK_APP_ID="..."
+export DEMO_FACEBOOK_SECRET_KEY="..."
+```
+
+(using a [virtualenvwrapper hook](https://virtualenvwrapper.readthedocs.io/en/latest/scripts.html#postactivate)
+or a `.env` file with [direnv](https://direnv.net/) is a good ideae to make this automatic)
+
+You can then run Django commands:
+
+```
+python manage.py migrate
+python manage.py runserver
+```

demo/requirements.in

@@ -7,10 +7,11 @@ django-debug-toolbar
 django-model-utils
 django-shortuuidfield
 
-# Note: rest-framework-auth-toolkit is not here, it should already
-# be importable if you do "pip install -e ." from your dev virtualenv.
-# We do include facepy here to make sure requirements.txt
-# contains all transitive dependencies.
+# TODO add develop install for rest-framework-auth-toolkit
+# (when pip supports PEP 517); see README for how to install rest-auth-toolkit
+#-e ..[facebook]
+# In the meantime we include facepy here to make sure requirements.txt
+# contains all transitive dependencies
 facepy
 
 # for the browsable API

setup-develop.py

@@ -0,0 +1,8 @@
+from setuptools import setup
+
+import rest_auth_toolkit
+
+setup(
+    name='Rest-Framework-Auth-Toolkit',
+    version=rest_auth_toolkit.__version__,
+)