flashcards

Note

This README was auto-generated. Maintainer: please review its contents and update all relevant sections. Instructions to you are marked with "PLACEHOLDER" or "TODO". Update or remove those sections, and remove this note when you are done.

Purpose

Service for managing and displaying flashcards

This service contains the following functionality:

• Generate flashcard candidates from course content via OpenAI
• Display flashcards to learners

Future versions will also include interfaces for selecting which generated cards to actually use and authoring new cards.

The service leverages the Anki project for flashcard management and display.

Getting Started

Running The Application using Docker

# Build the docker image:
make docker_build

# Spin up the containers:
make dev.up

# Enter the shell:
make app-shell
python manage.py shell

# Import function and test it:
from flashcards.apps.cards.anki import main

Start fetching content locally

checkout https://github.com/edx/ai-aside/tree/ashultz0/extractor into src provision a user in the devstack folder with the lms running: ./provision-ida-user.sh flashcards flashcards 3000 run make install-local in ai-aside restart lms so that the aside actually loads You must create an XBlockAsidesConfig (admin URL: /admin/lms_xblock/xblockasidesconfig/). This model has a list of blocks you do not want asides to apply to that can be left alone, and an enabled setting that unsurprisingly should be True.

Developing

One Time Setup

# Clone the repository
git clone git@github.com:edx/flashcards.git
cd flashcards

# Set up a virtualenv with the same name as the repo and activate it
# Here's how you might do that if you have virtualenvwrapper setup.
mkvirtualenv -p python3.8 flashcards

Every time you develop something in this repo

# Activate the virtualenv
# Here's how you might do that if you're using virtualenvwrapper.
workon flashcards

# Grab the latest code
git checkout main
git pull

# Install/update the dev requirements
make requirements

# Run the tests and quality checks (to verify the status before you make any changes)
make validate

# Make a new branch for your changes
git checkout -b <your_github_username>/<short_description>

# Using your favorite editor, edit the code to make your change.
vim ...

# Run your new tests
pytest ./path/to/new/tests

# Run all the tests and quality checks
make validate

# Commit all your changes
git commit ...
git push

# Open a PR and ask for review.

Deploying

TODO: How can a new user go about deploying this component? Is it just a few commands? Is there a larger how-to that should be linked here?

PLACEHOLDER: For details on how to deploy this component, see the deployment how-to

Getting Help

Documentation

PLACEHOLDER: Start by going through the documentation. If you need more help see below.

(TODO: Set up documentation)

More Help

If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.

For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.

https://github.com/edx/flashcards/issues

For more information about these options, see the Getting Help page.

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

Contributing

Contributions are very welcome. Please read How To Contribute for details.

This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.

The Open edX Code of Conduct

All community members are expected to follow the Open edX Code of Conduct.

People

The assigned maintainers for this component and other project details may be found in Backstage. Backstage pulls this data from the catalog-info.yaml file in this repo.

Reporting Security Issues

Please do not report security issues in public. Please email security@openedx.org.