FlashcardsXBlock 1.0.0rc1__py3-none-any.whl

flashcards/__init__.py

@@ -0,0 +1,5 @@
+"""The FlashcardsXBlock package."""
+
+from .flashcards import FlashcardsXBlock
+
+__all__ = ["FlashcardsXBlock"]

flashcards/flashcards.py

@@ -0,0 +1,121 @@
+"""
+An XBlock for displaying flashcards.
+
+Flashcards XBlock allows the editor to add a list of questions and
+answers (separated by a semicolon) which are then displayed as flashcards.
+"""
+
+from web_fragments.fragment import Fragment
+from xblock.core import XBlock
+from xblock.fields import List, Scope, String
+from xblock.utils.resources import ResourceLoader
+
+
+class FlashcardsXBlock(XBlock):
+    """
+    The FlashcardsXBlock class.
+
+    The content (the values between the <flashcards> tags) is saved as a
+    list of flashcard objects and passed as an array to the HTML template.
+    """
+
+    loader = ResourceLoader(__name__)
+    display_name = String(
+        display_name="Display Name",
+        default="Flashcards", # type: ignore[assignment]
+        scope=Scope.settings,
+        help="The title of the XBlock. It is displayed to the learners.",
+    )
+
+    content = List(default=[], scope=Scope.settings, help="List of items")  # type: ignore[assignment]
+
+    def student_view(self, context: dict | None = None) -> Fragment:
+        """Create fragment and send the appropriate context."""
+        styling = {
+            "fontSize": "16px",
+            "backgroundColor": "#f8f9fa",
+            "textColor": "#212529",
+            "borderColor": "#dee2e6",
+        }
+
+        context = {
+            "title": self.display_name,
+            "flashcards": self.content,
+            "styling": styling,
+            "url": self.runtime.local_resource_url(self, "public/student-ui.js"),
+        }
+
+        frag = Fragment()
+        frag.add_javascript(self.loader.load_unicode("static/js/student.js"))
+        frag.add_css_url(self.runtime.local_resource_url(self, "public/student-ui.css"))
+        frag.initialize_js("FlashcardsBlock", context)
+        return frag
+
+    @classmethod
+    def parse_xml(cls, node, runtime, keys, id_generator) -> XBlock:  # noqa: ANN001, ARG003
+        """
+        Parse the XML for an HTML block.
+
+        The entire subtree under `node` is re-serialized, and set as the
+        content of the XBlock.
+
+        The content between the <flashcards> blocks is being transformed
+        into a list of flashcard objects, and as such saved into the content class variable
+        (which is accessible with self.content)
+        """
+        block = runtime.construct_xblock_from_class(cls, keys)
+        flashcards = []
+
+        flashcards = [
+            {"front": element.attrib["front"], "back": element.attrib["back"]}
+            for element in node.iter("flashcard")
+        ]
+
+        block.content = flashcards
+        block.title = node.attrib["title"]
+        return block
+
+    @staticmethod
+    def workbench_scenarios() -> list[tuple[str, str]]:
+        """A canned scenario for display in the workbench."""
+        return [
+            (
+                "FlashcardsXBlock",
+                """<vertical_demo>
+                <flashcards title="Capital cities">
+<flashcard front="Croatia" back="Zagreb" />
+<flashcard front="France" back="Paris" />
+                </flashcards>
+                </vertical_demo>
+             """,
+            ),
+        ]
+
+    def studio_view(self, context: dict) -> Fragment:
+        """Create a fragment used to display the edit view in the Studio."""
+        styling = {
+            "fontSize": "16px",
+            "backgroundColor": "#f8f9fa",
+            "textColor": "#212529",
+            "borderColor": "#dee2e6",
+        }
+
+        context = {
+            "title": self.display_name,
+            "flashcards": self.content,
+            "styling": styling,
+            "url": self.runtime.local_resource_url(self, "public/studio-ui.js"),
+        }
+
+        frag = Fragment(self.loader.render_django_template("static/html/studio.html", context=context))
+        frag.add_javascript(self.loader.load_unicode("static/js/studio.js"))
+        frag.add_css_url(self.runtime.local_resource_url(self, "public/studio-ui.css"))
+        frag.initialize_js("FlashcardsEditor", context)
+        return frag
+
+    @XBlock.json_handler
+    def studio_submit(self, data: dict, suffix: str = "") -> dict[str, str]:  # noqa: ARG002
+        """Called when submitting the form in Studio."""
+        self.display_name = data.get("title")
+        self.content = data.get("flashcards")
+        return {"result": "success"}

