Skip to content

README.md

Latest commit

 

History

History
41 lines (29 loc) · 1.4 KB

README.md

File metadata and controls

41 lines (29 loc) · 1.4 KB

StudyOS Demo Assets

This folder contains the material used to demonstrate the end-to-end workflow of StudyOS.

Contents

  • emails/: sample email bodies you can send to the Gmail account connected to StudyOS
  • attachments/: matching PDF attachments for those emails
  • StudyOS_Demo_Pack.zip: bundled version of the demo pack for quick sharing

Recommended Demo Order

  1. 01_cs_assignment_email.txt
  2. 02_physics_lab_email.txt
  3. 03_history_essay_email.txt
  4. 04_data_science_project_email.txt
  5. 05_math_worksheet_email.txt
  6. 06_english_presentation_email.txt

Dry Run

Use test_end_to_end_email.txt before recording a final demo to verify that:

  • Gmail filters are working
  • PDF parsing succeeds
  • Notion task creation is correct
  • Calendar events are generated as expected

Demo Flow

  1. Send one or more sample emails to the Gmail account connected to StudyOS.
  2. Attach the matching PDF from attachments/.
  3. Keep the emails unread so they are picked up by the Gmail query.
  4. Run python main.py.
  5. Show the created tasks in Notion.
  6. Show the generated deadlines in Google Calendar.
  7. Optionally run python briefing.py --demo or python briefing.py to present the morning briefing output.

Presentation Tip

For a clean public GitHub repo, keep demo assets that explain the workflow, but avoid committing private credentials, temporary transcripts, or review-only frame dumps.