FlashcardsXBlock 1.0.0rc1__tar.gz

flashcardsxblock-1.0.0rc1/FlashcardsXBlock.egg-info/PKG-INFO

@@ -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/FlashcardsXBlock.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+FlashcardsXBlock.egg-info/PKG-INFO
+FlashcardsXBlock.egg-info/SOURCES.txt
+FlashcardsXBlock.egg-info/dependency_links.txt
+FlashcardsXBlock.egg-info/entry_points.txt
+FlashcardsXBlock.egg-info/requires.txt
+FlashcardsXBlock.egg-info/top_level.txt
+flashcards/__init__.py
+flashcards/flashcards.py
+flashcards/static/html/studio.html
+flashcards/static/js/student.js
+flashcards/static/js/studio.js

flashcardsxblock-1.0.0rc1/FlashcardsXBlock.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

flashcardsxblock-1.0.0rc1/FlashcardsXBlock.egg-info/entry_points.txt

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

flashcardsxblock-1.0.0rc1/FlashcardsXBlock.egg-info/requires.txt

@@ -0,0 +1 @@
+XBlock

flashcardsxblock-1.0.0rc1/FlashcardsXBlock.egg-info/top_level.txt

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

flashcardsxblock-1.0.0rc1/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/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,23 @@
+# 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/flashcards/__init__.py

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

flashcardsxblock-1.0.0rc1/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"}

flashcardsxblock-1.0.0rc1/flashcards/static/html/studio.html

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

flashcardsxblock-1.0.0rc1/flashcards/static/js/student.js

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

flashcardsxblock-1.0.0rc1/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/pyproject.toml

@@ -0,0 +1,170 @@
+[project]
+name = "FlashcardsXBlock"
+version = "1.0.0-rc1"
+description = "A Flashcards XBlock for Open edX."
+readme = {file = "README.md", content-type = "text/markdown"}
+requires-python = ">=3.11"
+license = "MIT"
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Django",
+    "Framework :: Django :: 4.2",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+]
+keywords = ["Python", "edx"]
+dependencies = [
+    "XBlock",  # XBlock framework
+]
+
+[project.urls]
+Homepage = "https://github.com/open-craft/FlashcardsXBlock"
+
+[project.entry-points."xblock.v1"]
+flashcards = "flashcards:FlashcardsXBlock"
+
+[tool.setuptools.packages.find]
+include = ["flashcards", "flashcards.*"]
+exclude = ["*tests"]
+
+[tool.setuptools.package-data]
+flashcards = ["*.css", "*.js", "*.html", "static/**/*", "templates/**/*"]
+
+[dependency-groups]
+test = [
+    "pytest-cov",                # pytest extension for code coverage statistics
+    "code-annotations",          # provides commands used by the pii_check make target
+    "xblock-sdk",                # provides workbench settings for testing
+]
+ci = [
+    "tox",                       # Virtualenv management for tests
+    "tox-uv",                    # Replace pip with uv in tox
+]
+quality = [
+    "ruff",                      # Linter and formatter
+]
+dev = [
+    {include-group = "test"},
+    {include-group = "ci"},
+    {include-group = "quality"},
+    "diff-cover",                # Changeset diff test coverage
+    "edx-i18n-tools",            # For i18n_tool dummy
+]
+
+[tool.uv]
+constraint-dependencies = [
+    # External constraints (DO NOT REMOVE THIS LINE)
+    "Django<5.0",
+    "elasticsearch<7.14.0",
+    "django-simple-history==3.0.0",
+    "pip<24.3",
+    "urllib3<2.3.0"
+]
+
+[tool.coverage.run]
+include = ['flashcards/**']
+omit = ['tests/*']
+
+[tool.ruff]
+line-length = 120
+exclude = ['migrations', 'docs', 'manage.py']
+target-version = 'py311'
+
+[tool.ruff.lint]
+select = [
+    'F',    # Pyflakes
+    'E',    # Pycodestyle (errors)
+    'W',    # Pycodestyle (warnings)
+    'C90',  # mccabe
+    'I',    # isort
+    'N',    # pep8-naming
+    'D',    # pydocstyle
+    'UP',   # pyupgrade
+    'YTT',  # flake8-2020
+    'ANN',  # flake8-annotations
+    'ASYNC',# flake8-async
+    'S',    # flake8-bandit
+    'BLE',  # flake8-blind-except
+    'FBT',  # flake8-boolean-trap
+    'B',    # flake8-bugbear
+    'A',    # flake8-builtins
+    'COM',  # flake8-commas
+    'C4',   # flake8-comprehensions
+    'DTZ',  # flake8-datetimez
+    'T10',  # flake8-debugger
+    'DJ',   # flake8-django
+    'EM',   # flake8-errmsg
+    'EXE',  # flake8-executable
+    'FA',   # flake8-future-annotations
+    'ISC',  # flake8-implicit-str-concat
+    'ICN',  # flake8-import-conventions
+    'LOG',  # flake8-logging
+    'G',    # flake8-logging-format
+    'INP',  # flake8-no-pep420
+    'PIE',  # flake8-pie
+    'T20',  # flake8-print
+    'PYI',  # flake8-pyi
+    'PT',   # flake8-pytest-style
+    'Q',    # flake8-quotes
+    'RSE',  # flake8-raise
+    'RET',  # flake8-return
+    'SLF',  # flake8-self
+    'SLOT', # flake8-slots
+    'SIM',  # flake8-simplify
+    'TID',  # flake8-tidy-imports
+    'TC',   # flake8-type-checking
+    'INT',  # flake8-gettext
+    'ARG',  # flake8-unused-arguments
+    'PTH',  # flake8-use-pathlib
+    'TD',   # flake8-todos
+    'ERA',  # eradicate
+    'PD',   # pandas-vet
+    'PGH',  # pygrep-hooks
+    'PL',   # Pylint
+    'TRY',  # tryceratops
+    'FLY',  # flynt
+    'NPY',  # NumPy-specific rules
+    'AIR',  # Airflow
+    'PERF', # Perflint
+    'FURB', # refurb
+    # TODO: Enable preview.
+    # 'DOC',  # pydoclint
+    'RUF',  # Ruff-specific rules
+]
+ignore = [
+    'ANN002', # missing-type-args
+    'ANN003', # missing-type-kwargs
+    'ANN204', # missing-return-type-special-method
+    'D203',   # one-blank-line-before-class
+    'D212',   # multi-line-summary-first-line (incompatible with D213)
+    'Q000',   # bad-quotes-inline-string
+    'TD002',  # missing-t\odo-author
+    'TD003',  # missing-t\odo-link
+    'TRY003', # raise-vanilla-args
+]
+
+[tool.ruff.lint.per-file-ignores]
+'tests/*' = [
+    'S101',   # assert
+    'INP001', # implicit-namespace-package
+    'SLF001', # private-member-access
+    'RUF018', # assignment-in-assert
+]
+
+[tool.ruff.lint.flake8-annotations]
+suppress-none-returning = true
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.pylint]
+allow-magic-value-types = ['int', 'str']
+
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "workbench.settings"
+addopts = "--cov flashcards --cov tests --cov-report term-missing --cov-report xml"
+norecursedirs = ".* docs requirements site-packages"

flashcardsxblock-1.0.0rc1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+