Package: openedx-events-sender
openedx-events-senderPurposeSend Open edX events to selected URLs.Getting StartedDevelopingOne Time Setup# Clone the repository
git clone git@github.com:open-craft/openedx-events-sender.git
cd openedx-events-sender

# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.8 openedx-events-senderEvery time you develop something in this repo# Activate the virtualenv
workon openedx-events-sender

# 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.DeployingNative InstallationTo deploy this to an Open edX instance, include it in theEDXAPP_PRIVATE_REQUIREMENTSorEDXAPP_EXTRA_REQUIREMENTSvariables.Include the require configuration settings inEDXAPP_LMS_ENV_EXTRAvariable.Tutor InstallationToinstallthis in the Open edX build, include it in theconfig.ymlfile using theOPENEDX_EXTRA_PIP_REQUIREMENTSvariable.You need to rebuild the Open edX image:tutor images build openedxAdd the required configuration settings using ayaml tutor plugin:name:events_sender_pluginversion:0.1.0patches:lms-env:|EVENT_SENDER_ENROLLMENT_URL: "https://webhook.site/xyz"EVENT_SENDER_ENROLLMENT_HEADERS: {"Authorization": "TEST DATA"}EVENT_SENDER_ENROLLMENT_FIELD_MAPPING: {"user_pii_email": "email","course_course_key": "course_id","is_active": "is_active"}DocumentationEventsCOURSE_ENROLLMENT_CHANGEDExample payload{"event":"org.openedx.learning.course.enrollment.changed.v1","user_id":42,"user_is_active":true,"user_pii_username":"test","user_pii_email":"test@example.com","user_pii_name":"Test Name","course_course_key":"course-v1:edX+DemoX+Demo_Course","course_display_name":"Demonstration Course","course_start":"2022-09-30 00:00:00","course_end":null,"mode":"audit","is_active":true,"creation_date":"2022-09-30 12:34:56","created_by":null}ConfigurationTo send this event, you need to setEVENT_SENDER_ENROLLMENT_URLin your settings.You can pass custom headers by settingEVENT_SENDER_ENROLLMENT_HEADERS.You can define custom field mapping withEVENT_SENDER_ENROLLMENT_FIELD_MAPPING.
E.g. If you would like to sendemailinstead ofuser_pii_email, set this to the following value:{"user_pii_email":"email"}You can also define event-specific metadata by prefixing variables fromEventMetadatawithmetadata_. E.g. to get the event’s name, you should
specifymetadata_event_typeas a key in the mapping.Note: if you want to use custom mapping, you need to defineallvalues that will be sent. If you define an empty field mapping, then an empty dict will be sent in the request.Getting HelpIf you’re having trouble, we have discussion forums athttps://discuss.openedx.orgwhere you can connect with others in the
community.Our real-time conversations are on Slack. You can request aSlack
invitation, then join ourcommunity 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/open-craft/openedx-events-sender/issuesFor more information about these options, see theGetting Helppage.LicenseThe code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.Please seeLICENSE.txtfor details.ContributingContributions are very welcome.
Please readHow To Contributefor 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 ConductAll community members are expected to follow theOpen edX Code of Conduct.PeopleThe assigned maintainers for this component and other project details may be
found inBackstage. Backstage pulls this data from thecatalog-info.yamlfile in this repo.Reporting Security IssuesPlease do not report security issues in public. Please emailsecurity@tcril.org.Change LogUnreleased[1.0.0] - 2022-10-17AddedFirst release on PyPI.