Commits

Artur Barseghyan committed 4e232fd Draft

example app

Comments (0)

Files changed (13)

example/example/__init__.py

Empty file added.

example/example/foo/__init__.py

Empty file added.

example/example/foo/admin.py

+from django.contrib import admin
+from django.utils.translation import ugettext_lazy as _
+
+from tinymce.models import HTMLField
+from tinymce.widgets import TinyMCE
+
+from foo.models import FooItem, FooCategory
+
+
+class FooCategoryAdmin(admin.ModelAdmin):
+    list_display = ('name',)
+    prepopulated_fields = {'slug': ('name',)}
+
+    class Meta:
+        app_label = _('Foo item')
+
+admin.site.register(FooCategory, FooCategoryAdmin)
+
+
+class FooItemAdmin(admin.ModelAdmin):
+    """
+    Foo item admin.
+    """
+    list_display = ('title', 'date_published')
+    prepopulated_fields = {'slug': ('title',)}
+
+    readonly_fields = ('date_created', 'date_updated', )
+
+    filter_horizontal = ('authors', 'categories')
+
+    fieldsets = (
+        (None, {
+            'fields': ('title', 'teaser', 'body')
+        }),
+        (_("Categories"), {
+            'classes': ('',),
+            'fields': ('category', 'categories')
+        }),
+        (_("Staff"), {
+            'classes': ('',),
+            'fields': ('editor', 'authors')
+        }),
+        (_("Publication date"), {
+            'classes': ('',),
+            'fields': ('date_published',)
+        }),
+        (_("Additional"), {
+            'classes': ('collapse',),
+            'fields': ('slug', 'date_created', 'date_updated') #,
+        })
+    )
+
+    formfield_overrides = {
+        HTMLField: {'widget': TinyMCE()},
+    }
+
+    class Meta:
+        app_label = _('Foo item')
+
+admin.site.register(FooItem, FooItemAdmin)

example/example/foo/models.py

+import datetime
+
+from django.db import models
+from django.utils.translation import ugettext_lazy as _
+from django.contrib.auth.models import User
+
+from tinymce.models import HTMLField
+
+
+class FooCategory(models.Model):
+    """
+    Foo category.
+    """
+    name = models.CharField(_("Title"), max_length=100)
+    slug = models.SlugField(_("Slug"), unique=True)
+
+    class Meta:
+        verbose_name = _("Foo category")
+        verbose_name_plural = _("Foo categories")
+
+    def __unicode__(self):
+        return self.name
+
+
+class FooItem(models.Model):
+    """
+    Foo item.
+    """
+    title = models.CharField(_("Title"), max_length=100)
+    slug = models.SlugField(_("Slug"), unique=True)
+    teaser = models.TextField(_("Teaser"))
+    body = HTMLField(_("Body"))
+    date_published = models.DateTimeField(_("Date published"), blank=True, null=True, default=datetime.datetime.now())
+    category = models.ForeignKey(FooCategory, verbose_name=_("Category"), related_name='category')
+    categories = models.ManyToManyField(FooCategory, verbose_name=_("Category"), related_name='categories')
+
+    editor = models.ForeignKey(User, null=True, blank=True, related_name='editor')
+    authors = models.ManyToManyField(User, null=True, blank=True, related_name='authors')
+
+    date_created = models.DateTimeField(_("Date created"), blank=True, null=True, auto_now_add=True, editable=False)
+    date_updated = models.DateTimeField(_("Date updated"), blank=True, null=True, auto_now=True, editable=False)
+
+    class Meta:
+        verbose_name = _("Foo item")
+        verbose_name_plural = _("Foo items")
+
+    def __unicode__(self):
+        return self.title

example/example/foo/reports.py

+from django.utils.html import strip_tags
+
+import sirep
+
+from foo.models import FooItem
+
+# Define the report class
+class FooReport(sirep.Report):
+    verbose_name = 'Test report'
+    fields = [u'ID', u'Title', u'Editor', u'Authors', u'Main category', u'Categories', u'Date published',
+              u'Character count body']
+    items = []
+    limit = 200
+    date_field = 'date_published'
+    queryset = FooItem._default_manager.filter().select_related('editor', 'category') \
+                      .prefetch_related('categories', 'authors')
+
+    get_user_info = lambda u: "%s <%s>" % ((u.get_full_name() if u.get_full_name() else u.username), u.email)
+    get_users_info = lambda uu: ','.join([get_user_info(u) for u in uu])
+    
+
+    def process_data(self):
+        queryset = self.get_queryset()
+
+        self.items = []
+        for a in queryset:
+            self.items.append([
+                a.pk,
+                a.title,
+                self.get_user_info(self.editor),
+                self.get_users_info(self.authors),
+                self.category,
+                ', '.join([c.name for c in self.categories]),
+                self.date_published,
+                len(strip_tags(self.body)),
+                ])
+
+# Register the report
+sirep.register('foo-report', FooReport)

