openedx.core.djangoapps.content_libraries package#

Subpackages#

Submodules#

openedx.core.djangoapps.content_libraries.api module#

Python API for content libraries#

Via views.py, most of these API methods are also exposed as a REST API.

The API methods in this file are focused on authoring and specific to content libraries; they wouldn’t necessarily apply or work in other learning contexts such as courses, blogs, “pathways,” etc.

** As this is an authoring-focused API, all API methods in this file deal with the DRAFT version of the content library.**

Some of these methods will work and may be used from the LMS if needed (mostly for test setup; other use is discouraged), but some of the implementation details rely on Studio so other methods will raise errors if called from the LMS. (The REST API is not available at all from the LMS.)

Any APIs that use/affect content libraries but are generic enough to work in other learning contexts too are in the core XBlock python/REST API at openedx.core.djangoapps.xblock.api/rest_api.

For example, to render a content library XBlock as HTML, one can use the generic:

render_block_view(block, view_name, user)

That is an API in openedx.core.djangoapps.xblock.api (use it from Studio for the draft version, from the LMS for published version).

There are one or two methods in this file that have some overlap with the core XBlock API; for example, this content library API provides a get_library_block() which returns metadata about an XBlock; it’s in this API because it also returns data about whether or not the XBlock has unpublished edits, which is an authoring-only concern. Likewise, APIs for getting/setting an individual XBlock’s OLX directly seem more appropriate for small, reusable components in content libraries and may not be appropriate for other learning contexts so they are implemented here in the library API only. In the future, if we find a need for these in most other learning contexts then those methods could be promoted to the core XBlock API and made generic.

Import from Courseware#

Content Libraries can import blocks from Courseware (Modulestore). The import can be done per-course, by listing its content, and supports both access to remote platform instances as well as local modulestore APIs. Additionally, there are Celery-based interfaces suitable for background processing controlled through RESTful APIs (see views).

class openedx.core.djangoapps.content_libraries.api.AccessLevel#

Bases: object

Enum defining library access levels/permissions

ADMIN_LEVEL = 'admin'#
AUTHOR_LEVEL = 'author'#
NO_ACCESS = None#
READ_LEVEL = 'read'#
class openedx.core.djangoapps.content_libraries.api.BaseEdxImportClient(library_key=None, library=None)#

Bases: ABC

Base class for all courseware import clients.

Import clients are wrappers tailored to implement the steps used in the import APIs and can leverage different backends. It is not aimed towards being a generic API client for Open edX.

EXPORTABLE_BLOCK_TYPES = {'drag-and-drop-v2', 'html', 'problem', 'video'}#
abstract get_block_data(block_key)#

Get the block’s OLX and static files, if any.

abstract get_block_static_data(asset_file)#

Get the contents of an asset_file..

abstract get_export_keys(course_key)#

Get all exportable block keys of a given course.

import_block(modulestore_key)#

Import a single modulestore block.

import_blocks_from_course(course_key, progress_callback)#

Import all eligible blocks from course key.

Progress is reported through progress_callback, guaranteed to be called within an exception handler if exception is not None.

exception openedx.core.djangoapps.content_libraries.api.BlockLimitReachedError#

Bases: Exception

Maximum number of allowed XBlocks in the library reached

exception openedx.core.djangoapps.content_libraries.api.ContentLibraryBlockNotFound(usage_id)#

Bases: XBlockNotFoundError

XBlock not found in the content library

class openedx.core.djangoapps.content_libraries.api.ContentLibraryMetadata(key: LibraryLocatorV2, bundle_uuid: UUID, title='', description='', num_blocks=0, version=0, type='complex', last_published: datetime | None = None, has_unpublished_changes=False, has_unpublished_deletes=False, allow_lti=False, allow_public_learning=False, allow_public_read=False, license='')#

Bases: object

Class that represents the metadata about a content library.

class openedx.core.djangoapps.content_libraries.api.ContentLibraryPermissionEntry(user: AbstractUser | None = None, group: Group | None = None, access_level=None)#

Bases: object

A user or group granted permission to use a content library.

class openedx.core.djangoapps.content_libraries.api.EdxApiImportClient(lms_url, studio_url, oauth_key, oauth_secret, *args, **kwargs)#

Bases: BaseEdxImportClient

An import client based on a remote Open Edx API interface.

URL_COURSES = '/api/courses/v1/courses/{course_key}'#
URL_MODULESTORE_BLOCK_OLX = '/api/olx-export/v1/xblock/{block_key}/'#
get_block_data(block_key)#

See parent’s docstring.

get_block_static_data(asset_file)#

See parent’s docstring.

get_export_keys(course_key)#

See parent’s docstring.

class openedx.core.djangoapps.content_libraries.api.EdxModulestoreImportClient(modulestore_instance=None, **kwargs)#

Bases: BaseEdxImportClient

An import client based on the local instance of modulestore.

get_block_data(block_key)#

Get block OLX by serializing it from modulestore directly.

get_block_static_data(asset_file)#

Get static content from its URL if available, otherwise from its data.

get_export_keys(course_key)#

Retrieve the course from modulestore and traverse its content tree.

exception openedx.core.djangoapps.content_libraries.api.IncompatibleTypesError#

Bases: Exception

Library type constraint violated

exception openedx.core.djangoapps.content_libraries.api.InvalidNameError#

Bases: ValueError

The specified name/identifier is not valid

exception openedx.core.djangoapps.content_libraries.api.LibraryAlreadyExists#

Bases: KeyError

A library with the specified slug already exists

exception openedx.core.djangoapps.content_libraries.api.LibraryBlockAlreadyExists#

