Merge pull request #2 from GatorEducator/master

Updating fork with master
GatorIncubator · Feb 20, 2019 · e0e63e7 · e0e63e7
2 parents 4e977b2 + 10f0457
commit e0e63e7
Show file tree

Hide file tree

Showing 26 changed files with 78 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -27,14 +27,14 @@ pip3 install -r requirements.txt
 
 Note that you may have Python 3 setup in different ways on your computer. For
 instance, you may prefer to install GatorGrouper's dependencies in a site-wide
-location and then you would have to type, for instance, `sudo pip install -r
+location and then you would have to type `sudo pip install -r
 requirements.txt`. Alternatively, you may choose to install the dependencies by
 typing `pip install --user -r requirements.txt`.
 
 GatorGrouper was developed to easily run in conjunction with a [venv-based
 Python 3 virtual environment](https://docs.python.org/3/library/venv.html). This
-means that if you are in the directory that contains the `gatorgrouper`
-directory then you could type `python3 -m venv gatorgrouper` to create all of
+means that if you are in the directory that contains `gatorgrouper`
+then you could type `python3 -m venv gatorgrouper` to create all of
 the components of a venv-based virtual environment in the `gatorgrouper`
 directory. Once you complete this step, you can type the command `source
 gatorgrouper/bin/activate` to activate the venv-based virtual environment.
@@ -43,27 +43,65 @@ Interested in learning more about the basics of virtual environments in Python
 [article](http://www.cs.allegheny.edu/sites/gkapfham/programming/research/idea/2017/07/14/Virtual-Environments/)
 to further develop your understanding of this topic.
 
+GatorGrouper requires users to use Python 3. You can type `python --version`
+into the terminal window to check the current version of Python on your
+workstation. If you do not have the right Python version, you can go to
+[Python](https://www.python.org/downloads/) to download the latest version of
+Python. If you can not download or upgrade Python on your workstation, you can
+download the [Pyenv](https://github.com/pyenv/pyenv) tool to set up a virtual
+environment for the newest Python version.
+
+To install Pyenv, you can use [Pyenv Installer](https://github.com/pyenv/pyenv-installer)
+by typing the command in terminal:
+
+```shell
+curl https://pyenv.run | bash
+```
+
+After the completion of this command, Pyenv should be installed. Please make
+sure that you have the following lines in your `~/.bashrc` or similar file
+types. Notices that different development evironment may have different
+configuration configuration files (i.e., "dotfiles"). You can see more examples
+and learn more in the instructions of Professor Kapfhammer's
+[dotfiles](https://github.com/gkapfham/dotfiles) repository.
+
+```shell
+export PATH="~/.pyenv/bin:$PATH"
+eval "$(pyenv init -)"
+eval "$(pyenv virtualenv-init -)"
+```
+
+Once Pyenv is installed, you can install the latest version of Python
+for your Pyenv. We suggest developers to use `Python 3.7.2`  for `gatorgrouper`.
+However, any version after `Python 3.6.8` would work well. To install, you
+should restart your terminal window by typing `pyenv install 3.7.2`
+and `pyenv global 3.7.2`.
+
+After you finish this process, you should be able
+to type `python --version` and get `Python 3.7.2` or other version after
+`Python 3.6.8` in your terminal.
+
 ## Initial Setup
 
-Ensure that you have installed gspread and oauth2client installed in the root
-directory of the repository.  In the terminal use the command:
+Ensure that you have installed gspread and oauth2client in the root
+directory of the repository. In the terminal use the command:
 
 ```shell
 python3 -m pip install --user gspread oauth2client
 ```
 
-Create a Google Sheets spreadsheet and a Google Form in Google Drive.  In the
+Create a Google Sheets spreadsheet and a Google Form in Google Drive. In the
 Form, create yes or no questions to measure the capabilities and skills of the
 students that you wish to group.  After you have at least one submission of the
 Form, you can go to the responses tab and click on the green icon with the white
-cross through it.  This will enable you to link the Sheet to the Form.  You can
-either create a new Sheet or link to a preexisting one.  If you need to change
+cross through it.  This will enable you to link the Sheet to the Form. You can
+either create a new Sheet or link to a preexisting one. If you need to change
 the destination, you can click on the three dot icon menu to the right of the
 green icon and select "Select response destination".
 
 Open the `.json` file in the `gatorgrouper` repository and find the `"client-email"`.
-Copy the quoted text that looks like an email address.  Return to the Sheet and
-open the sharing options.  Paste the address and click send.  Alternatively, if
+Copy the quoted text that looks like an email address. Return to the Sheet and
+open the sharing options.  Paste the address and click send. Alternatively, if
 you would like to create your own service account for confidentiality and
 security, follow the tutorial found at [www.twolio.com](https://www.twilio.com/blog/2017/02/an-easy-way-to-read-and-write-to-a-google-spreadsheet-in-python.html)
 to create a personal service account.

diff --git a/django/django.py b/django/django.py
diff --git a/gatorgrouper.py b/gatorgrouper.py
@@ -3,20 +3,20 @@
 import sys
 import logging
 
-import parse_arguments
-from read_student_file import read_student_file
-from remove_absent_students import remove_absent_students
-from display import display_welcome_message
-from display import display_student_groups
-from display import create_escaped_string_from_list
-from group_random import shuffle_students
-from group_random import group_random_group_size
-from group_random import group_random_num_group
-from group_rrobin import group_rrobin_group_size
-from group_rrobin import group_rrobin_num_group
-from spreadsheet import create_csv
-from defaults import DEFAULT_CSVFILE
-from defaults import DEFAULT_NUMGRP
+from src.controllers import parse_arguments
+from src.controllers import read_student_file
+from src.controllers import remove_absent_students
+from src.controllers.display import display_welcome_message
+from src.controllers.display import display_student_groups
+from src.controllers.display import create_escaped_string_from_list
+from src.controllers.group_random import shuffle_students
+from src.controllers.group_random import group_random_group_size
+from src.controllers.group_random import group_random_num_group
+from src.controllers.group_rrobin import group_rrobin_group_size
+from src.controllers.group_rrobin import group_rrobin_num_group
+from src.controllers.spreadsheet import create_csv
+from src.controllers.defaults import DEFAULT_CSVFILE
+from src.controllers.defaults import DEFAULT_NUMGRP
 
 
 if __name__ == '__main__':

diff --git a/manage.py b/manage.py
diff --git a/src/__init__.py b/src/__init__.py
diff --git a/defaults.py → src/controllers/defaults.py b/defaults.py → src/controllers/defaults.py
diff --git a/display.py → src/controllers/display.py b/display.py → src/controllers/display.py
diff --git a/group_random.py → src/controllers/group_random.py b/group_random.py → src/controllers/group_random.py
@@ -5,7 +5,7 @@
 import itertools
 from random import shuffle
 
-from group_scoring import score_groups
+from .group_scoring import score_groups
 
 
 def group_random_group_size(responses, grpsize):

diff --git a/group_rrobin.py → src/controllers/group_rrobin.py b/group_rrobin.py → src/controllers/group_rrobin.py
@@ -3,7 +3,7 @@
 import logging
 from random import shuffle
 from itertools import cycle
-from group_scoring import score_groups
+from .group_scoring import score_groups
 
 
 def group_rrobin_group_size(responses, grpsize):

diff --git a/group_scoring.py → src/controllers/group_scoring.py b/group_scoring.py → src/controllers/group_scoring.py
diff --git a/parse_arguments.py → src/controllers/parse_arguments.py b/parse_arguments.py → src/controllers/parse_arguments.py
@@ -3,10 +3,10 @@
 import argparse
 import logging
 
-from defaults import DEFAULT_CSVFILE
-from defaults import DEFAULT_GRPSIZE
-from defaults import DEFAULT_NUMGRP
-from read_student_file import read_student_file
+from .defaults import DEFAULT_CSVFILE
+from .defaults import DEFAULT_GRPSIZE
+from .defaults import DEFAULT_NUMGRP
+from .read_student_file import read_student_file
 
 
 def parse_arguments(args):

diff --git a/read_student_file.py → src/controllers/read_student_file.py b/read_student_file.py → src/controllers/read_student_file.py
diff --git a/rebalance.py → src/controllers/rebalance.py b/rebalance.py → src/controllers/rebalance.py
diff --git a/remove_absent_students.py → src/controllers/remove_absent_students.py b/remove_absent_students.py → src/controllers/remove_absent_students.py
diff --git a/spreadsheet.py → src/controllers/spreadsheet.py b/spreadsheet.py → src/controllers/spreadsheet.py
@@ -4,8 +4,8 @@
 import logging
 import gspread
 from oauth2client.service_account import ServiceAccountCredentials
-from defaults import DEFAULT_CSVFILE
-from defaults import DEFAULT_WORKBOOK
+from .defaults import DEFAULT_CSVFILE
+from .defaults import DEFAULT_WORKBOOK
 
 
 def create_csv():

diff --git a/src/models/model.py b/src/models/model.py
diff --git a/src/static/static.py b/src/static/static.py
diff --git a/src/templates/template.py b/src/templates/template.py
diff --git a/src/urls.py b/src/urls.py
diff --git a/src/views/views.py b/src/views/views.py
diff --git a/src/wsgi.py b/src/wsgi.py
diff --git a/tests/test_absent.py b/tests/test_absent.py
@@ -1,4 +1,4 @@
-import remove_absent_students
+from src.controllers import remove_absent_students
 
 
 def test_remove_absent_students():

diff --git a/tests/test_arguments.py b/tests/test_arguments.py
@@ -1,7 +1,7 @@
-import parse_arguments
 import logging
-import defaults
-import group_random
+from src.controllers import parse_arguments
+from src.controllers import defaults
+from src.controllers import group_random
 
 
 def test_parse_arguments1():

diff --git a/tests/test_display.py b/tests/test_display.py
@@ -1,4 +1,4 @@
-import display
+from src.controllers import display
 
 
 def test_display_student_groups(capsys):

diff --git a/tests/test_group_method.py b/tests/test_group_method.py
@@ -1,5 +1,5 @@
-import group_random
-import group_rrobin
+from src.controllers import group_random
+from src.controllers import group_rrobin
 import gatorgrouper
 
 

diff --git a/tests/test_group_size.py b/tests/test_group_size.py
@@ -1,4 +1,4 @@
-import parse_arguments
+from src.controllers import parse_arguments
 
 
 def test_check_valid_group_size_one():