Skip to main content

Plugin for a learning assistant backend, intended for use within edx-platform

Project description

learning-assistant

PyPI CI Codecov Documentation Supported Python versions License status-badge

Purpose

Plugin for a learning assistant backend, intended for use within edx-platform.

This library contains data models and logic for a platform wide learning assistant.

Dependencies

In addition to the edx-platform repository in which this library is installed, this plugin also leverages the frontend-lib-learning-assistant as a frontend interface for the learning assistant.

Getting Started

Developing

One Time Setup

# Clone the repository
git clone git@github.com:openedx/learning-assistant.git
cd learning-assistant

# 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 learning-assistant

Every time you develop something in this repo

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

# 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.

License

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

Please see LICENSE.txt for details.

Contributing

This repo is not currently accepting contributions.

The Open edX Code of Conduct

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

Reporting Security Issues

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

Change Log

Unreleased

3.2.0 - 2024-01-30

  • Remove audit access to chat view.

3.0.1 - 2024-01-29

  • Modify gating of learning assistant based on waffle flag and enabled value.

3.0.0 - 2024-01-23

  • Remove and drop the course prompt model.

2.0.3 - 2024-01-22

  • Remove references to the course prompt model.

2.0.1 - 2024-01-08

  • Gate content integration with waffle flag

2.0.0 - 2024-01-03

  • Add content cache

  • Integrate system prompt setting

1.5.0 - 2023-10-18

  • Add management command to generate course prompts

1.4.0 - 2023-09-11

  • Send reduced message list if needed to avoid going over token limit

1.3.3 - 2023-09-07

  • Allow any enrolled learner to access API.

1.3.2 - 2023-08-25

  • Remove deserialization of prompt field, as it is represented in the python native format

1.3.1 - 2023-08-24

  • Remove prompt field

1.3.0 - 2023-08-24

  • Remove references to prompt field

  • Create json_prompt field to allow for more flexible prompts

1.2.1 - 2023-08-24

  • make prompt field nullable

1.2.0 - 2023-08-22

  • add endpoint authentication

  • fix request structure required for endpoint integration

1.1.0 - 2023-08-09

  • fix for course id to course key conversion

1.0.0 - 2023-08-08

  • Add endpoint to retrieve chat response

  • Created model to associate course ideas with a specific prompt text

Unreleased

0.1.0 – 2023-07-26

Added

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

learning-assistant-3.2.0.tar.gz (34.8 kB view details)

Uploaded Source

Built Distribution

learning_assistant-3.2.0-py2.py3-none-any.whl (30.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file learning-assistant-3.2.0.tar.gz.

File metadata

  • Download URL: learning-assistant-3.2.0.tar.gz
  • Upload date:
  • Size: 34.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for learning-assistant-3.2.0.tar.gz
Algorithm Hash digest
SHA256 0311705264590c6031294ca9801b38b2f3294747f46cd1851d620b6812ee0034
MD5 50fce6f78ed902ddd327c576bd4c149b
BLAKE2b-256 727f42e17ee5912eefe3074bb1d73e4ea7d972f1ec70debcd6c47cb57abb66e9

See more details on using hashes here.

File details

Details for the file learning_assistant-3.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for learning_assistant-3.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 badee44b8a169cd84dba6cf6fe91aff05605cdf017b6b54581415c463785932e
MD5 09fb9460a11707ccd34b009cd13052ca
BLAKE2b-256 e058ecad5a0cc7630860593d493d4c4b38115ad7280fecfc2f98d5b4e88d0874

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page