Bases: KeyError

An XBlock with that ID already exists in the library

Bases: object

A link from a content library blockstore bundle to another blockstore bundle

exception openedx.core.djangoapps.content_libraries.api.LibraryPermissionIntegrityError#

Bases: IntegrityError

Thrown when an operation would cause insane permissions.

class openedx.core.djangoapps.content_libraries.api.LibraryXBlockMetadata(usage_key: LibraryUsageLocatorV2, def_key: BundleDefinitionLocator, display_name='', has_unpublished_changes=False)#

Bases: object

Class that represents the metadata about an XBlock in a content library.

class openedx.core.djangoapps.content_libraries.api.LibraryXBlockStaticFile(path='', url='', size=0)#

Bases: object

Class that represents a static file in a content library, associated with a particular XBlock.

class openedx.core.djangoapps.content_libraries.api.LibraryXBlockType(block_type='', display_name='')#

Bases: object

An XBlock type that can be added to a content library

openedx.core.djangoapps.content_libraries.api.add_library_block_static_asset_file(usage_key, file_name, file_content)#

Upload a static asset file into the library, to be associated with the specified XBlock. Will silently overwrite an existing file of the same name.

file_name should be a name like “doc.pdf”. It may optionally contain slashes

like ‘en/doc.pdf’

file_content should be a binary string.

Returns a LibraryXBlockStaticFile object.

Example

video_block = UsageKey.from_string(“lb:VideoTeam:python-intro:video:1”) add_library_block_static_asset_file(video_block, “subtitles-en.srt”, subtitles.encode(‘utf-8’))

Create a new link to the resource with the specified opaque key.

For now, only LibraryLocatorV2 opaque keys are supported.

openedx.core.djangoapps.content_libraries.api.create_library(collection_uuid, library_type, org, slug, title, description, allow_public_learning, allow_public_read, library_license)#

Create a new content library.

org: an organizations.models.Organization instance

slug: a slug for this library like ‘physics-problems’

title: title for this library

description: description of this library

allow_public_learning: Allow anyone to read/learn from blocks in the LMS

allow_public_read: Allow anyone to view blocks (including source) in Studio?

library_type: Deprecated parameter, not really used. Set to COMPLEX.

Returns a ContentLibraryMetadata instance.

openedx.core.djangoapps.content_libraries.api.create_library_block(library_key, block_type, definition_id)#

Create a new XBlock in this library of the specified type (e.g. “html”).

The ‘definition_id’ value (which should be a string like “problem1”) will be used as both the definition_id and the usage_id.

openedx.core.djangoapps.content_libraries.api.create_library_block_child(parent_usage_key, block_type, definition_id)#

Create a new XBlock definition in this library of the specified type (e.g. “html”), and add it as a child of the specified existing block.

The ‘definition_id’ value (which should be a string like “problem1”) will be used as both the definition_id and the usage_id of the child.

openedx.core.djangoapps.content_libraries.api.delete_library(library_key)#

Delete a content library

openedx.core.djangoapps.content_libraries.api.delete_library_block(usage_key, remove_from_parent=True)#

Delete the specified block from this library (and any children it has).

If the block’s definition (OLX file) is within this same library as the usage key, both the definition and the usage will be deleted.

If the usage points to a definition in a linked bundle, the usage will be deleted but the link and the linked bundle will be unaffected.

If the block is in use by some other bundle that links to this one, that will not prevent deletion of the definition.

remove_from_parent: modify the parent to remove the reference to this

delete block. This should always be true except when this function calls itself recursively.

openedx.core.djangoapps.content_libraries.api.delete_library_block_static_asset_file(usage_key, file_name)#

Delete a static asset file from the library.

Example

video_block = UsageKey.from_string(“lb:VideoTeam:python-intro:video:1”) delete_library_block_static_asset_file(video_block, “subtitles-en.srt”)

openedx.core.djangoapps.content_libraries.api.get_allowed_block_types(library_key)#

Get a list of XBlock types that can be added to the specified content library.

Get the list of bundles/libraries linked to this content library.

Returns LibraryBundleLink objects (defined above).

Because every content library is a blockstore bundle, it can have “links” to other bundles, which may or may not be content libraries. This allows using XBlocks (or perhaps even static assets etc.) from another bundle without needing to duplicate/copy the data.

Links always point to a specific published version of the target bundle. Links are identified by a slug-like ID, e.g. “link1”

openedx.core.djangoapps.content_libraries.api.get_libraries_for_user(user, org=None, library_type=None)#

Return content libraries that the user has permission to view.

openedx.core.djangoapps.content_libraries.api.get_library(library_key)#

Get the library with the specified key. Does not check permissions. returns a ContentLibraryMetadata instance.

Raises ContentLibraryNotFound if the library doesn’t exist.

openedx.core.djangoapps.content_libraries.api.get_library_block(usage_key)#

Get metadata (LibraryXBlockMetadata) about one specific XBlock in a library

To load the actual XBlock instance, use

openedx.core.djangoapps.xblock.api.load_block()

instead.

openedx.core.djangoapps.content_libraries.api.get_library_block_olx(usage_key)#

Get the OLX source of the given XBlock.

openedx.core.djangoapps.content_libraries.api.get_library_block_static_asset_files(usage_key)#

Given an XBlock in a content library, list all the static asset files associated with that XBlock.

Returns a list of LibraryXBlockStaticFile objects.

openedx.core.djangoapps.content_libraries.api.get_library_blocks(library_key, text_search=None, block_types=None)#

Get the list of top-level XBlocks in the specified library.

Returns a list of LibraryXBlockMetadata objects

