ben-d-anderson / classcharts-api Goto Github PK

ClassCharts is an online behavior and homework management system used by schools.

This java project is an unofficial ClassCharts API wrapper that can be used to:

• Login and access ClassCharts
• View homeworks as parsed objects
• Mark homeworks as seen
• Tick homeworks off as "completed"

First, you should create a StudentCredentials object so that you can create a Student object and login to ClassCharts.

This can be achieved by first calling the static factory method ClassChartsDate#from(String) or ClassChartsDate#from(Date) to get a ClassChartsDate object then use that when calling the static factory method StudentCredential#from(String, ClassChartsDate).

//The date of birth should be in the format "dd/MM/yyyy"
ClassChartsDate date = ClassChartsDate.from("DATE_OF_BIRTH")
StudentCredentials studentCredentials = StudentCredentials.from("CODE", date);

Next, you can create a new Student object using the constructor Student(StudentCredentials).

When the Student object is created, the student is logged in automatically and data that will be necessary for other methods is retrieved from ClassCharts.

Student student = new Student(studentCredentials);

The Student instance can now be used to get the homework associated with that user.

Homework can be retrieved using the methods getHomework(), getHomework(ClassChartsDate, ClassChartsDate) and getHomework(DisplayDate, ClassChartsDate, ClassChartsDate) in the Student class. A student's timetable can also be accessed by the method getTimetable() which returns the current day's timetable lessons and the method getTimetable(ClassChartsDate) which returns the timetable lessons of the given date.

Examples of how to use these methods are demonstrated below:

//The dates be in the format "dd/MM/yyyy"
ClassChartsDate startDate = ClassChartsDate.from("01/01/2020");
ClassChartsDate endDate = ClassChartsDate.from("01/12/2020");

List<Homework> homework = student.getHomework();
List<Homework> homework2 = student.getHomework(startDate, endDate);
List<Homework> homework3 = student.getHomework(DisplayDate.DUE, startDate, endDate);
List<Homework> homework3 = student.getHomework(DisplayDate.ISSUE, startDate, endDate);

//Get today's lessons
List<TimetableLesson> lessons = student.getTimetable();
//Get tomorrow's lessons
Calendar calendar = Calendar.getInstance();
calendar.add(Calendar.DATE, 1);
List<TimetableLesson> lessonsTomorrow = student.getTimetable(calendar.getTime());

Using the list of homeworks retrieved, you can do many things such as the following example: (which prints out the title of every homework in the default timeframe which hasn't been done)

homework.stream().filter(hwk -> !(hwk.getStatus().isCompleted() || hwk.getStatus().isTicked())).map(Homework::getTitle).forEach(System.out::println);

Finally, the Student class contains methods to interact with homeworks.

You can tick a homework with the method Student#tickHomework(Homework). This method effectively toggles the tick status of the homework therefore if it is already ticked then it will un-tick and vice versa.

Homeworks can also be marked as seen which happens normally when you just click on a homework on the ClassCharts web app. This is done with the method Student#markHomeworkAsSeen(Homework).

When a student session expires, you should reauthenticate a student object using Student#reauthenticate().