CSE102/Substitution-Requests
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

formatted readme

Browse Source
This commit is contained in:
murraydr 2023-10-25 12:46:55 -04:00
parent b33f047d12
commit e1d8d85d7c
2 changed files with 44 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -2,14 +2,14 @@
System for CSE 102 staff to request subs. System for CSE 102 staff to request subs.
***Installing and configuring for the first time:*** ## Installing and configuring for the first time
Install the libraries in your Python environment:
### Install the libraries in your Python environment:
```
pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
pip install --upgrade pandas pip install --upgrade pandas
pip install --upgrade pysimplegui pip install --upgrade pysimplegui
```
Versions that are proven to work (newer versions probably work, older versions maybe work) Versions that are proven to work (newer versions probably work, older versions maybe work)
Pysimplegui 4.60.4 Pysimplegui 4.60.4
pandas: 1.4.4 pandas: 1.4.4
@ -17,13 +17,15 @@ Install the libraries in your Python environment:
google-auth-httplib2 0.1.1 google-auth-httplib2 0.1.1
google-auth-oauthlib 0.5.2 google-auth-oauthlib 0.5.2
Install Git ### Install and configure Git
https://git-scm.com/downloads https://git-scm.com/downloads
Be sure to use the right version (32 vs 64 bit, Windows vs Linux, etc.) you can find your version of Windows by typing “about” in the start bar Be sure to use the right version (32 vs 64 bit, Windows vs Linux, etc.) you can find your version of Windows by typing “about” in the start bar
When installing Git, there are many settings, if you don’t know what it does, just keep the default option. When installing Git, there are many settings, if you don’t know what it does, just keep the default option.
Run Git bash and within run this command: Run Git bash and within run this command:
```
git config --global core.autocrlf false git config --global core.autocrlf false
```
Close Git bash and open Git Gui Close Git bash and open Git Gui
Click “Clone Existing Repository” and paste https://git.egr.msu.edu/CSE102/Substitution-Requests.git into the “Source Location” box. Click “Clone Existing Repository” and paste https://git.egr.msu.edu/CSE102/Substitution-Requests.git into the “Source Location” box.
@ -32,6 +34,7 @@ Close Git bash and open Git Gui
Open the Repo in GitGui (this might happen automatically after cloning). Click “Tools” and “Add” Open the Repo in GitGui (this might happen automatically after cloning). Click “Tools” and “Add”
Put “Pull” in the name box and “git pull origin master” (no quotes) in the command box and click “Add” Put “Pull” in the name box and “git pull origin master” (no quotes) in the command box and click “Add”
### Authenticate your machine with Google
Run the code for the first time (or since 7 days have elapsed since this step was last performed on this computer) Run the code for the first time (or since 7 days have elapsed since this step was last performed on this computer)
It will take you to a login page, you MUST log in as cse102msu@gmail.com (password is python_1107) It will take you to a login page, you MUST log in as cse102msu@gmail.com (password is python_1107)
This login has mandatory 2-factor authentication (b/c of Google policy on API access) This login has mandatory 2-factor authentication (b/c of Google policy on API access)
@ -39,4 +42,15 @@ Run the code for the first time (or since 7 days have elapsed since this step wa
Once logged in, just click continue on each increasingly dire warning page until it says “The authentication flow has completed. You may close this window” Once logged in, just click continue on each increasingly dire warning page until it says “The authentication flow has completed. You may close this window”
***Workflow:*** ## Daily Workflow:
Ensure that nobody else is currently working on these files or sitting on unpushed changes
This prevents merge conflicts and the need to redo work
Open Git Gui and click "Tools" and "Pull" (or whatever you named the pull command during configuration explained above)
This updates your local copy to the repo's version
run "driver.py" in whatever your Python setup is and when done, click "OK" to close and save changes
In Git Gui type a commit message and then click "Rescan", "Stage Changed", "Commit", and "Push" in that order.
Click "Push" in the dialog box that comes up, then close the confirmation dialog.

2
driver.py
View File

@ -8,6 +8,8 @@ import scheduledPayrollWindow as PWin
#TODO demonstrate workflow with git #TODO demonstrate workflow with git
#TODO document steps of start-of-semester initialization
#TODO do error checking within while loop (update text color / valid status) #TODO do error checking within while loop (update text color / valid status)
# IMPOSSIBLE: pysimplegui does not allow for changing of the layout object after the window is created, # IMPOSSIBLE: pysimplegui does not allow for changing of the layout object after the window is created,
# so the number of rows of checkboxes cannot be changed without reopening the window # so the number of rows of checkboxes cannot be changed without reopening the window