openedx.core.djangoapps.content_libraries.api.get_library_team(library_key)#

Get the list of users/groups granted permission to use this library.

openedx.core.djangoapps.content_libraries.api.get_library_user_permissions(library_key, user)#

Fetch the specified user’s access information. Will return None if no permissions have been granted.

openedx.core.djangoapps.content_libraries.api.get_metadata_from_index(queryset, text_search=None)#

Take a list of ContentLibrary objects and return metadata stored in ContentLibraryIndex.

openedx.core.djangoapps.content_libraries.api.import_blocks_create_task(library_key, course_key)#

Create a new import block task.

This API will schedule a celery task to perform the import, and it returns a import task object for polling.

openedx.core.djangoapps.content_libraries.api.publish_changes(library_key)#

Publish all pending changes to the specified library.

openedx.core.djangoapps.content_libraries.api.require_permission_for_library_key(library_key, user, permission)#

Given any of the content library permission strings defined in openedx.core.djangoapps.content_libraries.permissions, check if the given user has that permission for the library with the specified library ID.

Raises django.core.exceptions.PermissionDenied if the user doesn’t have permission.

openedx.core.djangoapps.content_libraries.api.revert_changes(library_key)#

Revert all pending changes to the specified library, restoring it to the last published version.

openedx.core.djangoapps.content_libraries.api.set_library_block_olx(usage_key, new_olx_str)#

Replace the OLX source of the given XBlock. This is only meant for use by developers or API client applications, as very little validation is done and this can easily result in a broken XBlock that won’t load.

openedx.core.djangoapps.content_libraries.api.set_library_group_permissions(library_key, group, access_level)#

Change the specified group’s level of access to this library.

access_level should be one of the AccessLevel values defined above.

openedx.core.djangoapps.content_libraries.api.set_library_user_permissions(library_key, user, access_level)#

Change the specified user’s level of access to this library.

access_level should be one of the AccessLevel values defined above.

Update a bundle’s link to point to the specified version of its target bundle. Use version=None to automatically point to the latest version. Use delete=True to delete the link.

openedx.core.djangoapps.content_libraries.api.update_library(library_key, title=None, description=None, allow_public_learning=None, allow_public_read=None, library_type=None, library_license=None)#

Update a library’s metadata (Slug cannot be changed as it would break IDs throughout the system.)

A value of None means “don’t change”.

openedx.core.djangoapps.content_libraries.apps module#

Django AppConfig for Content Libraries Implementation

class openedx.core.djangoapps.content_libraries.apps.ContentLibrariesConfig(app_name, app_module)#

Bases: AppConfig

Django AppConfig for Content Libraries Implementation

name = 'openedx.core.djangoapps.content_libraries'#
plugin_app = {'settings_config': {'cms.djangoapp': {}}, 'url_config': {'cms.djangoapp': {'namespace': 'content_libraries'}}}#
ready()#

Import signal handler’s module to ensure they are registered.

verbose_name = 'Content Libraries (Blockstore-based)'#

openedx.core.djangoapps.content_libraries.auth module#

Content Library LTI authentication.

This module offers an authentication backend to support LTI launches within content libraries.

class openedx.core.djangoapps.content_libraries.auth.LtiAuthenticationBackend#

Bases: ModelBackend

Authenticate based on content library LTI profile.

The backend assumes the profile was previously created and its presence is enough to assume the launch claims are valid.

authenticate(request, iss=None, aud=None, sub=None, **kwargs)#

Authenticate if the user in the request has an LTI profile.

openedx.core.djangoapps.content_libraries.constants module#

Constants used for the content libraries.

openedx.core.djangoapps.content_libraries.libraries_index module#

Code to allow indexing content libraries

class openedx.core.djangoapps.content_libraries.libraries_index.ContentLibraryIndexer#

Bases: SearchIndexerBase

Class to perform indexing for blockstore-based content libraries

ENABLE_INDEXING_KEY = 'ENABLE_CONTENT_LIBRARY_INDEX'#
INDEX_NAME = 'content_library_index'#
SCHEMA_VERSION = 0#
classmethod get_item_definition(item)#

Returns a serializable dictionary which can be stored in elasticsearch.

class openedx.core.djangoapps.content_libraries.libraries_index.LibraryBlockIndexer#

Bases: SearchIndexerBase

Class to perform indexing on the XBlocks in content libraries.

ENABLE_INDEXING_KEY = 'ENABLE_CONTENT_LIBRARY_INDEX'#
INDEX_NAME = 'content_library_block_index'#
SCHEMA_VERSION = 0#
classmethod get_item_definition(item)#

Returns a serializable dictionary which can be stored in elasticsearch.

class openedx.core.djangoapps.content_libraries.libraries_index.SearchIndexerBase#

Bases: ABC

Abstract Base Class for implementing library search indexers.

ENABLE_INDEXING_KEY = None#
INDEX_NAME = None#
SCHEMA_VERSION = 0#
SEARCH_KWARGS = {'refresh': False}#
static build_elastic_query(filter_terms, text_search)#

Build and return an elastic query for doing text search on a library

abstract classmethod get_item_definition(item)#

Returns a serializable dictionary which can be stored in elasticsearch.

classmethod get_items(ids=None, filter_terms=None, text_search=None)#

Retrieve a list of items from the index. :param ids - List of ids to be searched for in the index: :param filter_terms - Dictionary of filters to be applied: :param text_search - String which is used to do a text search in the supported indexes.:

classmethod index_items(items)#

Index the specified libraries. If they already exist, replace them with new ones.

classmethod indexing_is_enabled()#

Checks to see if the indexing feature is enabled

