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
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.
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.
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.
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.
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.
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.
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
Built Distribution
Close
Hashes for nftl_ed_lms_tools-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a825cbd03f3e35a748a2533fa417294530be7489bdea338988b451a7088612b2 |
|
MD5 | 264d100899cd0abfc70c29d45a996a8e |
|
BLAKE2b-256 | 96135435093b8a1fc4944542f7c1d99cfe515e8df44a370c4057cbdbf6eaaee8 |