platform-plugin-braze 1.1.0

Custom Braze integration for edx.org's edx-platform deployment

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 [e-mail]: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.8 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 [e-mail].

Change Log

Unreleased

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