mentortools/libs/: course-server-connector-v2-0.1.0+68947 metadata and description

Simple index

Mentortools Course Server

author OpenAPI Generator community
author_email OpenAPI Generator Community <team@openapitools.org>
description_content_type text/markdown
keywords OpenAPI,OpenAPI-Generator,Mentortools Course Server
project_urls
  • Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
requires_dist
  • python-dateutil>=2.8.2
  • aiohttp>=3.14.1
  • aiohttp-retry>=2.8.3
  • pydantic>=2.11
  • typing-extensions>=4.7.1
requires_python >=3.10
File Tox results History
course_server_connector_v2-0.1.0+68947-py3-none-any.whl
Size
349 KB
Type
Python Wheel
Python
3
course_server_connector_v2-0.1.0+68947.tar.gz
Size
151 KB
Type
Source

course-server-connector-v2

Course structure and lesson progress

This Python package is automatically generated by the OpenAPI Generator project:

Requirements.

Python 3.10+

Packaging uses standard [project] metadata and [dependency-groups] (PEP 621/735). Install the package with python -m pip install .; install development dependencies with Poetry 2.2 or newer using poetry install, or pip 25.1 or newer using python -m pip install --group dev. The latter installs the group, not the package.

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import course_server_connector_v2

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import course_server_connector_v2

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import course_server_connector_v2
from course_server_connector_v2.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = course_server_connector_v2.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer Authorization
configuration = course_server_connector_v2.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: ServerName Authorization
configuration.api_key['ServerName Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ServerName Authorization'] = 'Bearer'


