An open API service indexing awesome lists of open source software.

https://github.com/h2owater425/python-comcigan

Comcigan api for Python
https://github.com/h2owater425/python-comcigan

Last synced: 3 months ago
JSON representation

Comcigan api for Python

Awesome Lists containing this project

README

        


banner

Comcigan api for Python


Hello school!

[![pypi version](https://img.shields.io/pypi/v/python-comcigan?style=flat-square)](https://pypi.org/project/python-comcigan/)
[![python version](https://img.shields.io/pypi/pyversions/python-comcigan?style=flat-square)](https://pypi.org/project/python-comcigan/)
[![license](https://img.shields.io/github/license/H2Owater425/python-comcigan?style=flat-square)](https://github.com/H2Owater425/python-comcigan/blob/main/LICENSE)


## Installation

```bash
$ pip install python-comcigan
```

## Features

- Get timetable
- Get subjects
- Get homeroom teachers
- Get teachers
- Get classCount

Without any dependencies!

## Usage/Examples

setup for `신흥중학교` in `경기`:
```python
from comcigan import Comcigan

comcigan: Comcigan = Comcigan(schoolName='신흥중학교', schoolRegion='경기')
```

synchronizing data with comcigan site:
```python
comcigan.synchronize()
```

printing `first period` of class `3-1` on `monday`:
```python
print(comcigan.getPeriods()[2][0][0][0])
```

printing homeroom teacher of `2-1`:
```python
print(comcigan.getHomeroomTeachers()[1][0])
```

printing period starting time of `sixth period`:
```python
print(comcigan.getPeriodStartingTimes()[5])
```