Flask MVC Template

A template for flask applications structured in the Model View Controller pattern Demo. Postman Collection

Dependencies

• Python3/pip3
• Packages listed in requirements.txt

Installing Dependencies

$ pip install -r requirements.txt

Configuration Management

Configuration information such as the database url/port, credentials, API keys etc are to be supplied to the application. However, it is bad practice to stage production information in publicly visible repositories. Instead, all config is provided by a config file or via environment variables.

In Development

When running the project in a development environment (such as gitpod) the app is configured via default_config.py file in the App folder. By default, the config for development uses a sqlite database.

default_config.py

SQLALCHEMY_DATABASE_URI = "sqlite:///temp-database.db"
SECRET_KEY = "secret key"
JWT_ACCESS_TOKEN_EXPIRES = 7
ENV = "DEVELOPMENT"

These values would be imported and added to the app in load_config() function in config.py

config.py

# must be updated to inlude addtional secrets/ api keys & use a gitignored custom-config file instad
def load_config():
    config = {'ENV': os.environ.get('ENV', 'DEVELOPMENT')}
    delta = 7
    if config['ENV'] == "DEVELOPMENT":
        from .default_config import JWT_ACCESS_TOKEN_EXPIRES, SQLALCHEMY_DATABASE_URI, SECRET_KEY
        config['SQLALCHEMY_DATABASE_URI'] = SQLALCHEMY_DATABASE_URI
        config['SECRET_KEY'] = SECRET_KEY
        delta = JWT_ACCESS_TOKEN_EXPIRES
...

In Production

When deploying your application to production/staging you must pass in configuration information via environment tab of your render project's dashboard.

Flask Commands

wsgi.py is a utility script for performing various tasks related to the project. You can use it to import and test any code in the project. You just need create a manager command function, for example:

# inside wsgi.py

user_cli = AppGroup('user', help='User object commands')

@user_cli.cli.command("create-user")
@click.argument("username")
@click.argument("password")
def create_user_command(username, password):
    create_user(username, password)
    print(f'{username} created!')

app.cli.add_command(user_cli) # add the group to the cli

@app.cli.command("create_student", help="Creates a student")
@click.argument("username", default="jim")
@click.argument("password", default="jimpass")
def create_student_command(username, password):
    stu =  Student(username=username, password=password)
    db.session.add(stu)
    db.session.commit()
    print(f'{username} created!')

@app.cli.command("create_staff", help="Creates a staff")
@click.argument("username", default="tim")
@click.argument("password", default="timpass")
def create_student_command(username, password):
    staff =  Staff(username=username, password=password)
    db.session.add(staff)
    db.session.commit()
    print(f'{username} created!')

@app.cli.command("list", help="Lists users in the database")
@click.argument("format", default="string")
def list_user_command(format):
    if format == 'string':
        emp = User.query.all()
        stu = Student.query.all()
        staff =  Staff.query.all()
        list = Shortlist.query.all()
        inter = Intern.query.all()
        print('this is emp ' +str(emp))
        print("this is students " + str(stu))
        print("this is staff " + str(staff))
        print("this is SHORTLIST " + str(list))
        print("this is inter" + str(inter))

app.cli.add_command(user_cli) # add the group to the cli

@app.cli.command("create_intern", help="Creates an intern application")
def create_intern():
    from App.models import Shortlist
    emp = User.query.all()
    print('list of emp ' +str(emp))
    employer = input('Please enter emp id :')
    emp = User.query.get(employer)
    print(str(emp))
    title = input('Please enter intern title:')
    description = input('Please enter intern description:')
    oo= emp.create_intern(title,description)
    print(str(oo))

@app.cli.command("add_student", help=" Add student to an internship shortlist")
def add_student():
    staff = Staff.query.all()
    print('list of staff ' +str(staff))
    staff_id = input('please enter a staff id:')
    stafff = Staff.query.get(staff_id)
    print(str(stafff))
    list= Intern.query.all()
    print('list of intern '+ str(list))
    int_id= input('please enter an intern id:')
    inter= Intern.query.filter_by(id=int_id).first()
    print(str(inter.id))
    skl = Student.query.all()
    print('list of students '+ str(skl))
    student_id =  input('please enter a student id:')
    stu = Student.query.get(student_id)
    p = stafff.add_intern(intern_id=inter.id,student_id=stu.id)
    print(str(p))

@app.cli.command("evaluate_shortlist", help=" accept/reject student from shortlist")
def evaluate_shortlist():
    emp = User.query.all()
    print(('list of emp ' + str(emp)))
    employer = input('please entera employer id: ')
    emp1 = User.query.get(employer)
    ll = Intern.query.filter_by(user_id=emp1.id).first()
    print('list of inter: '+ str(ll))
    inter_is=input('please enter a intern id:')
    shortlist = Shortlist.query.filter_by(intern_id=inter_is).all()
    print('list of shortlist '+ str(shortlist))
    list_id = input('please enter a shortlist id: ')
    sl = Shortlist.query.get(list_id)
    response = input('accept or reject: ')
    if response == 'accept' or response == 'reject':
        emp1.review_app(response,sl)
        print(str(sl))

@app.cli.command("view_reply", help=" view shortlisted positions and employer response")
def view_reply():
    student = Student.query.all()
    print('list of students  ' + str(student))
    student_id = input('please enter student id:')
    stu = Student.query.get(student_id)
    list = Shortlist.query.filter_by(student_id=stu.id).all()
    print('list of shortlist :' + str(list))

Then execute the command invoking with flask cli with command name and the relevant parameters

$ flask user create bob bobpass

Running the Project

For development run the serve command (what you execute):

$ flask run

For production using gunicorn (what the production server executes):

$ gunicorn wsgi:app

Deploying

You can deploy your version of this app to render by clicking on the "Deploy to Render" link above.

Initializing the Database

When connecting the project to a fresh empty database ensure the appropriate configuration is set then file then run the following command. This must also be executed once when running the app on heroku by opening the heroku console, executing bash and running the command in the dyno.

$ flask init

Database Migrations

If changes to the models are made, the database must be'migrated' so that it can be synced with the new models. Then execute following commands using manage.py. More info here

$ flask db init
$ flask db migrate
$ flask db upgrade
$ flask db --help

Testing

Unit & Integration

Unit and Integration tests are created in the App/test. You can then create commands to run them. Look at the unit test command in wsgi.py for example

@test.command("user", help="Run User tests")
@click.argument("type", default="all")
def user_tests_command(type):
    if type == "unit":
        sys.exit(pytest.main(["-k", "UserUnitTests"]))
    elif type == "int":
        sys.exit(pytest.main(["-k", "UserIntegrationTests"]))
    else:
        sys.exit(pytest.main(["-k", "User"]))

You can then execute all user tests as follows

$ flask test user

You can also supply "unit" or "int" at the end of the comand to execute only unit or integration tests.

You can run all application tests with the following command

$ pytest

Test Coverage

You can generate a report on your test coverage via the following command

$ coverage report

You can also generate a detailed html report in a directory named htmlcov with the following comand

$ coverage html

Troubleshooting

Views 404ing

If your newly created views are returning 404 ensure that they are added to the list in main.py.

from App.views import (
    user_views,
    index_views
)

# New views must be imported and added to this list
views = [
    user_views,
    index_views
]

Cannot Update Workflow file

If you are running into errors in gitpod when updateding your github actions file, ensure your github permissions in gitpod has workflow enabled

Database Issues

If you are adding models you may need to migrate the database with the commands given in the previous database migration section. Alternateively you can delete you database file.