Contents

Litmos API

Documentation Status Travis-CI Build Status Coverage Status PyPI Package latest release PyPI Package monthly downloads PyPI Wheel Supported versions Supported implementations

Litmos REST API client for python 3.6 and above

  • Free software: BSD license

Installation

pip install litmos-api

Getting started

from litmos import Litmos


API_KEY = 'AXXXXXXXXXX'
LITMOS_APP_NAME = 'jins.litmos.com'
LITMOS_SERVER_URL = 'https://api.litmos.com/v1.svc'  # https://support.litmos.com/hc/en-us/articles/227734667-Overview-Developer-API
litmos = Litmos(API_KEY, LITMOS_APP_NAME, LITMOS_SERVER_URL)


# --- User ---
# retrieve users
all_users = litmos.User.all()

# retrieve all users (with all information populated - default /users/all API endpoint only returns a subset of user fields)
# much longer than .all() as individual requests to /find/{user-id} for every user are made
all_users_with_full_details = litmos.User.all(True)

#find user by Id
user = litmos.User.find('rnjx2WaQOa11')

# search for user by username
user = litmos.User.search('beelzebub@pieshop.net')

# update JobTitle & City fields
user.JobTitle = 'Pie eater'
user.City = 'Pieland'

# save user
user.save()

# deactivate user
user.deactivate()

# create user
user = litmos.User.create({
        'UserName': 'jobaba72@pieshop.net',
        'FirstName': 'Jo',
        'LastName': 'Baba72',
        'Email': 'jobaba72@pieshop.net'
    })

# get teams for a user
user.teams()

# remove all teams from user
user.remove_teams()

# delete user
# with Id
litmos.User.delete('YmrD112qlm41')

# instance delete
user.destroy()

# set a user's manager
user.set_manager('jdhaskdhlsa')

# or pass in a user object
manager = litmos.User.find('rnjx2WaQOa11')[0]
user.set_manager(manager)

# advanced custom fields
# https://support.litmos.com/hc/en-us/articles/227735427-User-Custom-Fields
user.update_advanced_custom_fields(
    [
        {"fieldnamex": "value1"},
        {"fieldnamey": "value2"}
    ]
)

# --- Team ---
# get all teams
all_teams = litmos.Team.all()

# find team by Id
team = litmos.Team.find('rnjx2WaQOa11')

# get team members
users = team.users()

# get team leaders
leaders = team.leaders()

# get team admins
admins = team.admins()

# create team (at root level)
team = litmos.Team.create({'Name': 'A-Team','Description': 'I pity the fool!'})

# add sub-team
sub_team = litmos.Team()
sub_team.Name = 'B-Team'
sub_team.Description = 'Woohoo'

sub_team_id = team.add_sub_team(sub_team)

# assign courses to team
course1 = litmos.Course.find('d2cJSDvIU0c1')
course2 = litmos.Course.find('d2cJSDvIU0c2')
team.assign_courses([course1, course2])

# unassign courses to team
course1 = litmos.Course.find('d2cJSDvIU0c1')
course2 = litmos.Course.find('d2cJSDvIU0c2')
team.unassign_courses([course1, course2])

# --- Team members ---

# add users to team
user1 = litmos.User.find('rnjx2WaQOa11')
user2 = litmos.User.find('rnjx2WaQOa12')
team.add_users([user1, user2])

# remove users from team
team.remove_user(user2)

# --- Team leaders ---
# promote user
team.promote_team_leader(user1)

# demote user
team.demote_team_leader(user1)

# --- Team admins ---
# promote user
team.promote_team_admin(user1)

# demote user
team.demote_team_admin(user1)

Development

To run the all tests run:

pip install -r requirements.txt
cd tests
nosetests

Installation

At the command line:

pip install litmos-api

Usage

To use litmos-api in a project:

import litmos_api

Reference

litmos_api

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Documentation improvements

litmos-api could always use more documentation, whether as part of the official litmos-api docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/charliequinn/python-litmos-api/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

To set up python-litmos-api for local development:

  1. Fork python-litmos-api (look for the “Fork” button).

  2. Clone your fork locally:

    git clone git@github.com:your_name_here/python-litmos-api.git

  3. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  4. When you’re done making changes, run all the checks, doc builder and spell checker with tox one command:

    tox

  5. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  6. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (run tox) [1].
  2. Update documentation when there’s new API, functionality etc.
  3. Add a note to CHANGELOG.rst about the changes.
  4. Add yourself to AUTHORS.rst.
[1]

If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request.

It will be slower though …

Tips

To run a subset of tests:

tox -e envname -- py.test -k test_myfeature

To run all the test environments in parallel (you need to pip install detox):

detox

Authors

  • Charlie Quinn
  • Ignacio Bolonio
  • Jeremy Knickerbocker

Changelog

1.0.0 (2020-07-30)

0.1.1 (2019-08-19)

  • Add assign and unassign courses methods to Team class.

0.1.0 (2016-12-07)

  • First release on PyPI.

Indices and tables