cau-services 0.0.3

CAU (Central Asian University) Services Python Client, for student projects

CAU (Central Asian University) Services Python Client

This opensource Python Client for services of Central Asian University. With this package you will be able to get timetable, attendance and other stuff, and automate for your purposes, this can be useful for pet-projects.

For now here:

• timetable (link to code)

Comming Soon:

• attendance
• marks

For more information on how Timetable API works, you can take a look to timetable.ipynb.

Usage

Installation

| I will try to make this README "begginers friendly", trying to explain the whole process of installation in details.

Create Python Environment:

python3 -m venv .venv

Activating python environment (For Linux/UNIX/MacOS):

source .venv/bin/activate
# OR
. .venv/bin/activate

Activating python environment (For Windows PowerShell):

# for PowerShell
.venv\Scripts\Activate.ps1

# CMD
.venv\Scripts\activate.bat

! FOR NOW PACKAGE ISN'T UPLOADED TO ANY PACKAGE REPOSITORY SO USE FOLLOWING INSTRUCTIONS TO INSTALL IT.

git clone https://github.com/timur-urunbaev/cau_services.git .

Inside the cloned repo write this command (so the package will be installed to your virtual environment):

python -m pip install .

Now you can use this package inside of your projects.

Download

from cau import Timetable

timetable = Timetable()
timetable.download()

Timetable

from cau import Timetable

timetable = Timetable()
timetable.download()
week: dict = timetable.get_week_by_class_id("<class_id>")

Then you can turn Python dict to json using any your preferable tool, e.g. json package:

import json
from cau import Timetable

timetable = Timetable()
timetable.download()
week: dict = timetable.get_week_by_class_id("<class_id>")

print(json.dumps(week)) # to see the result

Author

Urunbaev Timur