flashcards/static/html/studio.html

@@ -0,0 +1 @@
+<div class="flashcards_studio" id="flashcards-studio-ui"></div>

flashcards/static/js/student.js

@@ -0,0 +1,6 @@
+function FlashcardsBlock(runtime, element, data) {
+  (async () => {
+    const {renderBlock} = await import(data.url);
+    renderBlock(element, data);
+  })();
+}

flashcards/static/js/studio.js

@@ -0,0 +1,6 @@
+function FlashcardsEditor(runtime, element, data) {
+  (async () => {
+    const {renderEditor} = await import(data.url);
+    renderEditor(runtime, element[0], data);
+  })();
+}

flashcardsxblock-1.0.0rc1.dist-info/METADATA

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: FlashcardsXBlock
+Version: 1.0.0rc1
+Summary: A Flashcards XBlock for Open edX.
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/open-craft/FlashcardsXBlock
+Keywords: Python,edx
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: XBlock
+Dynamic: license-file
+
+# FlashcardsXBlock
+An Open edX platform XBlock to create and display flashcards.
+
+The flashcards are added like this:
+
+```html
+<flashcards title="Capital cities">
+<flashcard front="Croatia" back="Zagreb" />
+<flashcard front="France" back="Paris" />
+</flashcards>
+```
+
+The XBlock in Studio looks like this:
+![Flashcard_edit](flashcardsxblock_edit.png)
+
+Output looks like this:
+
+![Flashcard](flashcardsxblock.png)
+
+## Want to contribute?
+If you have a suggestion, question or found a bug, please [open an issue](https://github.com/vkaracic/FlashcardsXBlock/issues/new) for it.
+
+If you want to contribute code then you're awesome, and please open a pull request with details about the changes that you propose.

flashcardsxblock-1.0.0rc1.dist-info/RECORD

@@ -0,0 +1,11 @@
+flashcards/__init__.py,sha256=dg51VfSGQZbgK6pDLCpa-9maZHMxzFOBGv8y9jBYXC0,110
+flashcards/flashcards.py,sha256=PcKoLBys_JeOiA0GBgtb0V9Fr0eRuGgaAc55M--3R5E,4284
+flashcards/static/html/studio.html,sha256=PMRqbAdU3YyMrN5VYTXEjinBHde8ejV0Y3qazlGBGDU,64
+flashcards/static/js/student.js,sha256=Bq_EgK7telZUqnBrC2KVQ_CSmw0ETbSBvAmMX-hCxr0,160
+flashcards/static/js/studio.js,sha256=Kls8y1EJ5niZr7iAwjoxqfi1FmWyEwTE4KrpT8F6NeE,175
+flashcardsxblock-1.0.0rc1.dist-info/licenses/LICENSE,sha256=myvkJeoIF-3SOyL2XBnn3EBoQGc75jOnEapU6qC7Aa0,1073
+flashcardsxblock-1.0.0rc1.dist-info/METADATA,sha256=UACMDEhq_XITkS9Dqz7DLaaogt7O0rdawXXNV3chXFQ,1370
+flashcardsxblock-1.0.0rc1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flashcardsxblock-1.0.0rc1.dist-info/entry_points.txt,sha256=adWsUbz4i8AJTwoqq_EULWSQT6YfukJZb2olFa6-6Js,53
+flashcardsxblock-1.0.0rc1.dist-info/top_level.txt,sha256=1j-1IPsI5ozT1YqHDZuMFzGsndw-dB2oh7tzi5YGOS0,11
+flashcardsxblock-1.0.0rc1.dist-info/RECORD,,

flashcardsxblock-1.0.0rc1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

flashcardsxblock-1.0.0rc1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[xblock.v1]
+flashcards = flashcards:FlashcardsXBlock

flashcardsxblock-1.0.0rc1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Vedran Karačić
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

flashcardsxblock-1.0.0rc1.dist-info/top_level.txt

@@ -0,0 +1 @@
+flashcards