init

Author: zw427

README.md

@@ -0,0 +1,53 @@
+# (MacOS) Download the App and Run
+To download the App, you must open the Terminal and enter the following:
+```
+curl -L REPLACEME --output ~/Desktop/main.zip
+```
+A file called `main.zip` will appear on your desktop. Double-click to unzip; you should see `main.app` on your desktop.
+
+
+# Terminology
+
+* First-Year: A First-Year CS major is a student who was not affiliated with the CS major in the previous semester but is now affiliated. For example, First-Year students in FA2021 were unaffiliated in FA2021 but affiliated in FA2022.
+
+* Retention: A Retained CS major is a student who was affiliated with the CS major in the previous semester and is still affiliated. For example, retained students in FA2023 were affiliated with both FA2022 and FA2023. 
+
+* CHanged Major: A student is considered to have changed major if they were affiliated with the CS major in the immediate previous semester but no longer in the CS major in the selected semester. For example, a student who was in CS in FA2022 but is in FA2023 is a math major and is considered to have changed majors in FA2023. 
+
+* Graduates: A student is considered a graduate if they appeared as a CS major in the previous semester but are no longer a student in the current semester. For example, a student who graduated in Winter 2022 or Spring 2023 is considered a graduate in  FA2023. This also needs data from the previous semester. 
+
+* Cohort: A cohort is a group of students affiliated in the same semester. 
+
+
+# Extra Notes
+1. Only Citizens are tracked and counted. 
+
+1. Worksheets should be ordered in chronological order. 
+
+1. Students should have consistent NetIDs between semesters.
+
+
+# How to Build the Application from Scratch
+
+## Install Python
+This App was built with Python 3.13.0 and pip 24.2, but older versions of Python should also work.
+
+## Install Packages
+With Python installed, type the following in the Terminal, 
+```
+pip install -r requirements.txt
+```
+
+## Build the Application
+In the Terminal, type the following
+```
+chmod 700 build.sh clean.sh
+./build.sh
+```
+A main.zip will appear in the current directory, which contains the App.
+
+## Clean Build
+To clean the directory, enter 
+```
+./clean.sh
+```

build.sh

@@ -0,0 +1,20 @@
+#!/bin/zsh
+
+set -e
+
+SCRIPT="main.py"
+APP_NAME=$(basename "$SCRIPT" .py)
+
+pyinstaller --clean --noconfirm --onefile --windowed "$SCRIPT"
+
+# Must sign with Developer ID if app is to be distributed to other ARM64 MacOS users
+codesign --deep --force --verify --sign 11CB69B5F69442FE499B83CABAC1ABE5156341AF dist/main.app
+
+if [ -f "dist/$APP_NAME" ]; then
+    cd dist
+    zip -r "${APP_NAME}.zip" "main.app"
+    mv "${APP_NAME}.zip" ..
+    echo "Build successful"
+else
+    echo "Build failed"
+fi

clean.sh

@@ -0,0 +1,3 @@
+#!/bin/zsh
+
+rm -rf build dist main.spec main.zip