openedx-webhooks 0.2.0

Webhooks for Open edX

Open edX Webhooks

Purpose

Webhooks for Open edX

This plugin implements a generic case of events handling that trigger a request to a configurable URL when a signal is received.

Getting Started

Developing

More information about available signals can be found in the events documentation and the filters documentation

One Time Setup

# Clone the repository
git clone [e-mail]:aulasneo/openedx-webhooks.git
cd openedx-webhooks

# 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 openedx-webhooks

Every time you develop something in this repo

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

# 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

To install this plugin into an Open edX installed by Tutor add this line to the OPENEDX_EXTRA_PIP_REQUIREMENTS list.

- git+https://github.com/aulasneo/openedx-webhooks

If it is an existing installation, you might need to run migrations to create the database table. For this, run:

tutor {dev|local|k8s} exec lms ./manage.py lms migrate

Configuring

A new section named Webhooks will be available in the LMS Django admin site. Add a new webhook to define the URLs that will be called after each event is received. More than one URL can be configured for each event. In this case, all URLs will be called.

Getting Help

If you need any help, send us an email to [e-mail].

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/aulasneo/openedx-webhooks/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 [e-mail].

Change Log

Version 0.2.0 (2023-06-06)

• Renamed package to openedx_webhooks. Upload to PyPI.

Version 0.1.1 (2023-06-05)

• Improve documentation

0.1.0 – 2023-05-31

Added

• First release on PyPI.