pycses 0.1.3

CSES access framework for Python

PyCSES

CSES Access Framework for Python

Main Repo

Introduction

PyCSES is a Python library that provides access to the CSES format. It is designed to be simple and easy to use.

Functions

import cses

# Read a CSES file
parser = cses.CSESParser("path/to/file.cses.yaml")

# Check if the file is valid
if not cses.CSESParser.is_cses_file("path/to/file.cses.yaml"):
    print("Not a valid CSES file")

# Get subjects
for subject in parser.get_subjects():
    print("Name:", subject["name"])
    print("Simplified Name:", subject["simplified_name"])
    print("Teacher:", subject["teacher"])
    print("Room:", subject["room"])
    print("")

# Get schedules
for schedule in parser.get_schedules():
    print("Name:", schedule["name"])
    print("Enable Day:", schedule["enable_day"])
    print("Weeks:", schedule["weeks"])
    print("Classes:")
    for class_ in schedule["classes"]:
        print("  Subject:", class_["subject"])
        print("  Start Time:", class_["start_time"])
        print("  End Time:", class_["end_time"])
    print("")


# Generate a CSES file
generator = cses.CSESGenerator(version=1)

# Add a subject
generator.add_subject(name="Math", simplified_name="M", teacher="Mr. Wang", room="101")

# Add a schedule
generator.add_schedule(name="Monday", enable_day="mon", weeks="all", classes=[
    {
        "subject": "Math",
        "start_time": "08:00",
        "end_time": "09:00"
    },
    {
        "subject": "Biology",
        "start_time": "09:00",
        "end_time": "10:00"
    }
])

# Save the file
generator.save_to_file("path/to/file.cses.yaml")