Skip to main content

FlashcardsXBlock

An Open edX platform XBlock to create and display flashcards.

Installation

In a Tutor deployment, you can add it to OPENEDX_EXTRA_PIP_REQUIREMENTS, installing from git:

OPENEDX_EXTRA_PIP_REQUIREMENTS:
- git+https://github.com/open-craft/FlashcardsXBlock.git@main

Or from a Pypi release:

OPENEDX_EXTRA_PIP_REQUIREMENTS:
- FlashcardsXBlock==1.0.1

Usage

Once the Flashcards XBlock is installed in the Open edX environment, you can navigate to the "Advanced settings" of the course in Studio or Authoring, then add "flashcards" to the "Advanced module list".

Then navigate to the unit in the course where you want to add a Flashcards component, and select "Flashcards" from the "Advanced" component list.

Screenshots

Student view:

student view: starting screen

student view: a flashcard

Editing modal in Authoring:

edit view: edit screen one, where you can select theming

edit view: edit screen two, where you can enter flashcard content

Development notes

  • There is a Github workflow that automatically creates Pypi releases when you create a release on Github.

Frontend

The frontend is built using Typescript and React; it must be built before it can be used. See ./mise.toml and ./frontend/package.json for available tasks. An example development workflow could look something like this:

# install dependencies
mise run frontend-install

# run a development server with hot-reloading
mise run frontend-dev

# edit the frontend files

# when ready, kill the dev server, and build the frontend.
# If you have this XBlock installed on your Open edX devstack, you can then refresh the page to see updates in live components in a course on the devstack.
mise run frontend-build

# check the unit tests
mise run frontend-test

Want to contribute?

If you have a suggestion, question or found a bug, please open an issue.

If you would like to contribute code, please open a pull request with details about the changes that you propose.

Metadata

Release files for FlashcardsXBlock 1.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for FlashcardsXBlock 1.1.2
File Size Uploaded Provenance Actions
flashcardsxblock-1.1.2.tar.gz 789.3 kB Without provenance Details for flashcardsxblock-1.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for FlashcardsXBlock 1.1.2
File Interpreter ABI Platform Actions
flashcardsxblock-1.1.2-py3-none-any.whl Python 3 none any Details for flashcardsxblock-1.1.2-py3-none-any.whl

Total release size: 1.6 MB

Release files / flashcardsxblock-1.1.2.tar.gz

Download URL flashcardsxblock-1.1.2.tar.gz
Size 789.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d66fceeb96bfc34ec272fb3b5abcdc36cf26df9896509f6ba6e4da51ab8777d8
BLAKE2b-256 checksum
How to use checksums
3ebdebd47c3a83c219691b4333b0c22b007d7c5aefd52312e699792b9e1def99
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / flashcardsxblock-1.1.2-py3-none-any.whl

Download URL flashcardsxblock-1.1.2-py3-none-any.whl
Size 794.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
177062cff71abcac33f10809939d06ab89cc1039e4b55250be3c4a77d14910bc
BLAKE2b-256 checksum
How to use checksums
bfd54ad2ecdfe83a4944cb8e86c99243077a150d8a1cd84067e6d430fa7a8bce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for FlashcardsXBlock 1.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page