Merge pull request #85 from Zohair-coder/dev

Added mypy

Author: Zohair-coder

.devcontainer/devcontainer.json

@@ -12,7 +12,8 @@
 		"vscode": {
 			"extensions": [
 				"ms-python.python",
-				"charliermarsh.ruff"
+				"charliermarsh.ruff",
+				"ms-python.mypy-type-checker"
 			],
 			"settings": {
 				"editor.defaultFormatter": "charliermarsh.ruff",

.github/workflows/functional_test.yml

@@ -16,11 +16,14 @@ jobs:
       with:
         python-version: "3.11"
 
-    - name: Install linter/formatter dependencies
+    - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install ruff
+        pip install -r requirements.txt
 
+    - name: Run mypy
+      run: mypy src --strict
+      
     - name: Run Linter
       run: ruff check --output-format=github src
 
@@ -97,7 +100,7 @@ jobs:
         fi
 
     - name: Reset database
-      run: docker compose run scraper sh -c 'apk add postgresql-client && ./scripts/reset_db.sh;'
+      run: docker compose run scraper sh -c 'apk add postgresql-client && ./scripts/reset-db.sh;'
 
     - name: Run scraper again (to test cache)
       run: docker compose run scraper python3 src/main.py --db --all-colleges --ratings

.vscode/launch.json

@@ -12,11 +12,11 @@
       "console": "integratedTerminal",
       "justMyCode": true,
       "cwd": "${workspaceFolder}",
-      "args": ["--ratings"]
+      // "args": ["--ratings"]
       // "args": ["--all-colleges"]
       // "args": ["--db"]
       // "args": ["--ratings", "--db", "--all-colleges"]
-      // "args": ["--ratings", "--db"]
+      "args": ["--ratings", "--db"]
       // "args": ["--email"]
     }
   ]

README.md

@@ -92,7 +92,7 @@ python src/main.py --db
 This will create a new database `schedulerdb` and the necessary tables if they aren't already created, and then insert the data into the database. If the data is already populated, it will update the existing data. To delete all the data, make sure the environment variables specified in `src/db_config.py` are set and then run the following command (make sure you're using the Git Bash terminal if you're using Windows):
 
 ```bash
-./scripts/reset_db.sh
+./scripts/reset-db.sh
 ```
 
 To view the schema for the tables, you can look at the `src/create_tables.sql` file.