classmethod remove_all_items()#

Remove all items from the index

classmethod remove_items(ids)#

Remove the provided ids from the index

openedx.core.djangoapps.content_libraries.libraries_index.index_block(**kwargs)#

Index block metadata when created or updated

openedx.core.djangoapps.content_libraries.libraries_index.index_library(**kwargs)#

Index library when created or updated, or when its blocks are modified.

openedx.core.djangoapps.content_libraries.libraries_index.index_library_block(**kwargs)#

Index library when its blocks are created, modified, or deleted.

openedx.core.djangoapps.content_libraries.libraries_index.remove_block_index(**kwargs)#

Remove the block from the index when deleted

openedx.core.djangoapps.content_libraries.libraries_index.remove_library_index(**kwargs)#

Remove from index when library is deleted

openedx.core.djangoapps.content_libraries.library_bundle module#

Helper code for working with Blockstore bundles that contain OLX

class openedx.core.djangoapps.content_libraries.library_bundle.LibraryBundle(library_key, bundle_uuid, draft_name=None)#

Bases: object

Wrapper around a Content Library Blockstore bundle that contains OLX.

definition_for_usage(usage_key)#

Given the usage key for an XBlock in this library bundle, return the BundleDefinitionLocator which specifies the actual XBlock definition (as a path to an OLX in a specific blockstore bundle).

Must return a BundleDefinitionLocator if the XBlock exists in this context, or None otherwise.

For a content library, the rules are simple: * If the usage key points to a block in this library, the filename

(definition) of the OLX file is always

{block_type}/{usage_id}/definition.xml

Each library has exactly one usage per definition for its own blocks.

  • However, block definitions from other content libraries may be linked into this library via <xblock-include … /> directives. In that case, it’s necessary to inspect every OLX file in this library that might have an <xblock-include /> directive in order to find what external block the usage ID refers to.

does_definition_have_unpublished_changes(definition_key)#
Given the defnition key of an XBlock, which exists in an OLX file like

problem/quiz1/definition.xml

Check if the bundle’s draft has _any_ unpublished changes in the

problem/quiz1/

directory.

get_all_usages()#

Get usage keys of all the blocks in this bundle

get_bundle_includes()#

Scan through the bundle and all linked bundles as needed to generate a complete list of all the blocks that are included as child/grandchild/… blocks of the blocks in this bundle.

Returns a dict of {usage_key -> BundleDefinitionLocator}

Blocks in the bundle that have no parent are not included.

get_last_published_time()#

Return the timestamp when the current library was last published. If the current draft has never been published, return 0.

get_olx_files()#

Get the list of OLX files in this bundle (using a heuristic)

Because this uses a heuristic, it will only return files with filenames that seem like OLX files that are in the expected locations of OLX files. They are not guaranteed to be valid OLX nor will OLX files in nonstandard locations be returned.

Example return value: [

‘html/intro/definition.xml’, ‘unit/unit1/definition.xml’,

]

get_static_files_for_definition(definition_key)#

Return a list of the static asset files related with a particular XBlock definition.

If the bundle contains files like:

problem/quiz1/definition.xml problem/quiz1/static/image1.png

Then this will return

[BundleFileData(path=”image1.png”, size, url, hash_digest)]

get_static_prefix_for_definition(definition_key)#

Given a definition key, get the path prefix used for all (public) static asset files.

Example: problem/quiz1/static/

get_top_level_usages()#

Get the set of usage keys in this bundle that have no parent.

has_changes()#

Helper method to check if this OLX bundle has any pending changes, including any deleted blocks.

Returns a tuple of (

has_unpublished_changes, has_unpublished_deletes,

) Where has_unpublished_changes is true if there is any type of change, including deletes, and has_unpublished_deletes is only true if one or more blocks has been deleted since the last publish.

static olx_prefix(definition_key)#
Given a definition key in a compatible bundle, whose olx_path refers to

block_type/some_id/definition.xml

Return the “folder name” / “path prefix”

block-type/some_id/

This method is here rather than a method of BundleDefinitionLocator because BundleDefinitionLocator is more generic and doesn’t require that its olx_path always ends in /definition.xml

openedx.core.djangoapps.content_libraries.library_bundle.bundle_uuid_for_library_key(library_key)#

Given a library slug, look up its bundle UUID. Can be cached aggressively since bundle UUID is immutable.

May raise ContentLibrary.DoesNotExist

openedx.core.djangoapps.content_libraries.library_bundle.does_block_type_support_children(block_type)#

Does the specified block type (e.g. “html”, “vertical”) support child blocks?

openedx.core.djangoapps.content_libraries.library_bundle.usage_for_child_include(parent_usage, parent_definition, parsed_include)#

Get the usage ID for a child XBlock, given the parent’s keys and the <xblock-include /> element that specifies the child.

Consider two bundles, one with three definitions:

main-unit, html1, subunit1

And a second bundle with two definitions:

unit1, html1

Note that both bundles have a definition called “html1”. Now, with the following tree structure, where “unit/unit1” and the second “html/html1” are in a linked bundle:

<unit> in unit/main-unit/definition.xml

<xblock-include definition=”html/html1” /> <xblock-include definition=”unit/subunit1” />

<xblock-include source=”linked_bundle” definition=”unit/unit1” usage=”alias1” />

<xblock-include definition=”html/html1” />

The following usage IDs would result:

main-unit

html1 subunit1

alias1

alias1-html1

Notice that “html1” in the linked bundle is prefixed so its ID stays unique from the “html1” in the original library.

openedx.core.djangoapps.content_libraries.library_context module#

Definition of “Library” as a learning context.

