Skip to content

I
insights
Commit 51fb6572 by brianhw
Options

Merge pull request #14 from edx/brian/datajam-example 

Brian/datajam example
parents 36622a8c 5f55e3a8
Showing with 361 additions and 0 deletions
example/src/datajam/datajam/settings.py 0 → 100644
# Django settings for datajam project.
# Django settings for edxanalytics project.
#### edinsights-specific settings
import datetime
import os.path
import path
import sys
import imp
from pkg_resources import resource_filename
DJ_REQUIRED_APPS = (
'djeventstream.httphandler',
'south',
'edinsights.core',
'edinsights.modulefs',
)
# Types of parameters that queries and views can take.
# This is not properly used yet.
DJANALYTICS_PARAMETERS = ['user', 'filename']
DJFS = { 'type' : 'osfs',
'directory_root' : '/tmp/djfsmodule',
'url_root' : 'file:///tmp/'
}
TIME_BETWEEN_DATA_REGENERATION = datetime.timedelta(minutes=1)
INSTALLED_ANALYTICS_MODULES = [
'modules.dump_to_db',
'modules.instructor_dash',
]
print INSTALLED_ANALYTICS_MODULES
SNS_SUBSCRIPTIONS = []
# to require all edinsights URLs to have a login, add the following:
# import django.contrib.auth.decorators
# DJA_AUTH = { '.*' : django.contrib.auth.decorators.login_required }
MAKO_MODULE_DIR = '../../compiled_templates' # TODO: Use pkg_resources.resource_filename
DEBUG = True
TEMPLATE_DEBUG = DEBUG
ADMINS = (
# ('Your Name', 'your_email@example.com'),
)
MANAGERS = ADMINS
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3', # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
'NAME': '../../localdb.sql', # TODO: Use pkg_resources.resource_filename
'USER': '', # Not used with sqlite3.
'PASSWORD': '', # Not used with sqlite3.
'HOST': '', # Set to empty string for localhost. Not used with sqlite3.
'PORT': '', # Set to empty string for default. Not used with sqlite3.
}
}
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
'LOCATION': 'analytics-experiments'
}
}
# 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: "/home/media/media.lawrence.com/media/"
MEDIA_ROOT = ''
# URL that handles the media served from MEDIA_ROOT. Make sure to use a
# trailing slash.
# Examples: "http://media.lawrence.com/media/", "http://example.com/media/"
MEDIA_URL = ''
# 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: "/home/media/media.lawrence.com/static/"
STATIC_ROOT = ''
# URL prefix for static files.
# Example: "http://media.lawrence.com/static/"
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.
)
# 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 = 'v9+anmn#pu&@h^fmj^(qcb8cc@!rm3t)uq$_&fg4i@k94*lclk'
# 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 = 'datajam.urls'
# Python dotted path to the WSGI application used by Django's runserver.
WSGI_APPLICATION = 'datajam.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.
)
INSTALLED_APPS = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.messages',
'django.contrib.staticfiles',
'datajam',
) + DJ_REQUIRED_APPS
# 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,
},
}
}
example/src/datajam/datajam/static/intro.html 0 → 100644
<html>
<head><title>It's running!</title></head>
<body>
<h1> The Datajam Insights application is running.</h1>
<p> If a datajam LMS is also running, it should be sending events that
an event handler in the datajam Insights will store in a mongo
database.
<p> To verify, connect to the database, and see what events are there:
<pre>
$ mongo
MongoDB shell version: 2.0.4
connecting to: test
> show dbs
...
modules_dump_to_db
...
> use modules_dump_to_db
switched to db modules_dump_to_db
> show collections
event_log
system.indexes
> db.event_log.find()
[ should show all events sent to database ]
</pre>
<p> Query connectivity may be checked by going to the datajam LMS,
logging in as an instructor of a course (such as the demo course),
navigating to the analytics tab of the instructor dash, and verifying
that fabricated data from Insights appears there.
</body>
</html>
example/src/datajam/datajam/urls.py 0 → 100644
from django.conf.urls import patterns, include, url
# Uncomment the next two lines to enable the admin:
# from django.contrib import admin
# admin.autodiscover()
urlpatterns = patterns('',
url(r'^$', 'datajam.views.home', name='home'),
url('^', include('edinsights.core.urls')),
url(r'^httpevent$', 'djeventstream.httphandler.views.http_view'),
# 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)),
)
import edinsights.core.views
example/src/datajam/datajam/views.py 0 → 100644
from django.shortcuts import redirect
def home(request):
return redirect('/static/intro.html')
example/src/datajam/datajam/wsgi.py 0 → 100644
"""
WSGI config for mongolog 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
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "datajam.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/src/datajam/manage.py 0 → 100644
#!/usr/bin/env python
import os
import sys
if __name__ == "__main__":
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "datajam.settings")
from django.core.management import execute_from_command_line
execute_from_command_line(sys.argv)
example/src/datajam/modules/dump_to_db.py 0 → 100644
from edinsights.core.decorators import event_handler
@event_handler()
def dump_to_db(mongodb, events):
## TODO: Error handling
collection = mongodb['event_log']
collection.insert([e.event for e in events])
example/src/datajam/modules/instructor_dash.py 0 → 100644
import json
from edinsights.core.decorators import query
@query()
def analytics_get(aname, course_id, apikey):
'''
Dummy analytics for the analytics tab on the LMS instructor dashboard.
'''
# return a timestamp indicating when the data was calculated
retval = {'time': 'fabricated today'}
if aname == "StudentsEnrolled":
# num students enrolled
retval['data'] = [{'students': '3000'}]
elif aname == "StudentsActive":
# num students active in time period (default = 1wk)
retval['data'] = [{'active': '300'}]
elif aname == "StudentsDropoffPerDay":
# active students dropoff by day
retval['data'] = [
{'last_day': '20131027T0910', 'num_students': '700'},
{'last_day': '20131028T0910', 'num_students': '500'},
{'last_day': '20131029T0910', 'num_students': '300'},
{'last_day': '20131030T0910', 'num_students': '200'},
]
elif aname == "ProblemGradeDistribution":
# foreach problem, grade distribution
retval['data'] = [
{
'module_id': 'blah/blah/module1',
'grade_info': [
{'max_grade': '10', 'grade': '10', 'num_students': '10'},
{'max_grade': '20', 'grade': '20', 'num_students': '12'},
{'max_grade': '30', 'grade': '30', 'num_students': '11'},
],
},
{
'module_id': 'blah/blah/module2',
'grade_info': [
{'max_grade': '10', 'grade': '10', 'num_students': '8'},
{'max_grade': '20', 'grade': '20', 'num_students': '11'},
{'max_grade': '30', 'grade': '30', 'num_students': '15'},
],
},
]
# These are not currently displayed by the analytics dash:
# if aname == "OverallGradeDistribution", # overall point distribution for course
# if aname == "StudentsPerProblemCorrect", # foreach problem, num students correct
# if aname == "StudentsAttemptedProblems", # num students who tried given problem
# elif aname == "StudentsDailyActivity": # active students by day
return json.dumps(retval)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment