learnosity/learnosity-sdk-python

Learnosity SDK for Python

learnosity-sdk-python's Issues

Incorrect response data handling

Using the data api itembank/questions endpoint and requesting data with request.item_references on all API versions does not actually return any data through the DataAPI.results_iter (works if you pass request.references instead).

I believe the default is to expect a list to be returned in the response['data'] object however a dict is being returned through the itembank/questions api endpoint and will thus only return all of the item keys we requested. Not sure if this is intended but I couldn't find anything pointing that this is.

A simple solution may be to check in the results_iter function if the returned response['data'] is a dict and to just return it as a list of the single object, not efficient but will work with existing api.

if isinstance(response['data'], dict):
    for key, value in response['data'].items():
        yield {key:value}
else:
    for result in response['data']:
        yield result

Type stubs

Hey Learnosity team,

I was wondering if there are any plans to publish type stubs for this repository. I work in a Python environment with strict type-checking using a third party type-checker (pyright). It's a pretty small repository so I'd be happy to PR some type stubs (in the form of .pyi files adjacent to the existing .py files) so that others using type-checkers can access this repository as well.

Best,
Violet

Authoring Examples missing from reference.

It would be really neat if you'd include some examples of authoring questions/activities with this SDK. Especially if you could document all of the possible fields the data_request can have when doing so!

No module named 'learnosity_sdk.uuid'

Hello getting an error

from learnosity_sdk.uuid import Uuid
ModuleNotFoundError: No module named 'learnosity_sdk.uuid'

From sample in https://github.com/Learnosity/learnosity-sdk-python#usage
I am not sure if this is an old option that has been deprecated, or an error in the sample code

Please look into it as soon as you can
Cheer

Possible bug?

I haven't tested this, but I am looking over the code, and can't imagine why this line would work:

https://github.com/Learnosity/learnosity-sdk-python/blob/master/learnosity_sdk/request.py#L73

I'm pretty sure it should be:

  output.update(json.loads(self.request_string))

as it has on line 66.

I'm converting this over into a rails sdk and just spotted this issue. Tried in python console and the following causes an error:

{}.update('string')