Merge pull request #1 from py-package/feature/sqlalchemy

Feature/sqlalchemy

Author: yubarajshrestha

README.md

@@ -5,7 +5,9 @@ A production-grade flask application that you can start your projects without he
 
 **Features**
 - [x] Factory Pattern
-- [x] Orator ORM module
+- [x] SQLAlchemy ORM
+- [x] Flask-Migrate for database migrations
+- [x] Flask-Seeder for database seed
 - [x] Celery for background jobs
 - [x] Managed Routing using Blueprints
 - [x] Data and Route Caching using Flask-Cache
@@ -28,10 +30,13 @@ source venv/bin/activate
 pip install -r requirements.txt
 
 # migrate database
-python db.py migrate
+flask db upgrade
+
+# rollback database migrations
+flask db downgrade
 
 # run database seeder, this will setup default admin credentials for our backend
-python db.py db:seed
+python seed run
 ```
 
 **Running Application**
@@ -43,7 +48,7 @@ You can run application using multiple methods:
 python wsgi.py
 
 # gunicorn server
-gunicorn -w 4 wsgi:server -t 90 0.0.0.0:5000 --reload
+gunicorn -w 4 wsgi:app -t 90 0.0.0.0:5000 --reload
 
 # using sh
 ./run
@@ -55,16 +60,13 @@ This application uses orator orm. You can find details **[here](https://orator-o
 
 ```sh
 # Creating migration
-python db.py make:migration create_users_table --create --table=users
+flask db migrate -m "migration_message_here"
 
 # Run migration
-python db.py migrate
+flask db upgrade
 
 # Rollback migration
