Add simple recordings table

app/__init__.py

@@ -1,11 +1,16 @@
+# App initialization
 from flask import Flask
 from flask_sqlalchemy import SQLAlchemy
-from app.mod_devices import setup_mqtt, tear_down_mqtt, devices
 
 app = Flask(__name__, instance_relative_config=True)
 app.config.from_object('config')
 app.config.from_pyfile('config.py')
 db = SQLAlchemy(app)
+
+
+# Blueprints setup
+from app.mod_devices import setup_mqtt, tear_down_mqtt, devices
+
 app.register_blueprint(devices, url_prefix='/devices')
 
 

app/mod_devices/__init__.py

@@ -1,10 +1,13 @@
 import atexit
 from flask import Blueprint
 from flask_mqtt import Mqtt
+from .. import db
 
 devices = Blueprint('devices', __name__)
 mqtt = Mqtt()
 
+from .models import Recording
+
 def on_stop():
     tear_down_mqtt()
 
@@ -51,3 +54,5 @@ def handle_mqtt_message(client, userdata, message):
         payload=message.payload.decode()
     )
     print(message.payload.decode())
+
+

app/mod_devices/models.py

@@ -0,0 +1,22 @@
+from datetime import datetime
+from . import db
+from sqlalchemy.dialects.postgresql import JSON
+
+class Recording(db.Model):
+    __tablename__ = 'recordings'
+
+    id = db.Column(db.Integer, primary_key=True)
+    recorded_at = db.Column(db.DateTime, primary_key=True, index=True,
+            default=datetime.utcnow())
+    device_id = db.Column(db.Integer, primary_key=True)
+    record_type = db.Column(db.Integer, nullable=False)
+    record_value = db.Column(db.String, nullable=False)
+    raw_record = db.Column(JSON, nullable=True)
+
+    def __init__(self, device_id, record_type, record_value):
+        self.device_id = device_id
+        self.record_type = record_type
+        self.record_value = record_value
+
+    def __repr__(self):
+        return '<Recording %r>' % self.recorded_at

config.py

@@ -7,6 +7,7 @@ BASE_DIR = os.path.abspath(os.path.dirname(__file__))
 
 # Define the database - we are working with
 SQLALCHEMY_DATABASE_URI = os.environ['DATABASE_URL']
+SQLALCHEMY_TRACK_MODIFICATIONS = False
 DATABASE_CONNECT_OPTIONS = {}
 
 # Application threads. A common general assumption is

manage.py

@@ -0,0 +1,17 @@
+import os
+from flask_script import Manager
+from flask_migrate import Migrate, MigrateCommand
+
+from app import app, db
+
+
+app.config.from_object('config')
+
+migrate = Migrate(app, db)
+manager = Manager(app)
+
+manager.add_command('db', MigrateCommand)
+
+
+if __name__ == '__main__':
+    manager.run()

migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration.

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

migrations/env.py

@@ -0,0 +1,87 @@
+from __future__ import with_statement
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+from logging.config import fileConfig
+import logging
+
+# 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)
+logger = logging.getLogger('alembic.env')
+
+# 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.
+
+    """
+
+    # this callback is used to prevent an auto-migration from being generated
+    # when there are no changes to the schema
+    # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html
+    def process_revision_directives(context, revision, directives):
+        if getattr(config.cmd_opts, 'autogenerate', False):
+            script = directives[0]
+            if script.upgrade_ops.is_empty():
+                directives[:] = []
+                logger.info('No changes in schema detected.')
+
+    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,
+                      process_revision_directives=process_revision_directives,
+                      **current_app.extensions['migrate'].configure_args)
+
+    try:
+        with context.begin_transaction():
+            context.run_migrations()
+    finally:
+        connection.close()
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

migrations/script.py.mako

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

migrations/versions/33133bc3ce1d_.py

@@ -0,0 +1,38 @@
+"""empty message
+
+Revision ID: 33133bc3ce1d
+Revises: 
+Create Date: 2018-04-27 10:45:32.919141
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = '33133bc3ce1d'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('recordings',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('recorded_at', sa.DateTime(), nullable=False),
+    sa.Column('device_id', sa.Integer(), nullable=False),
+    sa.Column('record_type', sa.Integer(), nullable=False),
+    sa.Column('record_value', sa.String(), nullable=False),
+    sa.Column('raw_record', postgresql.JSON(astext_type=sa.Text()), nullable=True),
+    sa.PrimaryKeyConstraint('id', 'recorded_at', 'device_id')
+    )
+    op.create_index(op.f('ix_recordings_recorded_at'), 'recordings', ['recorded_at'], unique=False)
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f('ix_recordings_recorded_at'), table_name='recordings')
+    op.drop_table('recordings')
+    # ### end Alembic commands ###

requirements.txt

@@ -3,6 +3,7 @@ click==6.7
 Flask==0.12.2
 Flask-Migrate==2.1.1
 Flask-MQTT==1.0.3
+Flask-Script==2.0.6
 Flask-SQLAlchemy==2.3.2
 itsdangerous==0.24
 Jinja2==2.10