D5: Code

Code Repository: https://github.com/matthewreddy/OMLSMS

A brief note on style and installation: our main work on this project was taking an old, complicated codebase and updating it to use newer tools and a newer version of Python. Therefore, it is hard to separate old modules and new modules, so keep in mind that most bits of code in this were changed by us in some form (for instance, all new UI files were generated, and all the Python code had to be reviewed line by line). Furthermore, there was little to no documentation in the older system that we were given, so most of the detailed comments were later added by us after we figured out what it was used for. One thing we did not change during our updates were the HTML template files, so those could be considered part of older modules. We put all of our changes in a new folder, “db_rewrite,” as we approved them, and then discarded the old db folder once all changes were transferred.

As for installation, the code (and tests) will not run properly without a Microsoft SQL Server instance of the OML database. We are unsure of the privacy/permissions of handing the backup file out, as it took us some time to get approved to get a backup ourselves, but if permitted to give out, there are detailed instructions in the README of how to get the SQL Server running and which settings to change to get the code to run. It is a somewhat complicated process, but we believe we described it in as much detail as possible.

Also, the client handoff vid and doc are located in the Client Handoff Plan tab under D5.