le-utils 0.2.4__tar.gz → 0.2.6__tar.gz

{le-utils-0.2.4/le_utils.egg-info → le-utils-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: le-utils
-Version: 0.2.4
+Version: 0.2.6
 Summary: LE-Utils contains shared constants used in Kolibri, Ricecooker, and Kolibri Studio.
 Home-page: https://github.com/learningequality/le-utils
 Author: Learning Equality

{le-utils-0.2.4 → le-utils-0.2.6}/le_utils/constants/content_kinds.py

@@ -43,6 +43,7 @@ MAPPING = {
     file_formats.HTML5: HTML5,
     file_formats.H5P: H5P,
     file_formats.ZIM: ZIM,
+    file_formats.BLOOMPUB: DOCUMENT,
 }
 
 

{le-utils-0.2.4 → le-utils-0.2.6}/le_utils/constants/embed_content_request.py

@@ -21,6 +21,57 @@ SCHEMA = {
             "description": "Language code from https://github.com/learningequality/le-utils/blob/main/le_utils/resources/languagelookup.json",
             "pattern": "^[a-z]{2,3}(?:-[a-zA-Z]+)?$",
         },
+        "url": {
+            "type": "string",
+            "pattern": "^(https?:\\/\\/(?:storage\\.cloud\\.google\\.com|localhost(?::[0-9]+)?)\\/[a-z0-9-._~!$&'()*+,;=:@%\\/\\?]+)$",
+        },
+        "preset": {
+            "type": "string",
+            "description": "Presets from https://github.com/learningequality/le-utils/blob/main/le_utils/constants/format_presets.py",
+            "enum": [
+                "high_res_video",
+                "low_res_video",
+                "video_thumbnail",
+                "video_subtitle",
+                "video_dependency",
+                "audio",
+                "audio_thumbnail",
+                "audio_dependency",
+                "document",
+                "epub",
+                "document_thumbnail",
+                "exercise",
+                "exercise_thumbnail",
+                "exercise_image",
+                "exercise_graphie",
+                "channel_thumbnail",
+                "topic_thumbnail",
+                "html5_zip",
+                "html5_dependency",
+                "html5_thumbnail",
+                "h5p",
+                "h5p_thumbnail",
+                "zim",
+                "zim_thumbnail",
+                "qti",
+                "qti_thumbnail",
+                "slideshow_image",
+                "slideshow_thumbnail",
+                "slideshow_manifest",
+                "imscp_zip",
+                "bloompub",
+            ],
+        },
+        "file": {
+            "type": "object",
+            "additionalProperties": False,
+            "properties": {
+                "url": {"$ref": "#/definitions/url"},
+                "preset": {"$ref": "#/definitions/preset"},
+                "language": {"$ref": "#/definitions/language"},
+            },
+            "required": ["url", "preset"],
+        },
         "resource": {
             "type": "object",
             "description": "The key textual metadata and data for a content resource",
@@ -43,6 +94,11 @@ SCHEMA = {
                     "description": "The cleaned up text extracted from the content resource (in markdown or plaintext format)",
                 },
                 "language": {"$ref": "#/definitions/language"},
+                "files": {
+                    "type": "array",
+                    "description": "A list of files associated with the content resource",
+                    "items": {"$ref": "#/definitions/file"},
+                },
             },
             "required": ["id", "title", "description", "text"],
         },

{le-utils-0.2.4 → le-utils-0.2.6}/le_utils/constants/embed_topics_request.py