example/example/local_settings.example

+# Django settings for resato_portal project.
+import os
+PROJECT_DIR = lambda base : os.path.abspath(os.path.join(os.path.dirname(__file__), base).replace('\\','/'))
+
+DEBUG = True
+DEBUG_TOOLBAR = True
+TEMPLATE_DEBUG = DEBUG
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
+        'NAME': PROJECT_DIR('../db/example.db'),                      # Or path to database file if using sqlite3.
+        # The following settings are not used with sqlite3:
+        'USER': '',
+        'PASSWORD': '',
+        'HOST': '',                      # Empty for localhost through domain sockets or '127.0.0.1' for localhost through TCP.
+        'PORT': '',                      # Set to empty string for default.
+    }
+}
+
+INTERNAL_IPS = ('127.0.0.1',)
+
+EMAIL_BACKEND = 'django.core.mail.backends.filebased.EmailBackend'
+EMAIL_FILE_PATH = PROJECT_DIR('../tmp')
+
+DEFAULT_FROM_EMAIL = '<no-reply@example.com>'

example/example/manage.py

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

example/example/settings.py

+# Django settings for example project.
+import os
+PROJECT_DIR = lambda base : os.path.abspath(os.path.join(os.path.dirname(__file__), base).replace('\\','/'))
+gettext = lambda s: s
+
+DEBUG = False
+DEBUG_TOOLBAR = False
+TEMPLATE_DEBUG = DEBUG
+
+ADMINS = (
+    # ('Your Name', 'your_email@example.com'),
+)
+
+MANAGERS = ADMINS
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
+        'NAME': PROJECT_DIR('../db/example.db'),                      # Or path to database file if using sqlite3.
+        # The following settings are not used with sqlite3:
+        'USER': '',
+        'PASSWORD': '',
+        'HOST': '',                      # Empty for localhost through domain sockets or '127.0.0.1' for localhost through TCP.
+        'PORT': '',                      # Set to empty string for default.
+    }
+}
+
+# Hosts/domain names that are valid for this site; required if DEBUG is False
+# See https://docs.djangoproject.com/en/1.5/ref/settings/#allowed-hosts
+ALLOWED_HOSTS = []
+
+# Local time zone for this installation. Choices can be found here:
+# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
+# although not all choices may be available on all operating systems.
+# In a Windows environment this must be set to your system time zone.
+TIME_ZONE = 'America/Chicago'
+
+# Language code for this installation. All choices can be found here:
+# http://www.i18nguy.com/unicode/language-identifiers.html
+LANGUAGE_CODE = 'en-us'
+
+SITE_ID = 1
+
+# If you set this to False, Django will make some optimizations so as not
+# to load the internationalization machinery.
+USE_I18N = True
+
+# If you set this to False, Django will not format dates, numbers and
+# calendars according to the current locale.
+USE_L10N = True
+
+# If you set this to False, Django will not use timezone-aware datetimes.
+USE_TZ = True
+
+# Absolute filesystem path to the directory that will hold user-uploaded files.
+# Example: "/var/www/example.com/media/"
+MEDIA_ROOT = PROJECT_DIR('../media')
+
+# URL that handles the media served from MEDIA_ROOT. Make sure to use a
+# trailing slash.
+# Examples: "http://example.com/media/", "http://media.example.com/"
+MEDIA_URL = '/media/'
+
+# Absolute path to the directory static files should be collected to.
+# Don't put anything in this directory yourself; store your static files
+# in apps' "static/" subdirectories and in STATICFILES_DIRS.
+# Example: "/var/www/example.com/static/"
+STATIC_ROOT = PROJECT_DIR('../static')
+
+# URL prefix for static files.
+# Example: "http://example.com/static/", "http://static.example.com/"
+STATIC_URL = '/static/'
+
+# Additional locations of static files
+STATICFILES_DIRS = (
+    # Put strings here, like "/home/html/static" or "C:/www/django/static".
+    # Always use forward slashes, even on Windows.
+    # Don't forget to use absolute paths, not relative paths.
+    PROJECT_DIR('../media/static'),
+)
+
+# List of finder classes that know how to find static files in
+# various locations.
+STATICFILES_FINDERS = (
+    'django.contrib.staticfiles.finders.FileSystemFinder',
+    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
+#    'django.contrib.staticfiles.finders.DefaultStorageFinder',
+)
+
+# Make this unique, and don't share it with anybody.
+SECRET_KEY = '6sf18c*w971i8a-m^1coasrmur2k6+q5_kyn*)s@(*_dk5q3&r'
+
+# List of callables that know how to import templates from various sources.
+TEMPLATE_LOADERS = (
+    'django.template.loaders.filesystem.Loader',
+    'django.template.loaders.app_directories.Loader',
+    'django.template.loaders.eggs.Loader',
+)
+
+MIDDLEWARE_CLASSES = (
+    'django.middleware.common.CommonMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    # Uncomment the next line for simple clickjacking protection:
+    # 'django.middleware.clickjacking.XFrameOptionsMiddleware',
+)
+
+ROOT_URLCONF = 'urls'
+
+# Python dotted path to the WSGI application used by Django's runserver.
+WSGI_APPLICATION = 'wsgi.application'
+
+TEMPLATE_DIRS = (
+    # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
+    # Always use forward slashes, even on Windows.
+    # Don't forget to use absolute paths, not relative paths.
+    PROJECT_DIR('templates')
+)
+
+INSTALLED_APPS = (
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.sites',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    # Uncomment the next line to enable the admin:
+    'django.contrib.admin',
+    # Uncomment the next line to enable admin documentation:
+    # 'django.contrib.admindocs',
+
+    'sirep',
+
+    'foo', # Our example app
+)
+
+# django-lime conf
+LIME_SITE_LOGO = ''
+LIME_SITE_TEAM = ''
+
+# A sample logging configuration. The only tangible logging
+# performed by this configuration is to send an email to
+# the site admins on every HTTP 500 error when DEBUG=False.
+# See http://docs.djangoproject.com/en/dev/topics/logging for
+# more details on how to customize your logging configuration.
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'filters': {
+        'require_debug_false': {
+            '()': 'django.utils.log.RequireDebugFalse'
+        }
+    },
+    'handlers': {
+        'mail_admins': {
+            'level': 'ERROR',
+            'filters': ['require_debug_false'],
+            'class': 'django.utils.log.AdminEmailHandler'
+        }
+    },
+    'loggers': {
+        'django.request': {
+            'handlers': ['mail_admins'],
+            'level': 'ERROR',
+            'propagate': True,
+        },
+    }
+}
+
+
+# Do not put any settings below this line
+try:
+    from local_settings import *
+except:
+    pass
+
+if DEBUG and DEBUG_TOOLBAR:
+    # debug_toolbar
+    MIDDLEWARE_CLASSES += (
+        'debug_toolbar.middleware.DebugToolbarMiddleware',
+	)
+
+    INSTALLED_APPS += (
+        'debug_toolbar',
+    )
+
+    DEBUG_TOOLBAR_CONFIG = {
+        'INTERCEPT_REDIRECTS': False,
+    }

