capstone-projects-2023-spring / hackathon-group-1

hackathon-group-1 created by GitHub Classroom

Get Assignment Dates

Keywords

Section 704, Group 1, Python, dates, syllabus

Project Abstract

Our group created a python file that prints out the dates of assignments that are completed and upcoming. The idea was to create a simple project within the time constraint. It also was easy to run and straight to the point. Everyone in the group thought it would be easier to have a list of assignments instead of a complicated project.

High Level Requirement

Describe the requirements – i.e., what the product does and how it does it from a user point of view – at a high level. When the user puts python dates.py into the terminal, the following picture of what the terminal would look like is pictured below

Conceptual Design

The program is run on one python file, and the output is the user's terminal

Background

The program starts by setting up an HTTPS connection with the specified website. Then, it sets up the payload and headers for the GET request. After that it creates the GET request to the API endpoint "/api/syllabus/1". It then gets the response from the API, reads the data from the response, decodes the JSON data, and finally stores it in a variable. After it finsihes this process, it then gets the list of events from the data and initializes an empty list to store the event dates & names. The python file finally ends with a for loop that goes through each event in the list of events, gets today's date and if today's date is less than the assignment's due date, print that it is upcoming, if it is not this, the termianl prints that it is completed.

sequenceDiagram
actor User
autonumber
    User ->> IDE: Send Request For Schedule
    IDE ->> Course Website: Connect to the Website
    Course Website ->> API: Get "/api/syllabus/1"
    API ->> Course Website: Return event_dates, event_names
    Course Website ->> IDE: Return event_dates, event_names
    IDE ->> User: Return Dates for Assignments

Loading

Required Resources

IDE, Python

Collaborators

Tyler Weiss, Kat Tejada, Aaron Thomas, Ben Baldino, Steven Altemose