@@ -16,30 +16,50 @@ SCHEMA = {
     "description": "Schema for embed topics requests received by RayServe",
     "additionalProperties": False,
     "definitions": {
-        "ancestors": {
-            "type": "array",
-            "description": "The ancestors of the topic, in order, from the parent to the root",
-            "items": {"$ref": "#/definitions/topic"},
+        "id": {
+            "type": "string",
+            "description": "The ID of the topic content node on Studio",
+        },
+        "title": {"type": "string", "description": "The title of the topic"},
+        "description": {
+            "type": "string",
+            "description": "The description of the topic",
         },
         "language": {
             "type": "string",
             "description": "Language code from https://github.com/learningequality/le-utils/blob/main/le_utils/resources/languagelookup.json",
             "pattern": "^[a-z]{2,3}(?:-[a-zA-Z]+)?$",
         },
+        "level": {
+            "type": "integer",
+            "description": "The level of the ancestor, where the root is 0 and the parent is the highest level",
+        },
+        "ancestor": {
+            "type": "object",
+            "description": "An ancestor in the tree structure",
+            "additionalProperties": False,
+            "properties": {
+                "id": {"$ref": "#/definitions/id"},
+                "title": {"$ref": "#/definitions/title"},
+                "description": {"$ref": "#/definitions/description"},
+                "language": {"$ref": "#/definitions/language"},
+                "level": {"$ref": "#/definitions/level"},
+            },
+            "required": ["id", "title", "description", "level"],
+        },
+        "ancestors": {
+            "type": "array",
+            "description": "The ancestors of the topic. Please see 'level' in the ancestor schema for more information",
+            "items": {"$ref": "#/definitions/ancestor"},
+        },
         "topic": {
             "type": "object",
             "description": "A topic in the tree structure",
             "additionalProperties": False,
             "properties": {
-                "id": {
-                    "type": "string",
-                    "description": "The ID of the topic content node on Studio",
-                },
-                "title": {"type": "string", "description": "The title of the topic"},
-                "description": {
-                    "type": "string",
-                    "description": "The description of the topic",
-                },
+                "id": {"$ref": "#/definitions/id"},
+                "title": {"$ref": "#/definitions/title"},
+                "description": {"$ref": "#/definitions/description"},
                 "language": {"$ref": "#/definitions/language"},
                 "ancestors": {"$ref": "#/definitions/ancestors"},
             },

{le-utils-0.2.4 → le-utils-0.2.6}/le_utils/constants/file_formats.py

@@ -76,6 +76,10 @@ ZIM_MIMETYPE = ".zim"
 EPUB = "epub"
 EPUB_MIMETYPE = "application/epub+zip"
 
+# constants for bloomPub format
+BLOOMPUB = "bloompub"
+BLOOMPUB_MIMETYPE = "application/bloompub+zip"
+
 choices = (
     (MP4, "MP4 Video"),
     (WEBM, "WEBM Video"),
@@ -94,6 +98,7 @@ choices = (
     (H5P, "H5P"),
     (ZIM, "ZIM"),
     (EPUB, "ePub Document"),
+    (BLOOMPUB, "Bloom Document"),
 )
 
 

{le-utils-0.2.4 → le-utils-0.2.6}/le_utils/constants/file_types.py

@@ -12,6 +12,7 @@ ZIM = "zim"
 THUMBNAIL = "thumbnail"
 SUBTITLES = "subtitles"
 SLIDESHOW_IMAGE = "slideshow_image"
+BLOOMPUB = "bloompub"
 
 
 """ File Format (extension) to File Type Mapping """
@@ -28,6 +29,7 @@ MAPPING = {
     # DocumentFile formats
     file_formats.PDF: DOCUMENT,
     file_formats.EPUB: EPUB,
+    file_formats.BLOOMPUB: BLOOMPUB,
     #
     # formats HTMLZipFile
     file_formats.HTML5: HTML5,

{le-utils-0.2.4 → le-utils-0.2.6}/le_utils/constants/format_presets.py

@@ -34,6 +34,8 @@ EPUB = "epub"
 EPUB_READABLE = "ePub Document"
 DOCUMENT_THUMBNAIL = "document_thumbnail"
 DOCUMENT_THUMBNAIL_READABLE = "Thumbnail"
+BLOOMPUB = "bloompub"
+BLOOMPUB_READABLE = "Bloom Document"
 
 EXERCISE = "exercise"
 EXERCISE_READABLE = "Exercise"
@@ -118,6 +120,7 @@ choices = (
     (SLIDESHOW_THUMBNAIL, SLIDESHOW_THUMBNAIL_READABLE),
     (SLIDESHOW_MANIFEST, SLIDESHOW_MANIFEST_READABLE),
     (IMSCP_ZIP, IMSCP_ZIP_READABLE),
+    (BLOOMPUB, BLOOMPUB_READABLE),
 )
 
 

{le-utils-0.2.4 → le-utils-0.2.6}/le_utils/resources/formatlookup.json

@@ -49,5 +49,8 @@
 	},
 	"zip": {
 		"mimetype": ".zip"
+	},
+	"bloompub": {
+		"mimetype": "application/bloompub+zip"
 	}
 }

{le-utils-0.2.4 → le-utils-0.2.6}/le_utils/resources/presetlookup.json

@@ -358,5 +358,17 @@
 		"kind": "slideshow",
 		"allowed_formats": ["json"],
 		"convertible_formats": []
+	},
+	"bloompub": {
+		"readable_name": "Bloom Document",
+		"multi_language": false,
+		"supplementary": false,
+		"thumbnail": false,
+		"subtitle": false,
+		"display": true,
+		"order": 1,
+		"kind": "document",
+		"allowed_formats": ["bloompub"],
+		"convertible_formats": []
 	}
 }

{le-utils-0.2.4 → le-utils-0.2.6/le_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: le-utils
-Version: 0.2.4
+Version: 0.2.6
 Summary: LE-Utils contains shared constants used in Kolibri, Ricecooker, and Kolibri Studio.
 Home-page: https://github.com/learningequality/le-utils
 Author: Learning Equality

{le-utils-0.2.4 → le-utils-0.2.6}/setup.py

@@ -12,7 +12,7 @@ lang_utils_requirements = [
 setup(
     name="le-utils",
     packages=find_packages(),
-    version="0.2.4",
+    version="0.2.6",
     description="LE-Utils contains shared constants used in Kolibri, Ricecooker, and Kolibri Studio.",
     long_description=long_description,
     long_description_content_type="text/markdown",