Rename mod to package, add README

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..7cf27c5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Content Database
+
+## Setup
+
+First create a Python virtual env:
+
+       virtualenv env
+       source env/bin/activate
+
+then use pip:
+
+       pip install -r requirements.txt
+
+## Running
+
+You need to enter the virtual environment if you haven't yet in
+the current session:
+
+       source env/bin/activate
+
+Reset the database like so:
+
+       python setup.py -d
+
+Then run the server:
+
+       python rundebug.py
+
+Then view in your web browser:
+
+       http://localhost:5000/

diff --git a/app/models.py b/app/models.py
index 97dc3c934410a1d25cae32bcff77a3e66963831c..ec961f3d01310a7b4de03b8607563ac926f82e11 100644 (file)
--- a/app/models.py
+++ b/app/models.py
@@ -35,7 +35,7 @@ class User(db.Model, UserMixin):
        display_name = db.Column(db.String(100), nullable=False, server_default='')
 
        # Content
-       mods = db.relationship('Mod', backref='author', lazy='dynamic')
+       packages = db.relationship('Package', backref='author', lazy='dynamic')
 
        def __init__(self, username):
                import datetime
@@ -57,7 +57,7 @@ class UserRoles(db.Model):
        user_id = db.Column(db.Integer(), db.ForeignKey('user.id', ondelete='CASCADE'))
        role_id = db.Column(db.Integer(), db.ForeignKey('role.id', ondelete='CASCADE'))
 
-class Mod(db.Model):
+class Package(db.Model):
        id      = db.Column(db.Integer, primary_key=True)
 
        # Basic details

diff --git a/app/views/mods.py b/app/views/mods.py
deleted file mode 100644 (file)
index ca349ea..0000000
--- a/app/views/mods.py
+++ /dev/null
@@ -1,19 +0,0 @@
-from flask import *
-from flask_user import *
-from flask.ext import menu
-from app import app
-from app.models import *
-
-@app.route('/mods/')
-@menu.register_menu(app, '.mods', 'Mods')
-def mods_page():
-       packages = Mod.query.all()
-       return render_template('packages.html', title="Mods", packages=packages)
-
-@app.route("/<type>s/<author>/<name>/")
-def package_page(type, author, name):
-       package = Mod.query.filter_by(name=name).first()
-       if package is None:
-               abort(404)
-
-       return render_template('package_details.html', package=package)

diff --git a/app/views/packages.py b/app/views/packages.py
new file mode 100644 (file)
index 0000000..10b3689
--- /dev/null
+++ b/app/views/packages.py
@@ -0,0 +1,19 @@
+from flask import *
+from flask_user import *
+from flask.ext import menu
+from app import app
+from app.models import *
+
+@app.route('/mods/')
+@menu.register_menu(app, '.mods', 'Mods')
+def mods_page():
+       packages = Package.query.all()
+       return render_template('packages.html', title="Mods", packages=packages)
+
+@app.route("/<type>s/<author>/<name>/")
+def package_page(type, author, name):
+       package = Package.query.filter_by(name=name).first()
+       if package is None:
+               abort(404)
+
+       return render_template('package_details.html', package=package)

diff --git a/setup.py b/setup.py
index fb9069d51cb502d52ae9752458bc36015384f211..e98965d4f7c60861ee5f1f8c4e967ca931bf9f7b 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -1,6 +1,6 @@
-import os, datetime
+import os, sys, datetime
 
-delete_db = False
+delete_db = len(sys.argv) >= 2 and sys.argv[1].strip() == "-d"
 
 if delete_db and os.path.isfile("db.sqlite"):
        os.remove("db.sqlite")
@@ -16,7 +16,7 @@ if not os.path.isfile("db.sqlite"):
        ruben.github_username = "rubenwardy"
        db.session.add(ruben)
 
-       mod1 = Mod()
+       mod1 = Package()
        mod1.name = "awards"
        mod1.title = "Awards"
        mod1.author = ruben