Skip to main content

Open edX events from the Hooks Extensions Framework

Project description

PyPI CI Codecov Documentation Supported Python versions License status-badge

Open edX Events from Hooks Extensions Framework (OEP-50).

Purpose

This repository implements the necessary tooling and definitions used by the Hooks Extension Framework to manage the events execution and extra tools.

Getting Started

Developing

One Time Setup

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

# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.8 openedx-events

Every time you develop something in this repo

# Activate the virtualenv
workon openedx-events

# 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

The Open edX Events component is a Python library which doesn’t need independent deployment. Therefore, its setup is reasonably straightforward. First, it needs to be added to your service requirements, and then it will be installed alongside requirements of the service.

If the service you intend to use is either the LMS or CMS, then the library is installed alongside their requirements since the Maple release.

Getting Help

Documentation

See documentation on Read the Docs.

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/openedx/openedx-events/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@tcril.org.

Change Log

Unreleased

[0.13.0] - 2022-09-16

Added

  • Added new event PERSISTENT_GRADE_SUMMARY_CHANGED.

  • Improvements in make upgrade command and requirements files.

  • Manually update requirements files to fix requirements bot issue with pip/setup tools.

  • Change GitHub workflow to community maintained repository health file.

[0.12.0] - 2022-08-16

Changed

  • Breaking change: Removed org and number fields from CourseCatalogData (should only affect unreleased event-bus code, though)

[0.11.1] - 2022-07-28

Fixed

  • Handle optional (None) values for custom serializers

[0.11.0] - 2022-07-21

Added

  • Added new content_authoring module with new COURSE_CATALOG_INFO_CHANGED signal

[0.10.0] - 2022-05-20

Changed

  • BREAKING CHANGE: Split AvroAttrsBridge into schema, serialization, and deserialization phases

[0.9.1] - 2022-05-20

Changed

  • Remove assigned_email from SubscriptionLicenseData

[0.9.0] - 2022-04-28

Changed

  • Updated AvroAttrsBridge to handle optional/nullable fields

[0.8.3] - 2022-04-26

Changed

  • Updated AvroAttrsBridge to create schemas from signal data dict rather than individual attrs classes

[0.8.2] - 2022-04-13

Changed

  • Changed openedx_events.learning.data.DiscussionTopicContext to make the group id optional

  • Changed DiscussionTopicContext to add a context attribute

[0.8.1] - 2022-03-03

Added

  • Added missing field for event COURSE_DISCUSSIONS_CHANGED

[0.8.0] - 2022-02-25

Added
  • Added COURSE_DISCUSSIONS_CHANGED for discussion event

Changed
  • Changed openedx_events/enterprise/LicenseLifecycle class to openedx_events/enterprise/SubscriptionLicenseData

  • Changed LicenseCreated signal class to SUBSCRIPTION_LICENSE_MODIFIED signal class

[0.7.1] - 2022-01-13

Added

  • Added data definition for enterprise/LicenseLifecycle

  • Added LicenseCreated signal definition

[0.7.0] - 2022-01-06

Added

  • Added AvroAttrsBridge class to convert between avro standard and attrs classes

[0.6.0] - 2021-09-15

Added
  • Add custom formatting class for events responses.

  • Add a way to use send method instead of send_robust while testing.

Changed
  • Remove unnecessary InstantiationError exception.

  • Default is send_robust instead of send unless specified otherwise.

[0.5.1] - 2021-08-26

Changed

  • Remove TestCase inheritance from OpenEdxTestMixin.

[0.5.0] - 2021-08-24

Added

  • Utilities to use while testing in other platforms.

[0.4.1] - 2021-08-18

Changed

  • Remove raise_exception assignment in events metadata.

[0.4.0] - 2021-08-18

Added

  • Preliminary Open edX events definitions.

[0.3.0] - 2021-08-18

Added

  • Add tooling needed to create and trigger events in Open edX platform.

  • Add Data Attribute classes used as arguments by Open edX Events.

[0.2.0] - 2021-07-28

Changed

  • Update repository purpose.

  • Changed max-doc-length from 79 to 120 following community recommendation.

[0.1.3] - 2021-07-01

Changed

  • Update setup.cfg with complete bumpversion configuration.

[0.1.2] - 2021-06-29

Changed

  • Update documentation with current organization info.

[0.1.1] - 2021-06-29

Added

  • Add Django testing configuration.

[0.1.0] - 2021-04-07

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

openedx-events-0.13.0.tar.gz (43.9 kB view hashes)

Uploaded Source

Built Distribution

openedx_events-0.13.0-py2.py3-none-any.whl (49.1 kB view hashes)

Uploaded Python 2 Python 3

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