initial version

Author: jsatt

COPYING

@@ -0,0 +1,41 @@
+{{project_name}}
+=====================
+
+This project was started with the Django installable plugin template. This has created a development environment that does not require an entire django deployment to develop and test an installable module. The following instructions will be useful for anyone developing this project.
+
+Using the development environment
+---------------------------------
+Install requirements
+
+    pip install fabric
+    pip install -r requirements.txt
+
+Setup db
+
+    fab syncdb
+    fab migrate
+
+Start server
+
+    fab serve
+
+Using the Python shell
+
+    fab shell
+
+Running tests
+
+    fab test
+
+Creating South schema migrations
+
+    fab schema
+    fab migrate
+
+
+
+#REPLACE EVERYTHING AFTER THIS WITH YOUR INFO#
+
+Django installable plugin template
+Copyright 2013 Jeremy Satterfield
+Licensed under GPLv3 see COPYING for license

README.md

@@ -0,0 +1,51 @@
+"""
+Creating standalone Django apps is a PITA because you're not in a project, so
+you don't have a settings.py file.  I can never remember to define
+DJANGO_SETTINGS_MODULE, so I run these commands which get the right env
+automatically.
+"""
+import functools
+import os
+
+from fabric.api import local as _local
+
+
+NAME = os.path.basename(os.path.dirname(__file__))
+ROOT = os.path.abspath(os.path.dirname(__file__))
+APP_NAME = '{{project_name}}'
+
+os.environ['DJANGO_SETTINGS_MODULE'] = 'test_app.settings'
+os.environ['PYTHONPATH'] = os.pathsep.join([ROOT,])
+
+_local = functools.partial(_local, capture=False)
+
+
+def shell():
+    """Start a Django shell with the test settings."""
+    _local('django-admin.py shell')
+
+
+def test():
+    """Run the test suite."""
+    _local('django-admin.py test')
+
+
+def serve():
+    """Start the Django dev server."""
+    _local('django-admin.py runserver')
+
+
+def syncdb():
+    """Create a database for testing in the shell or server."""
+    _local('django-admin.py syncdb')
+
+
+def schema():
+    """Create a schema migration for any changes."""
+    _local('django-admin.py schemamigration %s --auto' % APP_NAME)
+
+
+def migrate():
+    """Update a testing database with south."""
+    _local('django-admin.py migrate')
+

__init__.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

fabfile.py

@@ -0,0 +1,17 @@
+"""
+This file demonstrates writing tests using the unittest module. These will pass
+when you run "manage.py test".
+
+Replace this with more appropriate tests for your application.
+"""
+
+from django.test import TestCase
+
+
+class SimpleTest(TestCase):
+    def test_basic_addition(self):
+        """
+        Tests that 1 + 1 always equals 2.
+        """
+        self.assertEqual(1 + 1, 2)
+

project_name/__init__.py

@@ -0,0 +1 @@
+# Create your views here.

project_name/models.py

@@ -0,0 +1,9 @@
+pip>=0.8.2
+South
+Django=>1.4
+
+# install these if you intend to develop
+#mox
+#nose
+#django-nose
+#fabric

project_name/tests.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from setuptools import setup
+
+setup(name='django-{{project_name}}',
+      version='0.0.1',
+      description='',
+      author='Your Name Here',
+      author_email='Email',
+      #url='',
+      #license='',
+      packages=[
+          '{{project_name}}', '{{project_name}}.migrations'],
+      install_requires=[
+          'South',
+          'Django>=1.5',],
+      classifiers=[
+          'Development Status :: 4 - Beta',
+          'Environment :: Web Environment',
+          'Framework :: Django',
+          'Intended Audience :: End Users/Desktop',
+          'Programming Language :: Python',],
+     )

project_name/views.py

@@ -0,0 +1,31 @@
+DEBUG = True
+TEMPLATE_DEBUG = DEBUG
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': 'test.db',
+    }
+}
+USE_TZ = False
+SITE_ID = 1
+SECRET_KEY = '{{secret_key}}'
+
+ROOT_URLCONF = 'test_app.urls'
+STATIC_URL = '/static/'
+
+INSTALLED_APPS = (
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.sites',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'django_nose',
+    'south',
+    '{{project_name}}',
+)
+
+TEST_RUNNER = 'django_nose.NoseTestSuiteRunner'
+NOSE_ARGS = ('--nocapture', )

requirements.txt

@@ -0,0 +1,22 @@
+from django.conf.urls import patterns, include, url
+from django.contrib.staticfiles.urls import staticfiles_urlpatterns
+
+# Uncomment the next two lines to enable the admin:
+from django.contrib import admin
+admin.autodiscover()
+
+urlpatterns = patterns('',
+    # Examples:
+    # url(r'^$', 'podcast_client.views.home', name='home'),
+    # url(r'^podcast_client/', include('podcast_client.foo.urls')),
+
+    # Uncomment the admin/doc line below to enable admin documentation:
+    # url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
+
+    # Uncomment the next line to enable the admin:
+    # url(r'^admin/', include(admin.site.urls)),
+
+    url(r'^{{project_name}}/',
+        include('{{project_name}}.urls', '{{project_name}}')),
+)
+urlpatterns += staticfiles_urlpatterns()