ToDo

Unit tests

create a testing environment. create stubs. Check if inputs create outputs. create test for each unit test

Syllahub

Revamping the syllabus management system

Python

I am using python 3.7.2. I think this is the most recent stable version. Make sure you are using the correct python command that is mapped to the correct python version.

Common python commands are:

• $ python
• $ python3
• $ py
• $ py3

Check python version for each command with:

• $ python -V
• $ python3 -V
• $ py -V
• $ py3 -V

Flask Instalation Instructions

Once you clone the git repository, you must do a couple things to get this working on your local machine.

• cd to Syllahub directory
• Create Virtual Environment:
  $ python -m venv venv
  
• Activate virtual environment:
  For Windows: $ venv/Source/activate
  For Mac: $ source venv/bin/activate
(venv) $ _ <-- you should see this if enviroment is activated
• install all required packages from requirements.txt
  (venv) $ pip install -r requirements.txt
  Note: if you change the packages you must update requirements.txt with:
  (venv) $ pip freeze > requirements.txt
• Run local server with:
  $ flask run

Database

You must set up your own mysql server on your local machines

do not push the config file until I fix the flaskenv file loading

We used the fillowing sql command to get the database info. Run this command from inside a mysql console. mysql > select * from information_schema.processlist;

change the config variable SQLALCHEMY_DATABASE_URI
"dialect[+driver]://user:password@host/dbname" <-- this is the standard format. fill in the correct info for your local database

upgrade migration with:
(venv) $ flask db upgrade

downgrade migration with:
(venv) $ flask db downgrade

This project implements database migrations with flask-migrate.

Create a migration with:
(venv) $ flask db migrate -m "migration name"

HTTP RESTful Services

GET and Post tutorial

We probably won't be using PUT, PATCH, and DELETE requests. But this is ideally how it should be done. This link also shows a good list of errors.

Related Flask Tutorials

The Flask Mega Tutorial is a good start if anything here confuses you.

Explore Flask is the best resourse for the design patterns we will be using. Check it out.