Improved setup

.gitignore

@@ -16,6 +16,7 @@ build
 dev.db
 include
 lib
+local
 secret.txt
 settings_local.py
 settings-*.py

README.md

@@ -0,0 +1,15 @@
+## Installation
+Editors' Notes requires Python 2.7 and PostgreSQL.
+
+To set up a local development environment, install [Fabric](http://fabfile.org/) 
+and make sure you have the following dependencies
+
+* libxml2
+* libxslt
+* psycopg2
+* [Xapian](http://xapian.org/download) with Python bindings
+
+1. Run the command `fab setup` inside the project directory
+2. Edit the generated "editorsnotes/settings\_local.py" file with your database information
+3. Run `fab sync_database`
+4. Start the development server with `fab runserver`

editorsnotes/example-settings_local.py

@@ -0,0 +1,59 @@
+######################
+# Required variables #
+######################
+
+SECRET_KEY = ''
+POSTGRES_DB = {
+    'NAME': '',
+    'USER': '',
+    'PASSWORD': '',
+    'HOST': '',
+    'PORT': ''
+}
+SITE_URL = '127.0.0.1'
+
+DEBUG = True
+TEMPLATE_DEBUG = DEBUG
+
+ADMINS = (
+    ('My Name', '[email protected]'),
+)
+MANAGERS = ADMINS
+
+
+#############
+# Overrides #
+#############
+
+# TIME_ZONE = ''
+# LANGUAGE_CODE = ''
+# DATETIME_FORMAT = ''
+# USE_L10N = True
+# USE I18N = True
+
+
+# Edit STORAGE_PATH to change where uploads, static files, and search indexes
+# will be stored, or change each of the settings individually.
+# STORAGE_PATH = ''
+
+# MEDIA_ROOT = ''
+# STATIC_ROOT = ''
+# HAYSTACK_XAPIAN_PATH = ''
+
+
+######################
+# Optional variables #
+######################
+
+# Set the following variables to connect to an instance of Open Refine and
+# enable clustering topics and documents.
+GOOGLE_REFINE_HOST = '127.0.0.1'
+GOOGLE_REFINE_PORT = '3333'
+
+# Set the following to be able to write all Zotero data to a central library.
+ZOTERO_API_KEY = ''
+ZOTERO_LIBRARY = ''
+
+# Define locally installed apps here
+LOCAL_APPS = (
+)

editorsnotes/main/migrations/0001_initial.py

@@ -13,7 +13,7 @@ def forwards(self, orm):
             ('last_updated', self.gf('django.db.models.fields.DateTimeField')(auto_now=True, blank=True)),
             ('created', self.gf('django.db.models.fields.DateTimeField')(auto_now_add=True, blank=True)),
             ('creator', self.gf('django.db.models.fields.related.ForeignKey')(related_name='created_note_set', to=orm['auth.User'])),
-            ('content', self.gf('main.fields.XHTMLField')()),
+            ('content', self.gf('editorsnotes.main.fields.XHTMLField')()),
             ('last_updater', self.gf('django.db.models.fields.related.ForeignKey')(related_name='last_to_update_note_set', to=orm['auth.User'])),
             ('type', self.gf('django.db.models.fields.CharField')(default='N', max_length=1)),
             ('id', self.gf('django.db.models.fields.AutoField')(primary_key=True)),
@@ -24,7 +24,7 @@ def forwards(self, orm):
         db.create_table('main_reference', (
             ('created', self.gf('django.db.models.fields.DateTimeField')(auto_now_add=True, blank=True)),
             ('url', self.gf('django.db.models.fields.URLField')(max_length=200, blank=True)),
-            ('citation', self.gf('main.fields.XHTMLField')()),
+            ('citation', self.gf('editorsnotes.main.fields.XHTMLField')()),
             ('note', self.gf('django.db.models.fields.related.ForeignKey')(related_name='references', to=orm['main.Note'])),
             ('creator', self.gf('django.db.models.fields.related.ForeignKey')(related_name='created_reference_set', to=orm['auth.User'])),
             ('id', self.gf('django.db.models.fields.AutoField')(primary_key=True)),
@@ -139,7 +139,7 @@ def backwards(self, orm):
         },
         'main.note': {
             'Meta': {'object_name': 'Note'},
-            'content': ('main.fields.XHTMLField', [], {}),
+            'content': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_note_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
@@ -150,7 +150,7 @@ def backwards(self, orm):
         },
         'main.reference': {
             'Meta': {'object_name': 'Reference'},
-            'citation': ('main.fields.XHTMLField', [], {}),
+            'citation': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_reference_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),

editorsnotes/main/migrations/0002_auto__add_field_reference_ordering.py

@@ -65,7 +65,7 @@ def backwards(self, orm):
         },
         'main.note': {
             'Meta': {'object_name': 'Note'},
-            'content': ('main.fields.XHTMLField', [], {}),
+            'content': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_note_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
@@ -76,7 +76,7 @@ def backwards(self, orm):
         },
         'main.reference': {
             'Meta': {'object_name': 'Reference'},
-            'citation': ('main.fields.XHTMLField', [], {}),
+            'citation': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_reference_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),

editorsnotes/main/migrations/0003_auto__add_field_reference_type.py

@@ -65,7 +65,7 @@ def backwards(self, orm):
         },
         'main.note': {
             'Meta': {'object_name': 'Note'},
-            'content': ('main.fields.XHTMLField', [], {}),
+            'content': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_note_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
@@ -76,7 +76,7 @@ def backwards(self, orm):
         },
         'main.reference': {
             'Meta': {'object_name': 'Reference'},
-            'citation': ('main.fields.XHTMLField', [], {}),
+            'citation': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_reference_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),

editorsnotes/main/migrations/0004_auto__add_userprofile.py

@@ -69,7 +69,7 @@ def backwards(self, orm):
         },
         'main.note': {
             'Meta': {'object_name': 'Note'},
-            'content': ('main.fields.XHTMLField', [], {}),
+            'content': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_note_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
@@ -80,7 +80,7 @@ def backwards(self, orm):
         },
         'main.reference': {
             'Meta': {'object_name': 'Reference'},
-            'citation': ('main.fields.XHTMLField', [], {}),
+            'citation': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_reference_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),