class openedx.core.djangoapps.content_libraries.library_context.LibraryContextImpl(**kwargs)#

Bases: LearningContext

Implements content libraries as a learning context.

This is the new content libraries based on Blockstore, not the old content libraries based on modulestore.

can_edit_block(user, usage_key)#

Does the specified usage key exist in its context, and if so, does the specified user have permission to edit it (make changes to the authored data store)?

user: a Django User object (may be an AnonymousUser)

usage_key: the UsageKeyV2 subclass used for this learning context

Must return a boolean.

can_view_block(user, usage_key)#

Does the specified usage key exist in its context, and if so, does the specified user have permission to view it and interact with it (call handlers, save user state, etc.)?

user: a Django User object (may be an AnonymousUser)

usage_key: the UsageKeyV2 subclass used for this learning context

Must return a boolean.

definition_for_usage(usage_key, **kwargs)#

Given a usage key for an XBlock in this context, return the BundleDefinitionLocator which specifies the actual XBlock definition (as a path to an OLX in a specific blockstore bundle).

Must return a BundleDefinitionLocator if the XBlock exists in this context, or None otherwise.

usage_for_child_include(parent_usage, parent_definition, parsed_include)#

Method that the runtime uses when loading a block’s child, to get the ID of the child.

The child is always from an <xblock-include /> element.

openedx.core.djangoapps.content_libraries.models module#

Content Libraries Models#

This module contains the models for new Content Libraries.

LTI 1.3 Models#

Content Libraries serves blockstore-based content through LTI 1.3 launches. The interface supports resource link launches and grading services. Two use cases justify the current data model to support LTI launches. They are:

  1. Authentication and authorization. This use case demands management of user lifecycle to authorize access to content and grade submission, and it introduces a model to own the authentication business logic related to LTI.

  2. Grade and assignments. When AGS is supported, content libraries store additional information concerning the launched resource so that, once the grading sub-system submits the score, it can retrieve them to propagate the score update into the LTI platform’s grade book.

