Address Issue #74 - [DOC] add typings to functions - Githubissues

Learnosity / learnosity-sdk-python

Learnosity SDK for Python

Apache License 2.0

7 stars 10 forks source link

Address Issue #74 - [DOC] add typings to functions #81

Closed michael-linnane-lrn closed 2 weeks ago

michael-linnane-lrn commented 4 weeks ago

Problem Statement

Open Issues this addresses: https://github.com/Learnosity/learnosity-sdk-python/issues/74 The functions used in this package do not have any type hints included. This PR addresses that.

PR Actions

closes #74

What was done

Added type and return hints to all functions
Added new unit tests for daatapi.py to improve coverage
Fixed usage of deprecated iterritems

How was this change tested

Ran mypy --strict learnosity_sdk to verify all type hints and issues
Ran test suite
Ran coverage checker
Ran learnosity-sdk-assessment-quickstart with local build

Notes and TODOs

There are usages of default arguments being set to {}. This is a dangerous action and should be addressed in another PR
[x] Tests added
[x] All testsuites passed
[x] make dist completed successfully