nokey.education package

Submodules

nokey.education.university_domains_and_names module

class nokey.education.university_domains_and_names.UniversityDomainsAndNames(use_caching=False, cache_name='university_cache', backend='sqlite', expire_after=3600)[source]

Bases: object

A class to interact with the University Domains and Names API.

base_url

The base url for the University Domains and Names API.

about

A short description of the API.

get_docs_url()[source]

Returns the url for the University Domains and Names API documentation.

Parameters:

None –

Returns:

URL for API documentation.

Return type:

string

get_university_name_and_domain(name, country, offset=None, limit=None)[source]

Returns university names and domains for the given parameters.

Parameters:

  • name (str) – Whole or partial name of university in question.

  • country (str) – Country of university in question.

  • offset (int) – Optional pagination parameter to limit search. Defaults to None.

  • limit (int) – Optional pagination parameter to limit number of results. Defaults to None.

Returns:

List containing universities matching parameters with their respective domains.

Return type:

dict

update_list()[source]

Forces a refresh of the API, since the API won’t automatically update the dataset if it changes.

Parameters:

None –

Returns:

An updated, refreshed list of the university dataset.

Return type:

dict

Module contents