Relationship with LMS’s lti_provider` models#

The data model above is similar to the one provided by the current LTI 1.1 implementation for modulestore and courseware content. But, Content Libraries is orthogonal. Its use-case is to offer standalone, embedded content from a specific backend (blockstore). As such, it decouples from LTI 1.1. and the logic assume no relationship or impact across the two applications. The same reasoning applies to steps beyond the data model, such as at the XBlock runtime, authentication, and score handling, etc.

class openedx.core.djangoapps.content_libraries.models.ContentLibrary(*args, **kwargs)#

Bases: Model

A Content Library is a collection of content (XBlocks and/or static assets)

All actual content is stored in Blockstore, and any data that we’d want to transfer to another instance if this library were exported and then re-imported on another Open edX instance should be kept in Blockstore. This model in Studio should only be used to track settings specific to this Open edX instance, like who has permission to edit this content library.

exception DoesNotExist#

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned#

Bases: MultipleObjectsReturned

property allow_lti#

True if there is at least one LTI tool configuration associated if this library.

allow_public_learning#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

allow_public_read#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

classmethod authorize_lti_launch(library_key, *, issuer, client_id=None)#

Check if the given Issuer and Client ID are authorized to launch content from this library.

authorized_lti_configs#

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

bundle_uuid#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_license_display(*, field=<django.db.models.fields.CharField: license>)#
get_type_display(*, field=<django.db.models.fields.CharField: type>)#
id#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

import_tasks#

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property library_key#

Get the LibraryLocatorV2 opaque key for this library

license#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <openedx.core.djangoapps.content_libraries.models.ContentLibraryManager object>#
org#

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

org_id#
permission_grants#

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

slug#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

type#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class openedx.core.djangoapps.content_libraries.models.ContentLibraryBlockImportTask(*args, **kwargs)#

Bases: Model

Model of a task to import blocks from an external source (e.g. modulestore).

exception DoesNotExist#

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned#

Bases: MultipleObjectsReturned

TASK_CREATED = 'created'#
TASK_FAILED = 'failed'#
TASK_PENDING = 'pending'#
TASK_RUNNING = 'running'#
TASK_STATE_CHOICES = (('created', 'Task was created, but not queued to run.'), ('pending', 'Task was created and queued to run.'), ('running', 'Task is running.'), ('failed', 'Task finished, but some blocks failed to import.'), ('successful', 'Task finished successfully.'))#
TASK_SUCCESSFUL = 'successful'#
course_id#

DO NOT REUSE THIS CLASS. Provided for backwards compatibility only!

A placeholder class that provides a way to set the attribute on the model.

created_at#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

classmethod execute(import_task_id)#

A context manager to manage a task that is being executed.

get_next_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=True, **kwargs)#
get_next_by_updated_at(*, field=<django.db.models.fields.DateTimeField: updated_at>, is_next=True, **kwargs)#
get_previous_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=False, **kwargs)#
get_previous_by_updated_at(*, field=<django.db.models.fields.DateTimeField: updated_at>, is_next=False, **kwargs)#
get_state_display(*, field=<django.db.models.fields.CharField: state>)#
id#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

library#

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

library_id#
objects = <django.db.models.manager.Manager object>#
progress#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save_progress(progress)#
state#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

updated_at#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class openedx.core.djangoapps.content_libraries.models.ContentLibraryManager(*args, **kwargs)#

Bases: Manager

Custom manager for ContentLibrary class.

get_by_key(library_key)#

Get the ContentLibrary for the given LibraryLocatorV2 key.

class openedx.core.djangoapps.content_libraries.models.ContentLibraryPermission(*args, **kwargs)#

Bases: Model

Row recording permissions for a content library

ACCESS_LEVEL_CHOICES = (('admin', 'Administer users and author content'), ('author', 'Author content'), ('read', 'Read-only'))#
ADMIN_LEVEL = 'admin'#
AUTHOR_LEVEL = 'author'#
exception DoesNotExist#

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned#

Bases: MultipleObjectsReturned

READ_LEVEL = 'read'#
access_level#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_access_level_display(*, field=<django.db.models.fields.CharField: access_level>)#
group#

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

group_id#
id#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

library#

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

library_id#
objects = <django.db.models.manager.Manager object>#
save(*args, **kwargs)#

Validate any constraints on the model.

We can remove this and replace it with a proper database constraint once we’re upgraded to Django 2.2+

user#

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

user_id#
class openedx.core.djangoapps.content_libraries.models.LtiGradedResource(*args, **kwargs)#

Bases: Model

A content libraries resource launched through LTI with AGS enabled.

Essentially, an instance of this model represents a successful LTI AGS launch. This model links the profile that launched the resource with the resource itself, allowing identifcation of the link through its usage key string and user id.

exception DoesNotExist#

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned#

Bases: MultipleObjectsReturned

ags_lineitem#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <openedx.core.djangoapps.content_libraries.models.LtiGradedResourceManager object>#
profile#

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

profile_id#
resource_id#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

resource_title#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

update_score(weighted_earned, weighted_possible, timestamp)#

Use LTI’s score service to update the LTI platform’s gradebook.

This method synchronously send a request to the LTI platform to update the assignment score.

usage_key#

DO NOT REUSE THIS CLASS. Provided for backwards compatibility only!

A placeholder class that provides a way to set the attribute on the model.

class openedx.core.djangoapps.content_libraries.models.LtiGradedResourceManager(*args, **kwargs)#

Bases: Manager

A custom manager for the graded resources model.

get_from_user_id(user_id, **kwds)#

Retrieve a resource for a given user id holding an lti profile.

upsert_from_ags_launch(user, block, resource_endpoint, resource_link)#

Update or create a graded resource at AGS launch.

class openedx.core.djangoapps.content_libraries.models.LtiProfile(*args, **kwargs)#

Bases: Model

Content Libraries LTI’s profile for Open edX users.

Unless Anonymous, this should be a unique representation of the LTI subject (as per the client token sub identify claim) that initiated an LTI launch through Content Libraries.

exception DoesNotExist#

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned#

Bases: MultipleObjectsReturned

client_id#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

created_at#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=True, **kwargs)#
get_previous_by_created_at(*, field=<django.db.models.fields.DateTimeField: created_at>, is_next=False, **kwargs)#
id#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

lti_resources#

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

objects = <openedx.core.djangoapps.content_libraries.models.LtiProfileManager object>#
platform_id#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwds)#

Get or create an edx user on save.

subject_id#

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property subject_url#

An local URL that is known to uniquely identify this profile.

We take advantage of the fact that platform id is required to be an URL and append paths with the reamaining keys to it.

user#

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

user_id#
class openedx.core.djangoapps.content_libraries.models.LtiProfileManager(*args, **kwargs)#

Bases: Manager

Custom manager of LtiProfile mode.

get_from_claims(*, iss, aud, sub)#

Get the an instance from a LTI launch claims.

get_or_create_from_claims(*, iss, aud, sub)#

Get or create an instance from a LTI launch claims.

openedx.core.djangoapps.content_libraries.permissions module#

Permissions for Content Libraries (v2, Blockstore-based)

openedx.core.djangoapps.content_libraries.serializers module#

Serializers for the content libraries REST API

class openedx.core.djangoapps.content_libraries.serializers.BaseFilterSerializer(*args, **kwargs)#

Bases: Serializer

Base serializer for filtering listings on the content library APIs.

class openedx.core.djangoapps.content_libraries.serializers.ContentLibraryAddPermissionByEmailSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for adding a new user and granting their access level via their email address.

class openedx.core.djangoapps.content_libraries.serializers.ContentLibraryBlockImportTaskCreateSerializer(*args, **kwargs)#

Bases: Serializer

Serializer to create a new block import task.

The serializer accepts the following parameter:

  • The courseware course key to import blocks from.

class openedx.core.djangoapps.content_libraries.serializers.ContentLibraryBlockImportTaskSerializer(*args, **kwargs)#

Bases: ModelSerializer

Serializer for a Content Library block import task.

class Meta#

Bases: object

fields = '__all__'#
model#

alias of ContentLibraryBlockImportTask

get_org(obj)#
class openedx.core.djangoapps.content_libraries.serializers.ContentLibraryFilterSerializer(*args, **kwargs)#

Bases: BaseFilterSerializer

Serializer for filtering library listings.

class openedx.core.djangoapps.content_libraries.serializers.ContentLibraryMetadataSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for ContentLibraryMetadata

class openedx.core.djangoapps.content_libraries.serializers.ContentLibraryPermissionLevelSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for the “Access Level” of a ContentLibraryPermission object.

This is used when updating a user or group’s permissions re some content library.

class openedx.core.djangoapps.content_libraries.serializers.ContentLibraryPermissionSerializer(*args, **kwargs)#

Bases: ContentLibraryPermissionLevelSerializer

Serializer for a ContentLibraryPermission object, which grants either a user or a group permission to view a content library.

class openedx.core.djangoapps.content_libraries.serializers.ContentLibraryUpdateSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for updating an existing content library

class openedx.core.djangoapps.content_libraries.serializers.LibraryBundleLinkSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for a link from a content library blockstore bundle to another blockstore bundle.

class openedx.core.djangoapps.content_libraries.serializers.LibraryBundleLinkUpdateSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for updating an existing link in a content library blockstore bundle.

class openedx.core.djangoapps.content_libraries.serializers.LibraryXBlockCreationSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for adding a new XBlock to a content library

class openedx.core.djangoapps.content_libraries.serializers.LibraryXBlockMetadataSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for LibraryXBlockMetadata

class openedx.core.djangoapps.content_libraries.serializers.LibraryXBlockOlxSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for representing an XBlock’s OLX

class openedx.core.djangoapps.content_libraries.serializers.LibraryXBlockStaticFileSerializer(*args, **kwargs)#

Bases: Serializer

Serializer representing a static file associated with an XBlock

Serializes a LibraryXBlockStaticFile (or a BundleFile)

to_representation(instance)#

Generate the serialized representation of this static asset file.

class openedx.core.djangoapps.content_libraries.serializers.LibraryXBlockStaticFilesSerializer(*args, **kwargs)#

Bases: Serializer

Serializer representing a static file associated with an XBlock

Serializes a LibraryXBlockStaticFile (or a BundleFile)

class openedx.core.djangoapps.content_libraries.serializers.LibraryXBlockTypeSerializer(*args, **kwargs)#

Bases: Serializer

Serializer for LibraryXBlockType

openedx.core.djangoapps.content_libraries.signal_handlers module#

Content library signal handlers.

openedx.core.djangoapps.content_libraries.signal_handlers.score_changed_handler(sender, **kwargs)#

Match the score event to an LTI resource and update.

openedx.core.djangoapps.content_libraries.tasks module#

Celery tasks for Content Libraries.

openedx.core.djangoapps.content_libraries.urls module#

URL configuration for Studio’s Content Libraries REST API

openedx.core.djangoapps.content_libraries.views module#

Content Libraries Views#

This module contains the REST APIs for blockstore-based content libraries, and LTI 1.3 views.

class openedx.core.djangoapps.content_libraries.views.LibraryApiPagination#

Bases: PageNumberPagination

Paginates over ContentLibraryMetadata objects.

apidoc_params = [Parameter([('name', 'pagination'), ('in', 'query'), ('description', 'Enables paginated schema'), ('type', 'boolean')]), Parameter([('name', 'page'), ('in', 'query'), ('description', 'Page number of result. Defaults to 1'), ('type', 'integer')]), Parameter([('name', 'page_size'), ('in', 'query'), ('description', 'Page size of the result. Defaults to 50'), ('type', 'integer')])]#
page_size = 50#
page_size_query_param = 'page_size'#
class openedx.core.djangoapps.content_libraries.views.LibraryBlockAssetListView(**kwargs)#

Bases: APIView

Views to list an existing XBlock’s static asset files

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
get(request, usage_key_str)#

List the static asset files belonging to this block.

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
class openedx.core.djangoapps.content_libraries.views.LibraryBlockAssetView(**kwargs)#

Bases: APIView

Views to work with an existing XBlock’s static asset files

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
delete(request, usage_key_str, file_path)#

Delete a static asset file belonging to this block.

get(request, usage_key_str, file_path)#

Get a static asset file belonging to this block.

parser_classes = (<class 'rest_framework.parsers.MultiPartParser'>,)#
permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
put(request, usage_key_str, file_path)#

Replace a static asset file belonging to this block.

class openedx.core.djangoapps.content_libraries.views.LibraryBlockLtiUrlView(**kwargs)#

Bases: APIView

Views to generate LTI URL for existing XBlocks in a content library.

Returns 404 in case the block not found by the given key.

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
get(request, usage_key_str)#

Get the LTI launch URL for the XBlock.

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
class openedx.core.djangoapps.content_libraries.views.LibraryBlockOlxView(**kwargs)#

Bases: APIView

Views to work with an existing XBlock’s OLX

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
get(request, usage_key_str)#

Get the block’s OLX

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
post(request, usage_key_str)#

Replace the block’s OLX.

This API is only meant for use by developers or API client applications. Very little validation is done.

class openedx.core.djangoapps.content_libraries.views.LibraryBlockTypesView(**kwargs)#

Bases: APIView

View to get the list of XBlock types that can be added to this library

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
get(request, lib_key_str)#

Get the list of XBlock types that can be added to this library

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
class openedx.core.djangoapps.content_libraries.views.LibraryBlockView(**kwargs)#

Bases: APIView

Views to work with an existing XBlock in a content library.

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
delete(request, usage_key_str)#

Delete a usage of a block from the library (and any children it has).

If this is the only usage of the block’s definition within this library, both the definition and the usage will be deleted. If this is only one of several usages, the definition will be kept. Usages by linked bundles are ignored and will not prevent deletion of the definition.

If the usage points to a definition in a linked bundle, the usage will be deleted but the link and the linked bundle will be unaffected.

get(request, usage_key_str)#

Get metadata about an existing XBlock in the content library

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
class openedx.core.djangoapps.content_libraries.views.LibraryBlocksView(**kwargs)#

Bases: APIView

Views to work with XBlocks in a specific content library.

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
get(request, lib_key_str)#

Get the list of all top-level blocks in this content library

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
post(request, lib_key_str)#

Add a new XBlock to this content library

class openedx.core.djangoapps.content_libraries.views.LibraryCommitView(**kwargs)#

Bases: APIView

Commit/publish or revert all of the draft changes made to the library.

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
delete(request, lib_key_str)#

Revert the draft changes made to the specified block and its descendants. Restore it to the last published version

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
post(request, lib_key_str)#

Commit the draft changes made to the specified block and its descendants.

class openedx.core.djangoapps.content_libraries.views.LibraryDetailsView(**kwargs)#

Bases: APIView

Views to work with a specific content library

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
delete(request, lib_key_str)#

Delete a content library

get(request, lib_key_str)#

Get a specific content library

patch(request, lib_key_str)#

Update a content library

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
class openedx.core.djangoapps.content_libraries.views.LibraryImportTaskViewSet(**kwargs)#

Bases: ViewSet

Import blocks from Courseware through modulestore.

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
basename = None#
create(request, lib_key_str)#

Create and queue an import tasks for this library.

description = None#
detail = None#
list(request, lib_key_str)#

List all import tasks for this library.

name = None#
permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
retrieve(request, lib_key_str, pk=None)#

Retrieve a import task for inspection.

suffix = None#
class openedx.core.djangoapps.content_libraries.views.LibraryLinkDetailView(**kwargs)#

Bases: APIView

View to update/delete an existing library link

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
delete(request, lib_key_str, link_id)#

Delete a link from this library.

patch(request, lib_key_str, link_id)#

Update the specified link to point to a different version of its target bundle.

Pass e.g. {“version”: 40} or pass {“version”: None} to update to the latest published version.

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
class openedx.core.djangoapps.content_libraries.views.LibraryLinksView(**kwargs)#

Bases: APIView

View to get the list of bundles/libraries linked to this content library.

Because every content library is a blockstore bundle, it can have “links” to other bundles, which may or may not be content libraries. This allows using XBlocks (or perhaps even static assets etc.) from another bundle without needing to duplicate/copy the data.

Links always point to a specific published version of the target bundle. Links are identified by a slug-like ID, e.g. “link1”

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
get(request, lib_key_str)#

Get the list of bundles that this library links to, if any

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
post(request, lib_key_str)#

Create a new link in this library.

class openedx.core.djangoapps.content_libraries.views.LibraryRootView(**kwargs)#

Bases: APIView

Views to list, search for, and create content libraries.

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
get(request)#

Return a list of all content libraries that the user has permission to view.

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
post(request)#

Create a new content library.

class openedx.core.djangoapps.content_libraries.views.LibraryTeamGroupView(**kwargs)#

Bases: APIView

View to add/remove/edit a group’s permissions for a content library.

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
delete(request, lib_key_str, username)#

Remove the specified user’s permission to access or edit this content library.

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
put(request, lib_key_str, group_name)#

Add a group to this content library, with permissions specified in the request body.

class openedx.core.djangoapps.content_libraries.views.LibraryTeamUserView(**kwargs)#

Bases: APIView

View to add/remove/edit an individual user’s permissions for a content library.

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
delete(request, lib_key_str, username)#

Remove the specified user’s permission to access or edit this content library.

get(request, lib_key_str, username)#

Gets the current permissions settings for a particular user.

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
put(request, lib_key_str, username)#

Add a user to this content library, with permissions specified in the request body.

class openedx.core.djangoapps.content_libraries.views.LibraryTeamView(**kwargs)#

Bases: APIView

View to get the list of users/groups who can access and edit the content library.

Note also the ‘allow_public_’ settings which can be edited by PATCHing the library itself (LibraryDetailsView.patch).

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthenticationAllowInactiveUser'>, <class 'edx_rest_framework_extensions.auth.session.authentication.SessionAuthenticationAllowInactiveUser'>)#
get(request, lib_key_str)#

Get the list of users and groups who have permissions to view and edit this library.

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
post(request, lib_key_str)#

Add a user to this content library via email, with permissions specified in the request body.

class openedx.core.djangoapps.content_libraries.views.LtiToolJwksView(**kwargs)#

Bases: LtiToolView

JSON Web Key Sets view.

get(request)#

Return the JWKS.

class openedx.core.djangoapps.content_libraries.views.LtiToolLaunchView(**kwargs)#

Bases: TemplateResponseMixin, LtiToolView

LTI platform tool launch view.

The launch view supports resource link launches and AGS, when enabled by the LTI platform. Other features and resouces are ignored.

dispatch(request, *args, **kwargs)#
get_context_data()#

Setup the template context data.

get_launch_message()#

Return the LTI 1.3 launch message object for the current request.

handle_ags()#

Handle AGS-enabled launches for block in the request.

property launch_data#
post(request)#

Process LTI platform launch requests.

template_name = 'content_libraries/xblock_iframe.html'#
class openedx.core.djangoapps.content_libraries.views.LtiToolLoginView(**kwargs)#

Bases: LtiToolView

Third-party Initiated Login view.

The LTI platform will start the OpenID Connect flow by redirecting the User Agent (UA) to this view. The redirect may be a form POST or a GET. On success the view should redirect the UA to the LTI platform’s authentication URL.

LAUNCH_URI_PARAMETER = 'target_link_uri'#
dispatch(request, *args, **kwargs)#
get(request)#
post(request)#

Initialize 3rd-party login requests to redirect.

class openedx.core.djangoapps.content_libraries.views.LtiToolView(**kwargs)#

Bases: View

Base LTI View initializing common attributes.

dispatch(request, *args, **kwargs)#
setup(request, *args, **kwds)#

Initialize attributes shared by all LTI views.

openedx.core.djangoapps.content_libraries.views.convert_exceptions(fn)#

Catch any Content Library API exceptions that occur and convert them to DRF exceptions so DRF will return an appropriate HTTP response

openedx.core.djangoapps.content_libraries.views.requires_lti_enabled(view_func)#

Modify the view function to raise 404 if content librarie LTI tool was not enabled.

Module contents#