###Written by People Who Code Cindy Chen, Parth Oza, Jagan Prem, Kevin Shen
This repository is for Cindy Chen, Parth Oza, Jagan Prem, and Kevin Shen's 2015-2016 IDT Automated Software Testing project - automated package tracking and analysis.
Run git clone using the URL on the sidebar to clone the repository.
We are only using the master branch for release builds - as in when everything is working, we merge to master and then go back to develop for other things.
To switch to the master branch, do git checkout master. Before and after every git operation you do, you should do git pull to prevent merge conflicts.
After we get basic stuff done, we will switch to using different branches for each person.
To add your changes to the index, you do git add -A or git add FILENAME if you just want to add a few files.
To commit your changes, run git commit -m "message", where message is your commit message.
After you commit, run git push, which will send everything to the server.
Oh, and you should also probably have groovy installed. That's what the IDT event simulator uses.
If you do not have Python 2.7.* installed, visit [https://www.python.org/downloads/](Python install site) and download the latest version of Python 2.7.
If you do not have MySQL installed, visit [https://dev.mysql.com/downloads/installer/](MySQL install site) and install the correct version of MySQL for your server / system.
The code that is on here is serverside. Our server is going to be separate from the IDT server, though it may be on the same machine.
The current dependencies are:
flask 0.10.1
geopy 1.11.0
MySQLdb 1.2.5
python-dateutil 2.4.1
gpxpy 1.0.0
If you add libraries to your Python installation, add them to this list so the rest of us know what to get.
Generally, to install Python libraries, you just run pip2 install LIBRARYNAME, where LIBRARYNAME is the name of the library. pip may not be in your PATH. If this is the case, add your python2 installation to path and run python -m pip install LIBRARYNAME.
Install MySQL Installer at [https://dev.mysql.com/downloads/installer/](MySQL install site) (mysql-installer-web-community-5.7.10.0.msi - this is the first option)
Follow the instructions on this link to successfully install MySQL: [http://corlewsolutions.com/articles/article-21-how-to-install-mysql-server-5-6-on-windows-7-development-machine](Installation tutorial)
After installation, follow the Post-installation Steps on this page to set a root password: [http://www.tutorialspoint.com/mysql/mysql-installation.htm](Set root password)
We do not have unit tests yet. However, the solution can be tested by running IDT_Server/package_events.py while the server is running to receive test data from the .gpx files provided.
Before you commit code, it should be commented properly and well-documented. It should also follow PEP-8.
For later
Have comments, but not too many comments. For Python, follow the PEP-8 conventions. PyCharm has plugins that do this for you and alert if you do something wrong. (If you noticed, this document doesn't follow PEP-8, but it doesn't matter since it's not in Python :D)
Have a docstring at the beginning of each function/class that documents what it does. Have a comment before the line of obscure bits of code to identify them. DO NOT have inline comments.
Save early, save often. Commit early, commit often. Write good commit messages. Don't wait to comment until the end.