Examples

This page is a collection of examples that demonstrate the use of pymyku.

Using client

Import Client from pymyku and initializing it with your credentials:

• USERNAME – Your nontri account username.

• PASSWORD – Your nontri account password.

from pymyku import Client

client = Client('USERNAME', 'PASSWORD')

The initialization method of the Client will automatically call Client.initialize() methods to get the data required to work with the API.

Fetching

The word fetch for this module means getting a response from the API by sending a GET or POST request to the API.

The following examples show all methods of pymyku that fetch data from the APIs using the functions from requests.

For example:

client.fetch_schedule()

Output: (the response from url.SCHEDULE)

{
    "code": "success",
    "results": [{
        "std_id": -1,
        "std_code": "x",
        "gpax": -1.0,
        "total_credit": -1
    }]
}

Geting

The word get for this module means getting a attribute from the client or the result from the API (not response).

Arrtibutes

Attributes/Properties in the Client object can be accessed directly by using the dot operator.

#: For getting the login response.
client.login_response

#: For getting the access token.
client.access_token

#: For getting your student code. Extracted from the login response.
client.std_code

Or by using the Client.get() method.

First, the enums from pymyku.attribute need to be imported to use with this method.

from pymyku.attribute import FetchedResponse, Token, Student

Next, you can use the Client.get() method to get the attributes.

#: For getting the login response.
client.get(FetchedResponse.LOGIN_RESPONSE)

#: For getting the access token.
client.get(Token.ACCESS_TOKEN)

#: For getting your student code. Extracted from the login response.
client.get(Student.STD_CODE)

Result from the API

Methods that starts with get_ are methods that return the result from the API response.

For example:

client.get_enrolled_subjects(2565, 0)

This will return a list of subjects that you enrolled in the summer term of 2565.

Searching

Methods that starts with search will return the result from the API that is related to searching.

For example:

client.search_subject('013')

This will return a list of subjects that start with the code “013”.

Using requests

Import the requests module from pymyku and login.

from pymyku import requests, APP_KEY

login_res = requests.login('USERNAME', 'PASSWORD')

Using the functions

You can use the predefined functions in requests to send requests to the MyKU API straightly.

Most functions have parameters that are required to send the request. e.g. access_token, std_id, etc.

But with pymyku.requests, you can pass the login response to the function. The function will extract required parameters from the login response automatically.

requests.get_group_course(login_response = login_res)

You can also pass the Client object to the function.

requests.get_group_course(client = client)

Otherwise, you pass the required parameters directly.

requests.get_group_course(access_token = 'ACCESS_TOKEN', std_id = 'STD_CODE')

Doing it directly

You can also use the requests module to send GET or POST request to the API you want.

requests.get(url = 'URL', headers = {'app-key':APP_KEY, 'x-access-token':'ACCESS_TOKEN'} params = {'THE_REQUIRED_PARAMETERS': 'THE_REQUIRED_PARAMETERS'})

To get the request headers easily, you can use the utils.gen_request_headers() function to generate the headers from the login response or your access token.

from pymyku import utils

headers = utils.gen_request_headers('ACCESS_TOKEN')

#headers = utils.gen_request_headers(login_res)

requests.get(url = 'URL', headers = headers, params = {'THE_REQUIRED_PARAMETERS': 'THE_REQUIRED_PARAMETERS'})

Using the utilities

Extracting the attributes

You can use utils.extract() to extract the attributes from the response using enums from attribute.

Supported responses are:

• Login response

• Schedule response

Examples:

from pymyku import requests, utils
from pymyku.attribute import User, Schedule

login_res = requests.login('USERNAME', 'PASSWORD')
schedule_res = requests.get_schedule(login_response = login_res)

first_name = utils.extract(login_res, User.FIRST_NAME_EN)
last_name = utils.extract(login_res, User.LAST_NAME_EN)

academic_year = utils.extract(schedule_res, Schedule.ACADEMIC_YEAR)
semester = utils.extract(schedule_res, Schedule.SEMESTER)

Generating arguments for request

With the utils.gen_request_args_f() function, you can generate the arguments for requests.get() or requests.post() directly by passing the function from pymyku.requests and the required parameters.

e.g. for requests.get_schedule():

from pymyku import utils, requests

login_res = requests.login('USERNAME', 'PASSWORD')

args = utils.gen_request_args_f(requests.get_schedule, login_response=login_res)

#: You can also use client object by passing `client = your_client` instead of using the login response.
# args = utils.gen_request_args_f(requests.get_schedule, client=client)

schedule_res = requests.get(**args)

or if you want to pass the required parameters directly:

from pymyku import utils, requests

args = utils.gen_request_args_f(requests.get_schedule,
                                access_token='ACCESS_TOKEN',
                                user_type='USER_TYPE',
                                campus_code='CAMPUS_CODE',
                                faculty_code='FACULTY_CODE',
                                major_code='MAJOR_CODE',
                                student_status_code='STUDENT_STATUS_CODE')

schedule_res = requests.get(**args)