Merge pull request #18 from iromli/sqla

SQLAlchemy stuff

Author: iromli

README.md

@@ -1,10 +1,34 @@
 User Map
 ========
 
-A simple flask application for creating user community maps.
+A simple application for creating user community maps powered by Flask.
 
-Hacking
--------
+Installation
+------------
+
+Prerequisites:
+
+* Python 2.7.x
+* PostgreSQL or MySQL database
+* pip and (optional) virtualenv
+
+Once you have all prerequisites, the following steps will bootstrap the project:
+
+1.  Grab the source code.
+
+        git clone git://github.com/id-python/members.git
+        cd members
+
+2.  Activate your virtual environment (or you can skip this step if you're not using `virtualenv`).
+
+3.  Install all dependencies using `pip`:
+
+        pip install -r requirements.txt
+
+Note: the installation process may take awhile.
+
+Development
+-----------
 
 By default, this app reads configuration from `users/default_config.py`.
 To override values set in default config, simply copy the contents
@@ -14,18 +38,44 @@ of `users/default_config.py` and save it elsewhere.
 
 Then edit the custom config file, setting appropriate values as needed.
 
-To run the development server:
+Things you might need to override:
+
+*   `SQLALCHEMY_DATABASE_URI`
+
+    Since this project tested using PostgreSQL and __likely__ will running on MySQL as well,
+    there's extra package you need to install to before running the app.
+
+    * `pip install psycopg2` for PostgreSQL
+    * `pip install mysql-python` for MySQL
+
+    Just pick one and please refer to http://docs.sqlalchemy.org/en/rel_0_9/core/engines.html for details.
+
+Ensure your database schema is up-to-date by invoking this command:
+
+    USERS_CONFIG=/path/to/custom/config.py python manage.py db upgrade
+
+Running the app will be as simple as:
 
     USERS_CONFIG=/path/to/custom/config.py python manage.py runserver
 
 Each config item is overridable through environment variable.
 For instance, if you want to suppress email delivery, simply set appropriate value:
 
-    USERS_MAIL_SUPPRESS_SEND=True python manage.py runserver
+    USERS_CONFIG=/path/to/custom/config.py USERS_MAIL_SUPPRESS_SEND=1 python manage.py runserver
+
+Testing
+-------
+
+NOTE: It is highly-recommended that you're creating a separate database and config file for testing.
 
 To run testcases:
 
-    USERS_CONFIG=/path/to/custom/config.py USERS_MAIL_SUPPRESS_SEND=True ./runtests.sh
+    USERS_CONFIG=/path/to/custom/testing_config.py ./runtests.sh
+
+Each config item is overridable through environment variable.
+For instance, if you want to suppress email delivery, simply set appropriate value:
+
+    USERS_CONFIG=/path/to/custom/testing_config.py USERS_MAIL_SUPPRESS_SEND=1 ./runtests.sh
 
 Collaboration
 -------------

manage.py

@@ -1,7 +1,9 @@
 from flask.ext.script import Manager
+from flask.ext.migrate import MigrateCommand
 
 from users import APP
 
 if __name__ == "__main__":
     manager = Manager(APP)
+    manager.add_command("db", MigrateCommand)
     manager.run()

requirements.txt

@@ -1,10 +1,17 @@
 Flask==0.10.1
 Flask-Mail==0.9.0
+Flask-Migrate==1.2.0
+Flask-SQLAlchemy==1.0
 Flask-Script==2.0.5
+Flask-Testing==0.4.1
 Jinja2==2.7.3
+Mako==1.0.0
 MarkupSafe==0.23
+SQLAlchemy==0.9.6
 Werkzeug==0.9.6
+alembic==0.6.5
 blinker==1.3
+dictalchemy==0.1.2.6
 flask-appconfig==0.9.1
 itsdangerous==0.24
 nose==1.3.3

users/__init__.py

@@ -11,6 +11,8 @@
 from flask_mail import Mail
 from flask.ext.appconfig import AppConfig
 
+from users.database import db, migrate
+
 
 def add_handler_once(logger, handler):
     """A helper to add a handler to a logger, ensuring there are no duplicates.
@@ -77,6 +79,11 @@ def setup_logger():
 # backward-compat
 APP.config['DATABASE'] = APP.config['SQLITE_DB_PATH']
 
+db.init_app(APP)
+
+migration_dir = os.path.join(os.path.dirname(__file__), "migrations")
+migrate.init_app(APP, db, directory=migration_dir)
+
 # Don't import actual view methods themselves - see:
 # http://flask.pocoo.org/docs/patterns/packages/#larger-applications
 # Also views must be imported AFTER app is created above.

users/database.py

@@ -0,0 +1,16 @@
+from dictalchemy import make_class_dictable
+from flask.ext.sqlalchemy import SQLAlchemy
+from flask.ext.migrate import Migrate
+
+db = SQLAlchemy()
+
+db.Model.metadata.naming_convention = {
+    "ix": "ix_%(column_0_label)s",
+    "uq": "uq_%(table_name)s_%(column_0_name)s",
+    "ck": "ck_%(table_name)s_%(constraint_name)s",
+    "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
+    "pk": "pk_%(table_name)s",
+}
+make_class_dictable(db.Model)
+
+migrate = Migrate()

users/default_config.py

@@ -47,3 +47,9 @@
     user='/static/img/marker.png',
     shadow='/static/img/marker-shadow.png'
 )
+
+# By default it uses postgres, hence you'll need to ``psycopg2``.
+# If you're using MySQL, refer to
+# http://docs.sqlalchemy.org/en/rel_0_9/core/engines.html
+# for details.
+SQLALCHEMY_DATABASE_URI = "postgresql://scott:tiger@localhost:5432/mydatabase"

users/migrations/alembic.ini

@@ -0,0 +1,45 @@
+# A generic, single database configuration.
+
+[alembic]
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

users/migrations/env.py

@@ -0,0 +1,73 @@
+from __future__ import with_statement
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+from logging.config import fileConfig
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+from flask import current_app
+config.set_main_option('sqlalchemy.url', current_app.config.get('SQLALCHEMY_DATABASE_URI'))
+target_metadata = current_app.extensions['migrate'].db.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+def run_migrations_offline():
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(url=url)
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+def run_migrations_online():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    engine = engine_from_config(
+                config.get_section(config.config_ini_section),
+                prefix='sqlalchemy.',
+                poolclass=pool.NullPool)
+
+    connection = engine.connect()
+    context.configure(
+                connection=connection,
+                target_metadata=target_metadata
+                )
+
+    try:
+        with context.begin_transaction():
+            context.run_migrations()
+    finally:
+        connection.close()
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()
+

users/migrations/script.py.mako

@@ -0,0 +1,22 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision}
+Create Date: ${create_date}
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

users/migrations/versions/15e14062732d_create_users_table.py

@@ -0,0 +1,34 @@
+"""create users table
+
+Revision ID: 15e14062732d
+Revises: None
+Create Date: 2014-07-05 21:40:46.378774
+
+"""
+# revision identifiers, used by Alembic.
+revision = '15e14062732d'
+down_revision = None
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    op.create_table(
+        "users",
+        sa.Column("id", sa.Integer, primary_key=True),
+        sa.Column("guid", sa.String(37), nullable=False, unique=True),
+        sa.Column("name", sa.String(32), nullable=False),
+        sa.Column("email", sa.String(254), nullable=False),
+        sa.Column("website", sa.String(255), default=""),
+        sa.Column("email_updates", sa.Boolean(name="email_updates"),
+                  default=False),
+        sa.Column("date_added", sa.DateTime,
+                  server_default=sa.text("CURRENT_TIMESTAMP")),
+        sa.Column("latitude", sa.Float),
+        sa.Column("longitude", sa.Float),
+        )
+
+
+def downgrade():
+    op.drop_table("users")