Added the test project outline

Author: Scott Walton

README.md

@@ -27,12 +27,10 @@ depending on your user, or customise your own.
 Set the flag choices in your `settings.py` file as:
 
 ```python
-FEATURE_FLIPPER = {
-  'FEATURE_FLAGS': (
-    ('simple_feature', u'Simple Feature'),
-    ('beta_testing', u'Beta Testing'),
-  ),
-}
+FEATURE_FLIPPER_FLAGS = (
+  ('simple_feature', u'Simple Feature'),
+  ('beta_testing', u'Beta Testing'),
+)
 ```
 
 When you add features, simply add flags here and your application will be able
@@ -64,7 +62,5 @@ determining whether to show the feature to a user. The final part is to
 reference this in your `settings.py`:
 
 ```python
-FEATURE_FLIPPER = {
-  'FEATURE_MODEL': 'myapp.MyFeatureFlipper',
-}
+FEATURE_FLIPPER_MODEL = 'myapp.MyFeatureFlipper',
 ```

feature_flipper/flipper_settings.py

@@ -1,8 +1,13 @@
 from django.conf import settings
 
-FEATURE_SETTING = getattr(settings, 'FEATURE_FLIPPER', {})
-
 _DEFAULT_FEATURE_FLAGS = ()
 
-FEATURE_FLAGS = FEATURE_SETTING.get('FEATURE_FLAGS', _DEFAULT_FEATURE_FLAGS)
+FEATURE_FLIPPER_FLAGS = getattr(
+    settings, 'FEATURE_FLIPPER_FLAGS',
+    _DEFAULT_FEATURE_FLAGS)
+
 AUTH_USER_MODEL = settings.AUTH_USER_MODEL
+
+FEATURE_FLIPPER_MODEL = getattr(
+    settings, 'FEATURE_FLIPPER_MODEL',
+    'feature_flipper.FeatureFlipper')

feature_flipper/migrations/0001_initial.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.9.8 on 2016-07-21 15:34
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('auth', '0001_initial'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='FeatureFlipper',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('feature', models.CharField(choices=[(b'feature_for_all', 'Feature for everyone'), (b'restricted_feature', 'Restricted Feature')], max_length=15)),
+                ('everyone', models.BooleanField(default=False)),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'swappable': 'FEATURE_FLIPPER_MODEL',
+            },
+        ),
+    ]

feature_flipper/models.py

@@ -30,7 +30,7 @@ class AbstractFeatureFlipper(models.Model):
     objects = FeatureFlipperQuerySet.as_manager()
 
     feature = models.CharField(
-        max_length=15, choices=flipper_settings.FEATURE_FLAGS)
+        max_length=15, choices=flipper_settings.FEATURE_FLIPPER_FLAGS)
     everyone = models.BooleanField(default=False)
 
     class Meta:
@@ -45,3 +45,6 @@ class FeatureFlipper(AbstractFeatureFlipper):
     USER_FEATURE_FIELD = 'user'
 
     user = models.ForeignKey(flipper_settings.AUTH_USER_MODEL)
+
+    class Meta:
+        swappable = 'FEATURE_FLIPPER_MODEL'

setup.py

@@ -0,0 +1,14 @@
+from distutils.core import setup
+
+with open('README.md') as f:
+    LONG_DESCRIPTION = f.read()
+
+setup(
+    name='django-feature-flipper',
+    version='0.0.1',
+    packages=[
+        'feature_flipper',
+    ],
+    license='MIT',
+    long_description=LONG_DESCRIPTION,
+)

test_project/manage.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test_project.settings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

test_project/test_project/__init__.py

@@ -0,0 +1,128 @@
+"""
+Django settings for test_project project.
+
+Generated by 'django-admin startproject' using Django 1.9.8.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.9/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.9/ref/settings/
+"""
+
+import os
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/1.9/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = '+1*a^vzlm&_^xlf_-r9#as5m8j)w9q$o+8b@5uumcna@oy3#q='
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+
+    'feature_flipper',
+]
+
+MIDDLEWARE_CLASSES = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'test_project.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'test_project.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.9/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/1.9/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/1.9/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/1.9/howto/static-files/
+
+STATIC_URL = '/static/'
+
+FEATURE_FLIPPER_FLAGS = (
+    ('feature_for_all', u'Feature for everyone'),
+    ('restricted_feature', u'Restricted Feature'),
+)

test_project/test_project/settings.py

@@ -0,0 +1,21 @@
+"""test_project URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/1.9/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  url(r'^$', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  url(r'^$', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.conf.urls import url, include
+    2. Add a URL to urlpatterns:  url(r'^blog/', include('blog.urls'))
+"""
+from django.conf.urls import url
+from django.contrib import admin
+
+urlpatterns = [
+    url(r'^admin/', admin.site.urls),
+]

test_project/test_project/urls.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for test_project project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.9/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test_project.settings")
+
+application = get_wsgi_application()