example/example/urls.py

+from django.conf.urls import patterns, include, url
+
+# Uncomment the next two lines to enable the admin:
+from django.contrib import admin
+
+import sirep
+
+admin.autodiscover()
+sirep.autodiscover()
+
+urlpatterns = patterns('',
+    # Examples:
+    # url(r'^$', 'example.views.home', name='home'),
+
+    # 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)),
+
+    (r'^sirep/', include('sirep.urls')),
+)

example/example/wsgi.py

+"""
+WSGI config for example project.
+
+This module contains the WSGI application used by Django's development server
+and any production WSGI deployments. It should expose a module-level variable
+named ``application``. Django's ``runserver`` and ``runfcgi`` commands discover
+this application via the ``WSGI_APPLICATION`` setting.
+
+Usually you will have the standard Django WSGI application here, but it also
+might make sense to replace the whole Django WSGI application with a custom one
+that later delegates to the Django one. For example, you could introduce WSGI
+middleware here, or combine a Django application with an application of another
+framework.
+
+"""
+import os
+
+# We defer to a DJANGO_SETTINGS_MODULE already in the environment. This breaks
+# if running multiple sites in the same mod_wsgi process. To fix this, use
+# mod_wsgi daemon mode with each site in its own daemon process, or use
+# os.environ["DJANGO_SETTINGS_MODULE"] = "example.settings"
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.settings")
+
+# This application object is used by any WSGI server configured to use this
+# file. This includes Django's development server, if the WSGI_APPLICATION
+# setting points here.
+from django.core.wsgi import get_wsgi_application
+application = get_wsgi_application()
+
+# Apply WSGI middleware here.
+# from helloworld.wsgi import HelloWorldApplication
+# application = HelloWorldApplication(application)

example/readme.rst

+Installation
+============================
+pip install -r requirements.txt
+
+./manage.py syncdb

example/requirements.txt

+Django==1.5.1
+Pillow==2.0.0
+argparse==1.2.1
+django-autoslug==1.6.1
+django-debug-toolbar==0.9.4
+django-tinymce==1.5.1
+wsgiref==0.1.2
 
     $ pip install sirep
 
+Or, eventually, the latest development version
+
+    $ pip install -e hg+https://bitbucket.org/barseghyanartur/sirep#egg=sirep
+
 2. Add 'sirep' to your ``INSTALLED_APPS``:
 
     >>> INSTALLED_APPS = (