{"id":22173475,"url":"https://github.com/jlumbroso/oneup-sdk-python","last_synced_at":"2025-03-24T17:46:21.084Z","repository":{"id":44862783,"uuid":"239295367","full_name":"jlumbroso/oneup-sdk-python","owner":"jlumbroso","description":"A Python SDK to integrate with the OneUp Learning platform by West-Salem State University","archived":false,"fork":false,"pushed_at":"2022-12-08T03:35:47.000Z","size":119,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-02T03:11:54.845Z","etag":null,"topics":["cs-education","gamification","sdk-python"],"latest_commit_sha":null,"homepage":"https://oneup.wssu.edu/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jlumbroso.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-09T11:46:24.000Z","updated_at":"2022-04-05T12:19:07.000Z","dependencies_parsed_at":"2023-01-25T04:31:02.627Z","dependency_job_id":null,"html_url":"https://github.com/jlumbroso/oneup-sdk-python","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlumbroso%2Foneup-sdk-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlumbroso%2Foneup-sdk-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlumbroso%2Foneup-sdk-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlumbroso%2Foneup-sdk-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jlumbroso","download_url":"https://codeload.github.com/jlumbroso/oneup-sdk-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245320710,"owners_count":20596236,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cs-education","gamification","sdk-python"],"created_at":"2024-12-02T07:33:34.159Z","updated_at":"2025-03-24T17:46:21.058Z","avatar_url":"https://github.com/jlumbroso.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OneUp Learning SDK\n\nThis is a Python SDK to allow for the scripting and integration of the [OneUp Learning platform](https://oneup.wssu.edu/login) developed by West-Salem State University.\n\n## Installation\n\nThe package is available through Python's package management system:\n\n```shell\npip install oneupsdk\n```\n\n## Configuration\n\nYou can request an account by contacting [Darina Dicheva](https://www.wssu.edu/profiles/dichevad/index.html). Once you have an account, create a `config.yaml` file containing your authentication information. This file is parsed by the SDK to authenticate your API calls.\n\n```yaml\noneup:\n  username: \"username\"\n  password: \"OneUP-P4ssW04d!\"\n```\n\n## Usage\n\nBelow are the macros that are available from the subpackage `oneupsdk.integration`. Note that a call to `set_active_course()` must be made before most of the other calls will work.\n\n- Courses\n    - `get_instructor_courses()`\n    - `set_active_course(course_id)`\n    - `get_active_course()`\n\n- Students\n    - `get_enrolled_students()`\n    - `get_student_by_id(user_id)`\n    - `get_student_by_username(username)`\n    - `add_student(email, password, first=None, last=None, user_id=None)`\n    - `modify_student(username, email=None, password=None, first=None, last=None, new_user_id=None)`\n    - `delete_student(user_id)`\n\n- Activities\n    - `get_activities()` \n    - `get_activity_by_id(activity_id)`\n    - `create_activity(name, category_id=None, **kwargs)`\n    - `modify_activity(activity_id, **kwargs)`\n    - `post_activity_points(activity_id, data, as_dict=False)`\n    - `delete_activity(activity_id)`\n    - Activity categories\n        - `get_activity_categories()`\n        - `get_default_activity_category()`\n        - `create_activity_category(name)`\n        - `delete_activity_category(category_id)`\n\n## References\n\nDicheva, Darina, Keith Irwin, and Christo Dichev. \"OneUp learning: a course gamification platform.\" In _International Conference on Games and Learning Alliance_, pp. 148-158. Springer, Cham, 2017. ([link](https://link.springer.com/chapter/10.1007/978-3-319-71940-5_14))\n\nDicheva, Darina, Keith Irwin, and Christo Dichev. \"OneUp: Supporting Practical and Experimental Gamification of Learning.\" _International Journal of Serious Games_ 5, no. 3 (2018): 5-21. ([link](http://journal.seriousgamessociety.org/index.php/IJSG/article/view/236))\n\nDicheva, Darina, Keith Irwin, and Christo Dichev. \"OneUp: Engaging Students in a Gamified Data Structures Course.\" In _Proceedings of the 50th ACM Technical Symposium on Computer Science Education_, pp. 386-392. 2019. ([link](https://dl.acm.org/doi/abs/10.1145/3287324.3287480))","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlumbroso%2Foneup-sdk-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjlumbroso%2Foneup-sdk-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlumbroso%2Foneup-sdk-python/lists"}