# Enter a context with an instance of the API client
async with course_server_connector_v2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = course_server_connector_v2.AttachedFilesApi(api_client)
    file_id = 56 # int | 

    try:
        # Delete Attached File
        api_response = await api_instance.delete_attached_file_v1_attached_files_file_id_delete(file_id)
        print("The response of AttachedFilesApi->delete_attached_file_v1_attached_files_file_id_delete:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AttachedFilesApi->delete_attached_file_v1_attached_files_file_id_delete: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AttachedFilesApi delete_attached_file_v1_attached_files_file_id_delete DELETE /v1/attached_files/{file_id} Delete Attached File
AttachedFilesApi patch_attached_file_v1_attached_files_file_id_patch PATCH /v1/attached_files/{file_id} Patch Attached File
ContentBlocksApi delete_block_v1_content_blocks_block_id_delete DELETE /v1/content_blocks/{block_id} Delete Block
ContentBlocksApi get_block_v1_content_blocks_block_id_get GET /v1/content_blocks/{block_id} Get Block
ContentBlocksApi history_v1_content_blocks_block_id_history_get GET /v1/content_blocks/{block_id}/history History
ContentBlocksApi patch_block_v1_content_blocks_block_id_patch PATCH /v1/content_blocks/{block_id} Patch Block
ContentBlocksApi restore_block_v1_content_blocks_block_id_restore_post POST /v1/content_blocks/{block_id}/restore Restore Block
ContentBlocksApi revert_v1_content_blocks_block_id_revert_post POST /v1/content_blocks/{block_id}/revert Revert
CourseCategoriesApi create_category_v1_course_categories_post POST /v1/course_categories Create Category
CourseCategoriesApi delete_category_v1_course_categories_category_id_delete DELETE /v1/course_categories/{category_id} Delete Category
CourseCategoriesApi list_categories_v1_course_categories_get GET /v1/course_categories List Categories
CourseCategoriesApi patch_category_v1_course_categories_category_id_patch PATCH /v1/course_categories/{category_id} Patch Category
CourseTemplatesApi count_templates_v1_course_templates_count_get GET /v1/course_templates/count Count Templates
CourseTemplatesApi get_template_lesson_v1_course_templates_course_id_lessons_lesson_id_get GET /v1/course_templates/{course_id}/lessons/{lesson_id} Get Template Lesson
CourseTemplatesApi get_template_module_v1_course_templates_course_id_modules_module_id_get GET /v1/course_templates/{course_id}/modules/{module_id} Get Template Module
CourseTemplatesApi get_template_submodule_v1_course_templates_course_id_submodules_submodule_id_get GET /v1/course_templates/{course_id}/submodules/{submodule_id} Get Template Submodule
CourseTemplatesApi get_template_v1_course_templates_course_id_get GET /v1/course_templates/{course_id} Get Template
CourseTemplatesApi list_templates_v1_course_templates_get GET /v1/course_templates List Templates
CourseTemplatesApi patch_template_v1_course_templates_course_id_patch PATCH /v1/course_templates/{course_id} Patch Template
CourseTemplatesApi publish_template_v1_course_templates_course_id_publish_post POST /v1/course_templates/{course_id}/publish Publish Template
CourseTemplatesApi template_structure_v1_course_templates_course_id_structure_get GET /v1/course_templates/{course_id}/structure Template Structure
CourseTemplatesApi unpublish_template_v1_course_templates_course_id_unpublish_post POST /v1/course_templates/{course_id}/unpublish Unpublish Template
CoursesApi copy_course_v1_courses_course_id_copy_post POST /v1/courses/{course_id}/copy Copy Course
CoursesApi count_courses_v1_courses_count_get GET /v1/courses/count Count Courses
CoursesApi create_course_v1_courses_post POST /v1/courses Create Course
CoursesApi get_course_v1_courses_course_id_get GET /v1/courses/{course_id} Get Course
CoursesApi list_courses_v1_courses_get GET /v1/courses List Courses
CoursesApi patch_course_v1_courses_course_id_patch PATCH /v1/courses/{course_id} Patch Course
CoursesApi restore_course_v1_courses_course_id_restore_post POST /v1/courses/{course_id}/restore Restore Course
CoursesApi structure_v1_courses_course_id_structure_get GET /v1/courses/{course_id}/structure Structure
CoursesApi trash_course_v1_courses_course_id_delete DELETE /v1/courses/{course_id} Trash Course
LessonsApi add_attached_file_v1_lessons_lesson_id_attached_files_post POST /v1/lessons/{lesson_id}/attached_files Add Attached File
LessonsApi copy_lesson_v1_lessons_lesson_id_copy_post POST /v1/lessons/{lesson_id}/copy Copy Lesson
LessonsApi create_block_v1_lessons_lesson_id_content_blocks_post POST /v1/lessons/{lesson_id}/content_blocks Create Block
LessonsApi create_lesson_v1_lessons_post POST /v1/lessons Create Lesson
LessonsApi create_question_v1_lessons_lesson_id_questions_post POST /v1/lessons/{lesson_id}/questions Create Question
LessonsApi delete_lesson_v1_lessons_lesson_id_delete DELETE /v1/lessons/{lesson_id} Delete Lesson
LessonsApi get_lesson_by_key_v1_lessons_by_key_public_key_get GET /v1/lessons/by_key/{public_key} Get Lesson By Key
LessonsApi get_lesson_v1_lessons_lesson_id_get GET /v1/lessons/{lesson_id} Get Lesson
LessonsApi grant_lock_bypass_v1_lessons_lesson_id_lock_bypasses_member_id_put PUT /v1/lessons/{lesson_id}/lock_bypasses/{member_id} Grant Lock Bypass
LessonsApi list_lock_bypasses_v1_lessons_lesson_id_lock_bypasses_get GET /v1/lessons/{lesson_id}/lock_bypasses List Lock Bypasses
LessonsApi patch_lesson_v1_lessons_lesson_id_patch PATCH /v1/lessons/{lesson_id} Patch Lesson
LessonsApi quiz_versions_v1_lessons_lesson_id_quiz_versions_get GET /v1/lessons/{lesson_id}/quiz/versions Quiz Versions
LessonsApi restore_lesson_v1_lessons_lesson_id_restore_post POST /v1/lessons/{lesson_id}/restore Restore Lesson
LessonsApi revoke_lock_bypass_v1_lessons_lesson_id_lock_bypasses_member_id_delete DELETE /v1/lessons/{lesson_id}/lock_bypasses/{member_id} Revoke Lock Bypass
MemberApi add_favorite_v1_member_favorites_lesson_id_put PUT /v1/member/favorites/{lesson_id} Add Favorite
MemberApi answer_v1_member_attempts_attempt_id_answers_question_id_put PUT /v1/member/attempts/{attempt_id}/answers/{question_id} Answer
MemberApi attempt_v1_member_attempts_attempt_id_get GET /v1/member/attempts/{attempt_id} Attempt
MemberApi attempts_v1_member_lessons_lesson_id_attempts_get GET /v1/member/lessons/{lesson_id}/attempts Attempts
MemberApi complete_v1_member_lessons_lesson_id_complete_post POST /v1/member/lessons/{lesson_id}/complete Complete
MemberApi course_catalogue_count_v1_member_course_catalogue_collection_count_get GET /v1/member/course_catalogue/{collection}/count Course Catalogue Count
MemberApi course_catalogue_v1_member_course_catalogue_collection_get GET /v1/member/course_catalogue/{collection} Course Catalogue
MemberApi course_progress_v1_member_courses_course_id_progress_get GET /v1/member/courses/{course_id}/progress Course Progress
MemberApi course_v1_member_courses_course_id_get GET /v1/member/courses/{course_id} Course
MemberApi courses_v1_member_courses_get GET /v1/member/courses Courses
MemberApi favorites_v1_member_favorites_get GET /v1/member/favorites Favorites
MemberApi lesson_by_key_v1_member_lessons_by_key_public_key_get GET /v1/member/lessons/by_key/{public_key} Lesson By Key
MemberApi lesson_v1_member_lessons_lesson_id_get GET /v1/member/lessons/{lesson_id} Lesson
MemberApi move_favorite_v1_member_favorites_lesson_id_patch PATCH /v1/member/favorites/{lesson_id} Move Favorite
MemberApi preview_course_catalogue_count_v1_member_preview_course_catalogue_collection_count_get GET /v1/member/preview/course_catalogue/{collection}/count Preview Course Catalogue Count
MemberApi preview_course_catalogue_v1_member_preview_course_catalogue_collection_get GET /v1/member/preview/course_catalogue/{collection} Preview Course Catalogue
MemberApi remove_favorite_v1_member_favorites_lesson_id_delete DELETE /v1/member/favorites/{lesson_id} Remove Favorite
MemberApi reset_attempt_v1_member_attempts_attempt_id_reset_post POST /v1/member/attempts/{attempt_id}/reset Reset Attempt
MemberApi start_attempt_v1_member_lessons_lesson_id_attempts_post POST /v1/member/lessons/{lesson_id}/attempts Start Attempt
MemberApi structure_v1_member_courses_course_id_structure_get GET /v1/member/courses/{course_id}/structure Structure
MemberApi submit_v1_member_attempts_attempt_id_submit_post POST /v1/member/attempts/{attempt_id}/submit Submit
MemberApi uncomplete_v1_member_lessons_lesson_id_uncomplete_post POST /v1/member/lessons/{lesson_id}/uncomplete Uncomplete
MemberApi view_v1_member_lessons_lesson_id_view_post POST /v1/member/lessons/{lesson_id}/view View
ModulesApi copy_module_v1_modules_module_id_copy_post POST /v1/modules/{module_id}/copy Copy Module
ModulesApi create_module_v1_modules_post POST /v1/modules Create Module
ModulesApi delete_module_v1_modules_module_id_delete DELETE /v1/modules/{module_id} Delete Module
ModulesApi get_module_v1_modules_module_id_get GET /v1/modules/{module_id} Get Module
ModulesApi patch_module_v1_modules_module_id_patch PATCH /v1/modules/{module_id} Patch Module
ModulesApi restore_module_v1_modules_module_id_restore_post POST /v1/modules/{module_id}/restore Restore Module
OffersApi create_offer_v1_courses_course_id_offers_post POST /v1/courses/{course_id}/offers Create Offer
OffersApi delete_offer_v1_course_offers_offer_id_delete DELETE /v1/course_offers/{offer_id} Delete Offer
OffersApi list_offers_v1_courses_course_id_offers_get GET /v1/courses/{course_id}/offers List Offers
OffersApi make_primary_v1_course_offers_offer_id_make_primary_post POST /v1/course_offers/{offer_id}/make_primary Make Primary
OffersApi patch_offer_v1_course_offers_offer_id_patch PATCH /v1/course_offers/{offer_id} Patch Offer
PortalCourseSettingsApi get_member_portal_course_settings_v1_member_portal_course_settings_get GET /v1/member/portal_course_settings Get Member Portal Course Settings
PortalCourseSettingsApi get_portal_course_settings_v1_portal_course_settings_get GET /v1/portal_course_settings Get Portal Course Settings
PortalCourseSettingsApi patch_portal_course_settings_v1_portal_course_settings_patch PATCH /v1/portal_course_settings Patch Portal Course Settings
PublicApi link_courses_v1_public_links_slug_courses_get GET /v1/public/links/{slug}/courses Link Courses
QuestionsApi delete_question_v1_questions_question_id_delete DELETE /v1/questions/{question_id} Delete Question
QuestionsApi put_question_v1_questions_question_id_put PUT /v1/questions/{question_id} Put Question
ServerApi access_tree_for_resource_v1_access_trees_by_resource_resource_type_resource_id_get GET /v1/access_trees/by_resource/{resource_type}/{resource_id} Access Tree For Resource
ServerApi access_trees_count_v1_access_trees_count_get GET /v1/access_trees/count Access Trees Count
ServerApi access_trees_v1_access_trees_get GET /v1/access_trees Access Trees
ServerApi course_content_v1_courses_course_id_content_get GET /v1/courses/{course_id}/content Course Content
ServerApi file_references_v1_portals_portal_id_file_references_get GET /v1/portals/{portal_id}/file_references File References
SubmodulesApi copy_submodule_v1_submodules_submodule_id_copy_post POST /v1/submodules/{submodule_id}/copy Copy Submodule
SubmodulesApi create_submodule_v1_submodules_post POST /v1/submodules Create Submodule
SubmodulesApi delete_submodule_v1_submodules_submodule_id_delete DELETE /v1/submodules/{submodule_id} Delete Submodule
SubmodulesApi get_submodule_v1_submodules_submodule_id_get GET /v1/submodules/{submodule_id} Get Submodule
SubmodulesApi patch_submodule_v1_submodules_submodule_id_patch PATCH /v1/submodules/{submodule_id} Patch Submodule
SubmodulesApi restore_submodule_v1_submodules_submodule_id_restore_post POST /v1/submodules/{submodule_id}/restore Restore Submodule

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

Bearer Authorization

ServerName Authorization

Author