Skip to main content

Tool 4 partial Ed LMS API handling

Project description

Library: nftl-ed-lms-tools

This is a tool for Ed LMS API handling.

Source documentation of api is available here

PyPI project page

Installation

pip install nftl-ed-lms-tools

Usage

    from nftl_ed_lms_tools.client import EdClient

    ed = EdClient(token='xoxp-...')
    users = ed.get_users_api().get_users()

    if users:
        print('Yupi!')

Interface

Users

    from nftl_ed_lms_tools.client import EdClient

    ed = EdClient(token='xoxp-...')
    users = ed.get_users_api().get_users()

    if users:
        print('Yupi!')

Available methods

get_users()

Get a list of users.

API reference

Args:
    token: optional auth token that will overwrite EdApi token
Returns:
    None if data is invalid or users info as :py:class:`typing.List`
    when success

create_or_update_user()

Create or update a user.

API reference

Args:
    user_data: user data to create or update
    token: optional auth token that will overwrite EdApi token
Returns:
    None if data is invalid or users info as :py:class:`typing.List`
    when success

get_external_token()

Get users authentication token by externalId.

API reference

Args:
    external_id: users external identifier
    token: optional auth token that will overwrite EdApi token
Returns:
    None if data is invalid or users info as :py:class:`typing.List`
    when success

get_token()

Get users authentication token by user id.

API reference

Args:
    user_id: users external identifier
    token: optional auth token that will overwrite EdApi token    
Returns:
    None if data is invalid or users info as :py:class:`typing.List`
    when success

User groups

    from nftl_ed_lms_tools.client import EdClient

    ed = EdClient(token='xoxp-...')
    groups = ed.get_usersgroups_api().get()

    if groups:
        print('Yupi!')

Available methods

get()

Get a list of user groups.

API reference

Args:
    token: optional auth token that will overwrite EdApi token
Returns:
    None if data is invalid or user groups info as
    :py:class:`typing.List` when success

create_or_update_group()

Create or update a user group.

API reference

Args:
    group_data: group data to create or update
    token: optional auth token that will overwrite EdApi token
Returns:
    None if data is invalid or group info as :py:class:`typing.Dict`
    when success

Deployment how to

Available here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nftl_ed_lms_tools-0.1.5.tar.gz (5.0 kB view hashes)

Uploaded source

Built Distribution

nftl_ed_lms_tools-0.1.5-py3-none-any.whl (7.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page