https://github.com/jamesatjaminit/classcharts-to-classtimetable
A Deno library to convert your ClassCharts timetable to a classtimetable.app timetable export.
https://github.com/jamesatjaminit/classcharts-to-classtimetable
classcharts classtimetable deno
Last synced: about 1 year ago
JSON representation
A Deno library to convert your ClassCharts timetable to a classtimetable.app timetable export.
- Host: GitHub
- URL: https://github.com/jamesatjaminit/classcharts-to-classtimetable
- Owner: jamesatjaminit
- License: isc
- Created: 2023-09-24T16:20:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-08T23:05:46.000Z (over 2 years ago)
- Last Synced: 2023-11-10T10:52:33.222Z (over 2 years ago)
- Topics: classcharts, classtimetable, deno
- Language: TypeScript
- Homepage: https://deno.land/x/classcharts_to_classtimetable/
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ClassCharts To ClassTimetable
A small Deno library to convert a ClassCharts timetable to a
[ClassTimetable](https://classtimetable.app/) export.
## CLI Usage
```bash
deno run --allow-net --allow-write https://deno.land/x/classcharts_to_classtimetable/cli.ts \
--code "StudentCodeHere" \
--dob "DD/MM/YYYY" \
--number-of-weeks 2 \
--out Timetable.timetable
```
For a list of all options use:
```bash
deno run https://deno.land/x/classcharts_to_classtimetable/cli.ts --help
```
## Library Usage
```typescript
import { ClassChartsToClassTimetable } from "https://deno.land/x/classcharts_to_classtimetable/mod.ts";
const client = new ClassChartsToClassTimetable({
code: "StudentCodeHere",
dateOfBirth: "DD/MM/YYYY",
});
const xml = await client.generateTimetable({
numberOfWeeks: 2,
numberOfDaysInWeek: 5,
templates: {
title: "",
info: "",
}, // Optional templates, see below
});
const encoder = new TextEncoder();
Deno.writeFile(`Timetable.timetable`, encoder.encode(xml));
```
## Templates
Templates can be used to customise the output of each lesson. The defaults are:
- Title: "%s - %r"
- E.g. "Computer Science - 1.1"
- Info: "%t\n%pn"
- E.g. "Mr. Smith\nPeriod 1"
### Available Variables
| Variable | Description |
| -------- | --------------------- |
| %t | Teacher name |
| %n | Lesson name |
| %s | Subject name |
| %a | Is alternative lesson |
| %pn | Period name |
| %pnum | Period number |
| %r | Room name |
| %d | Lesson date |
| %st | Lesson start time |
| %et | Lesson end time |
| %k | Lesson key |
| %na | Lesson note abstract |
| %no | Lesson note |
| %pna | Pupil note abstract |
| %pnote | Pupil note |
| %pnr | Pupil note raw |