Merge pull request #3 from Programming-The-Next-Step-2026/week-3

Week 3

Author: magdalena-grubesa

.coverage

@@ -0,0 +1,25 @@
+name: Python tests
+
+on:
+  push:
+    branches: [main, master, week-3]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install package and test tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e . pytest
+
+      - name: Run unit tests
+        run: pytest
+

.github/workflows/python-tests.yaml

@@ -4,3 +4,4 @@ __pycache__/
 .DS_Store
 credentials.json
 token.json
+.ipynb_checkpoints

.gitignore

@@ -6,11 +6,12 @@ A smart study planner that builds your revision schedule automatically based on
 - Input your exams with dates and estimated study hours
 - Set daily available study hours and commitments
 - Import commitments automatically from Google Calendar
-- Edit/ commitments inside the planner 
-- Get an automatically generated color coded revision schedule
+- Edit commitments inside the planner 
+- Get an automatically generated color coded study schedule
 - Receive warnings when there is not enough time for an exam
+- Export study schedule to Google Calendar
 - Get personalised study tips based on psychology research
-- Optional spaced repetition schedule based on the Ebbinghaus forgetting curve
+- Optional: spaced repetition schedule based on the Ebbinghaus forgetting curve
 
 ## Installation
 ```bash
@@ -51,13 +52,19 @@ pytest --cov=study_smart tests/
 ```
 
 ## Google Calendar Integration
-To use the Google Calendar import feature you need:
-1. A Google account
-2. A `credentials.json` file — get this from [Google Cloud Console](https://console.cloud.google.com) by creating a project, enabling the Google Calendar API, and creating OAuth 2.0 credentials (Desktop app)
-3. Place `credentials.json` in the root of the project folder
-4. On first run a browser window will open asking you to grant calendar access — after that a `token.json` file is saved automatically
+
+To use the Google Calendar import feature, you need to set up your own Google OAuth credentials:
+
+1. Go to Google Cloud Console (https://console.cloud.google.com)
+2. Create a new project
+3. Enable the Google Calendar API
+4. Create OAuth 2.0 credentials (Desktop app)
+5. Download the credentials as `credentials.json`
+6. Place `credentials.json` in the root of the repository
+7. On first run, a browser window will open asking you to grant calendar access
 
 Note: `credentials.json` and `token.json` are excluded from version control for security reasons.
 
 ## Study Tips
-Hard-coded tips, based on psychological research.
+Hard-coded tips, based on psychological research.
+

README.md

@@ -10,7 +10,7 @@ authors = [
 ]
 description = "A smart study planner that builds your revision schedule automatically based on your exam dates and availability."
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.12"
 classifiers = [
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",
@@ -19,6 +19,10 @@ license = "MIT"
 license-files = ["LICEN[CS]E*"]
 dependencies = [
     "pandas",
+    "plotly",
+    "dash>=2.4.0",
+    "dash-bootstrap-components",
+    "openpyxl",
     "google-auth",
     "google-auth-oauthlib",
     "google-api-python-client",