editorsnotes/main/migrations/0005_auto__add_source__add_citation.py

@@ -10,7 +10,7 @@ def forwards(self, orm):
 
         # Adding model 'Source'
         db.create_table('main_source', (
-            ('description', self.gf('main.fields.XHTMLField')()),
+            ('description', self.gf('editorsnotes.main.fields.XHTMLField')()),
             ('created', self.gf('django.db.models.fields.DateTimeField')(auto_now_add=True, blank=True)),
             ('ordering', self.gf('django.db.models.fields.CharField')(max_length=32)),
             ('creator', self.gf('django.db.models.fields.related.ForeignKey')(related_name='created_source_set', to=orm['auth.User'])),
@@ -97,7 +97,7 @@ def backwards(self, orm):
         },
         'main.note': {
             'Meta': {'object_name': 'Note'},
-            'content': ('main.fields.XHTMLField', [], {}),
+            'content': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_note_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
@@ -108,7 +108,7 @@ def backwards(self, orm):
         },
         'main.reference': {
             'Meta': {'object_name': 'Reference'},
-            'citation': ('main.fields.XHTMLField', [], {}),
+            'citation': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_reference_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
@@ -121,7 +121,7 @@ def backwards(self, orm):
             'Meta': {'object_name': 'Source'},
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_source_set'", 'to': "orm['auth.User']"}),
-            'description': ('main.fields.XHTMLField', [], {}),
+            'description': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
             'ordering': ('django.db.models.fields.CharField', [], {'max_length': '32'}),
             'type': ('django.db.models.fields.CharField', [], {'default': "'S'", 'max_length': '1'}),

editorsnotes/main/migrations/0006_references_to_citations.py

@@ -82,7 +82,7 @@ def backwards(self, orm):
         },
         'main.note': {
             'Meta': {'object_name': 'Note'},
-            'content': ('main.fields.XHTMLField', [], {}),
+            'content': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_note_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
@@ -93,7 +93,7 @@ def backwards(self, orm):
         },
         'main.reference': {
             'Meta': {'object_name': 'Reference'},
-            'citation': ('main.fields.XHTMLField', [], {}),
+            'citation': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_reference_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
@@ -106,7 +106,7 @@ def backwards(self, orm):
             'Meta': {'object_name': 'Source'},
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_source_set'", 'to': "orm['auth.User']"}),
-            'description': ('main.fields.XHTMLField', [], {}),
+            'description': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
             'ordering': ('django.db.models.fields.CharField', [], {'max_length': '32'}),
             'type': ('django.db.models.fields.CharField', [], {'default': "'S'", 'max_length': '1'}),

editorsnotes/main/migrations/0007_auto__del_reference.py

@@ -18,7 +18,7 @@ def backwards(self, orm):
         db.create_table('main_reference', (
             ('created', self.gf('django.db.models.fields.DateTimeField')(auto_now_add=True, blank=True)),
             ('url', self.gf('django.db.models.fields.URLField')(max_length=200, blank=True)),
-            ('citation', self.gf('main.fields.XHTMLField')()),
+            ('citation', self.gf('editorsnotes.main.fields.XHTMLField')()),
             ('note', self.gf('django.db.models.fields.related.ForeignKey')(related_name='references', to=orm['main.Note'])),
             ('ordering', self.gf('django.db.models.fields.CharField')(max_length=5)),
             ('creator', self.gf('django.db.models.fields.related.ForeignKey')(related_name='created_reference_set', to=orm['auth.User'])),
@@ -84,7 +84,7 @@ def backwards(self, orm):
         },
         'main.note': {
             'Meta': {'object_name': 'Note'},
-            'content': ('main.fields.XHTMLField', [], {}),
+            'content': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_note_set'", 'to': "orm['auth.User']"}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
@@ -97,7 +97,7 @@ def backwards(self, orm):
             'Meta': {'object_name': 'Source'},
             'created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
             'creator': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'created_source_set'", 'to': "orm['auth.User']"}),
-            'description': ('main.fields.XHTMLField', [], {}),
+            'description': ('editorsnotes.main.fields.XHTMLField', [], {}),
             'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
             'ordering': ('django.db.models.fields.CharField', [], {'max_length': '32'}),
             'type': ('django.db.models.fields.CharField', [], {'default': "'S'", 'max_length': '1'}),