Add example app

Author: lundberg

.gitignore

@@ -58,3 +58,6 @@ target/
 
 # Pycharm:
 .idea
+
+# Database
+*.sqlite3

Dockerfile

@@ -0,0 +1,19 @@
+FROM python:3
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y \
+        gettext && \
+    pip install Django
+
+# Install bananas source
+WORKDIR /usr/src
+COPY . django-bananas
+RUN pip install -e django-bananas && \
+    rm -rf /usr/src/django-bananas/example && \
+    mkdir /app
+    
+# Install example app
+WORKDIR /app
+COPY example ./
+
+ENTRYPOINT ["python3", "manage.py"]

Makefile

@@ -22,9 +22,17 @@ install:
 develop:
 	python setup.py develop
 
+.PHONY: example
+example:
+	docker-compose up -d
+	docker-compose run --rm django migrate --no-input
+	docker-compose run --rm django createsuperuser \
+		--username admin \
+		--email [email protected]
+
 .PHONY: clean
 clean:
-	rm -rf dist/ *.egg *.egg-info .coverage .coverage.*
+	rm -rf dist/ *.egg *.egg-info .coverage .coverage.* example/db.sqlite3
 
 .PHONY: all  # runs clean, test, lint
 all: clean test lint

docker-compose.yml

@@ -0,0 +1,13 @@
+version: "3.3"
+
+services:
+  django:
+    build: .
+    command: ["runserver", "0.0.0.0:8000"]
+    stdin_open: true
+    tty: true
+    ports:
+      - "8000:8000"
+    volumes:
+      - ./bananas:/usr/src/django-bananas/bananas
+      - ./example:/app

example/example/__init__.py

@@ -0,0 +1,125 @@
+"""
+Django settings for example project.
+
+Generated by 'django-admin startproject' using Django 1.11.5.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.11/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.11/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.11/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = ')-9=nktek1%^x7tvw5bttxhz&_ke+q=b%c@m@u13d#_y=5z+kx'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = ['*']
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    # 'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+
+    'bananas',
+
+    'django.contrib.admin',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+SESSION_ENGINE = 'django.contrib.sessions.backends.signed_cookies'
+
+ROOT_URLCONF = 'example.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 = 'example.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.11/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.11/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.11/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.11/howto/static-files/
+
+STATIC_URL = '/static/'

example/example/settings.py

@@ -0,0 +1,21 @@
+"""example URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/1.11/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 bananas import admin
+
+urlpatterns = [
+    url(r'^', admin.site.urls),
+]

example/example/urls.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for example 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.11/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.settings")
+
+application = get_wsgi_application()

example/example/wsgi.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError:
+        # The above import may fail for some other reason. Ensure that the
+        # issue is really that Django is missing to avoid masking other
+        # exceptions on Python 2.
+        try:
+            import django
+        except ImportError:
+            raise ImportError(
+                "Couldn't import Django. Are you sure it's installed and "
+                "available on your PYTHONPATH environment variable? Did you "
+                "forget to activate a virtual environment?"
+            )
+        raise
+    execute_from_command_line(sys.argv)

example/manage.py

@@ -20,7 +20,7 @@
     long_description=long_description,
     url='https://github.com/5monkeys/django-bananas',
     version=__import__('bananas').__version__,
-    packages=find_packages(exclude=['tests', '_*']),
+    packages=find_packages(exclude=['tests', '_*', 'example']),
     include_package_data=True,
     zip_safe=False,
     install_requires=[],