-python db.py migrate:rollback
-
-# For more details run:
-python db.py
+flask db downgrade
 ```
 
 **Celery**

__init__.py

@@ -1,14 +1,18 @@
-from config import DevelopmentConfig, TestingConfig
 from flask import Flask, render_template
+from flask_sqlalchemy import SQLAlchemy
+from flask_migrate import Migrate
+from flask_seeder import FlaskSeeder
 from flask_mail import Mail
-from flask_orator import Orator
-from celery import Celery
+from flask_login import LoginManager
 from flask_caching import Cache
+from celery import Celery
 from depot.manager import DepotManager
-from flask_login import LoginManager
+from config import DevelopmentConfig, TestingConfig
 
 mail = Mail()
-db = Orator()
+db = SQLAlchemy()
+migrate = Migrate()
+seeder = FlaskSeeder()
 celery = Celery(__name__, broker=DevelopmentConfig.CELERY_BROKER_URL, result_backend=DevelopmentConfig.RESULT_BACKEND)
 cache = Cache()
 login_manager = LoginManager()
@@ -18,9 +22,8 @@
 }, prefix='depot.')
 
 
-def factory(config=DevelopmentConfig) -> Flask:
+def factory(config=DevelopmentConfig):
     app = Flask(__name__)
-
     app.template_folder = 'views'
 
     # load application configuration from config
@@ -40,6 +43,8 @@ def factory(config=DevelopmentConfig) -> Flask:
     # initialize database
     db.init_app(app)
     db.app = app
+    migrate.init_app(app, db)
+    seeder.init_app(app, db)
 
     # initialize login_manager
     register_login_manager(app)
@@ -71,7 +76,8 @@ def register_login_manager(app):
     @login_manager.user_loader
     def load_user(user_id):
         from app.models.User import User
-        return User.find(user_id)
+
+        return User.query.get(int(user_id))
 
 
 def register_blueprints(app):

app/__init__.py

@@ -1,7 +1,7 @@
 from app.models.User import User
 from app.forms import ForgotPasswordForm, LoginForm
 from flask import render_template, redirect, request
-from flask_login import login_user, logout_user, login_required
+from flask_login import login_user, logout_user, login_required, current_user
 
 
 class AuthController():
@@ -19,7 +19,7 @@ def login():
                 email = form.data['email']
                 password = form.data['password']
 
-                user = User.where("email", email).first()
+                user = User.query.filter_by(email=email).first()
                 if user is None:
                     return render_template('pages/auth/login.html', title='Login', form=form, message="User not found!")
 
@@ -45,7 +45,7 @@ def forgot_password():
         else:
             if form.validate_on_submit():
                 email = form.data['email']
-                user = User.where("email", email).first()
+                user = User.query.filter_by(email=email).first()
                 if user is None:
                     return render_template('pages/auth/forgot_password.html', title="Forgot Password", form=form, message="User not found!")
                 user.send_password_reset_email()
@@ -61,6 +61,7 @@ def logout():
     def profile():
         data = {
             'title': 'Profile',
+            'user': current_user
         }
         return render_template('pages/auth/profile.html', **data)
 

app/controllers/AuthController.py

@@ -0,0 +1,8 @@
+from flask_wtf import FlaskForm
+from wtforms import StringField, SubmitField
+from wtforms.validators import DataRequired, Email
+
+
+class ForgotPasswordForm(FlaskForm):
+    email = StringField('Email', validators=[DataRequired(), Email()])
+    submit = SubmitField('Send Reset Link')

migrations/__init__.py renamed to app/controllers/__init__.py

@@ -0,0 +1,10 @@
+from flask_wtf import FlaskForm
+from wtforms import StringField, PasswordField, SubmitField, BooleanField
+from wtforms.validators import DataRequired, Email
+
+
+class LoginForm(FlaskForm):
+    email = StringField('Email', validators=[DataRequired(), Email()])
+    password = PasswordField('Password', validators=[DataRequired()])
+    remember = BooleanField('Remember Me')
+    submit = SubmitField('Login')

app/forms/ForgotPasswordForm.py

@@ -0,0 +1,23 @@
+from flask_wtf import FlaskForm
+from wtforms import StringField, PasswordField, SubmitField
+from wtforms.validators import DataRequired, Length, Email, EqualTo, ValidationError
+from app.models.User import User
+
+
+class RegistrationForm(FlaskForm):
+
+    username = StringField('Username', validators=[DataRequired(), Length(min=2, max=20)])
+    email = StringField('Email', validators=[DataRequired(), Email()])
+    password = PasswordField('Password', validators=[DataRequired()])
+    confirm_password = PasswordField('Confirm Password', validators=[DataRequired(), EqualTo('password')])
+    submit = SubmitField('Sign Up')
+
+    def validate_username(self, username):
+        user = User.where("username", username.data).first()
+        if user:
+            raise ValidationError('That username is taken. Please choose a different one.')
+
+    def validate_email(self, email):
+        user = User.where("email", email.data).first()
+        if user:
+            raise ValidationError('That email is taken. Please choose a different one.')

app/forms/LoginForm.py

@@ -1,35 +1,3 @@
-from flask_wtf import FlaskForm
-from wtforms import StringField, PasswordField, SubmitField, BooleanField, TextAreaField
-from wtforms.validators import DataRequired, Length, Email, EqualTo, ValidationError
-from app.models.User import User
-
-
-class RegistrationForm(FlaskForm):
-
-    username = StringField('Username', validators=[DataRequired(), Length(min=2, max=20)])
-    email = StringField('Email', validators=[DataRequired(), Email()])
-    password = PasswordField('Password', validators=[DataRequired()])
-    confirm_password = PasswordField('Confirm Password', validators=[DataRequired(), EqualTo('password')])
-    submit = SubmitField('Sign Up')
-
-    def validate_username(self, username):
-        user = User.where("username", username.data).first()
-        if user:
-            raise ValidationError('That username is taken. Please choose a different one.')
-
-    def validate_email(self, email):
-        user = User.where("email", email.data).first()
-        if user:
-            raise ValidationError('That email is taken. Please choose a different one.')
-
-
-class LoginForm(FlaskForm):
-    email = StringField('Email', validators=[DataRequired(), Email()])
-    password = PasswordField('Password', validators=[DataRequired()])
-    remember = BooleanField('Remember Me')
-    submit = SubmitField('Login')
-
-
-class ForgotPasswordForm(FlaskForm):
-    email = StringField('Email', validators=[DataRequired(), Email()])
-    submit = SubmitField('Send Reset Link')
+from .LoginForm import LoginForm
+from .RegistrationForm import RegistrationForm
+from .ForgotPasswordForm import ForgotPasswordForm