platform-plugin-braze
This is an edx-platform plugin designed to integrate with edx.org’s Braze account.
One major thing it does is identify hubspot-alias-only accounts once a user registers for an LMS account (thus merging the two Braze profiles into one).
It’s unique to edx.org’s specific deployment and services, and thus is not part of Open edX releases.
Overview
This repo holds a single edx_braze djangoapp module, meant to be pip-installed during deployment of edx-platform and which will register itself as an edx platform plugin.
Development Workflow
One Time Setup
# Clone the repository
git clone git@github.com:edx/platform-plugin-braze.git
cd platform-plugin-braze
# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.12 platform-plugin-braze
Every time you develop something in this repo
# Activate the virtualenv
workon platform-plugin-braze
# Grab the latest code
git checkout master
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.
Reporting Security Issues
Please do not report security issues in public. Please email security@edx.org.
Change Log
Unreleased
[3.0.0] - 2026-10-12
Dropped support for Python 3.8 and Django 3.2.
Added support for Python 3.12 and Django 5.2. Python 3.11 and Django 4.2 are still supported.
[2.1.1] - 2023-09-22
Added support for Django 4.2
[2.1.0] - 2023-07-14
Remove Support for identifying alias-only save_for_later users in Braze, when a user with a matching email registers in the LMS
[2.0.0] - 2022-02-16
Dropped support for Django22, 30 and 31
Added Django40 support
[1.2.0] - 2021-12-14
Support added for identifying alias-only save_for_later users in Braze, when a user with a matching email registers in the LMS
[1.1.0] - 2021-09-21
Added support for Django 3.1 and 3.2
[1.0.0] - 2021-06-04
First release
Supports identifying alias-only hubspot users in Braze, when a user with a matching email registers in the LMS.
Metadata
Release files for platform-plugin-braze 3.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| platform_plugin_braze-3.0.0.tar.gz | 20.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| platform_plugin_braze-3.0.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 38.3 kB
Release files / platform_plugin_braze-3.0.0.tar.gz
| Download URL | platform_plugin_braze-3.0.0.tar.gz |
|---|---|
| Size | 20.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a23490fb61120a7bf89dc19b40f38a24e412a9aa4fe033a3b1a91bc742a58d91
|
|
BLAKE2b-256 checksum How to use checksums |
0ff62a2b69de09ce797a765ffc263376413fbb281a5d06b58b08038de3db192e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / platform_plugin_braze-3.0.0-py2.py3-none-any.whl
| Download URL | platform_plugin_braze-3.0.0-py2.py3-none-any.whl |
|---|---|
| Size | 17.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
055a4466ffc49b2728e7c820fd54c8db583ae3940254789fbf4e5c46f11d463e
|
|
BLAKE2b-256 checksum How to use checksums |
3ce54631613340394e0a3582f2ae3368c6a719cb6ca8e2d03b1c425c27395610
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|