platform-plugin-braze
=====================
|ci-badge| |codecov-badge|
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`_.
.. _edx platform plugin: https://github.com/edx/edx-django-utils/tree/master/edx_django_utils/plugins
Development Workflow
--------------------
One Time Setup
~~~~~~~~~~~~~~
.. code-block::
# 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.8 platform-plugin-braze
Every time you develop something in this repo
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block::
# 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.
.. |ci-badge| image:: https://github.com/edx/platform-plugin-braze/workflows/Python%20CI/badge.svg?branch=master
:target: https://github.com/edx/platform-plugin-braze/actions
:alt: CI
.. |codecov-badge| image:: https://codecov.io/github/edx/platform-plugin-braze/coverage.svg?branch=master
:target: https://codecov.io/github/edx/platform-plugin-braze?branch=master
:alt: Codecov
Change Log
----------
..
All enhancements and patches to edx_braze will be documented
in this file. It adheres to the structure of https://keepachangelog.com/ ,
but in reStructuredText instead of Markdown (for ease of incorporation into
Sphinx documentation and the PyPI description).
This project adheres to Semantic Versioning (https://semver.org/).
.. There should always be an "Unreleased" section for changes pending release.
Unreleased
~~~~~~~~~~
*
[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.
Raw data
{
"_id": null,
"home_page": "https://github.com/edx/platform-plugin-braze",
"name": "platform-plugin-braze",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Python edx",
"author": "edX",
"author_email": "oscm@edx.org",
"download_url": "https://files.pythonhosted.org/packages/84/a6/0e4dde36ae8905ecb2a7844ca956f392831c89225143c399e0401cf872de/platform-plugin-braze-2.1.1.tar.gz",
"platform": null,
"description": "platform-plugin-braze\n=====================\n\n|ci-badge| |codecov-badge|\n\nThis is an edx-platform plugin designed to integrate with edx.org's Braze\naccount.\n\nOne major thing it does is ``identify`` hubspot-alias-only accounts once a\nuser registers for an LMS account (thus merging the two Braze profiles into\none).\n\nIt's unique to edx.org's specific deployment and services, and thus is not\npart of Open edX releases.\n\nOverview\n--------\n\nThis repo holds a single ``edx_braze`` djangoapp module, meant to be\npip-installed during deployment of ``edx-platform`` and which will register\nitself as an `edx platform plugin`_.\n\n.. _edx platform plugin: https://github.com/edx/edx-django-utils/tree/master/edx_django_utils/plugins\n\nDevelopment Workflow\n--------------------\n\nOne Time Setup\n~~~~~~~~~~~~~~\n.. code-block::\n\n # Clone the repository\n git clone git@github.com:edx/platform-plugin-braze.git\n cd platform-plugin-braze\n\n # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it\n mkvirtualenv -p python3.8 platform-plugin-braze\n\n\nEvery time you develop something in this repo\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n.. code-block::\n\n # Activate the virtualenv\n workon platform-plugin-braze\n\n # Grab the latest code\n git checkout master\n git pull\n\n # Install/update the dev requirements\n make requirements\n\n # Run the tests and quality checks (to verify the status before you make any changes)\n make validate\n\n # Make a new branch for your changes\n git checkout -b <your_github_username>/<short_description>\n\n # Using your favorite editor, edit the code to make your change.\n vim \u2026\n\n # Run your new tests\n pytest ./path/to/new/tests\n\n # Run all the tests and quality checks\n make validate\n\n # Commit all your changes\n git commit \u2026\n git push\n\n # Open a PR and ask for review.\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@edx.org.\n\n.. |ci-badge| image:: https://github.com/edx/platform-plugin-braze/workflows/Python%20CI/badge.svg?branch=master\n :target: https://github.com/edx/platform-plugin-braze/actions\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/edx/platform-plugin-braze/coverage.svg?branch=master\n :target: https://codecov.io/github/edx/platform-plugin-braze?branch=master\n :alt: Codecov\n\n\nChange Log\n----------\n\n..\n All enhancements and patches to edx_braze will be documented\n in this file. It adheres to the structure of https://keepachangelog.com/ ,\n but in reStructuredText instead of Markdown (for ease of incorporation into\n Sphinx documentation and the PyPI description).\n\n This project adheres to Semantic Versioning (https://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n~~~~~~~~~~\n\n*\n\n[2.1.1] - 2023-09-22\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Added support for Django 4.2\n\n[2.1.0] - 2023-07-14\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Remove Support for identifying alias-only ``save_for_later`` users in Braze,\n when a user with a matching email registers in the LMS\n\n[2.0.0] - 2022-02-16\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Dropped support for Django22, 30 and 31\n* Added Django40 support\n\n[1.2.0] - 2021-12-14\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Support added for identifying alias-only ``save_for_later`` users in Braze,\n when a user with a matching email registers in the LMS\n\n[1.1.0] - 2021-09-21\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Added support for Django 3.1 and 3.2\n\n[1.0.0] - 2021-06-04\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* First release\n* Supports identifying alias-only ``hubspot`` users in Braze, when a user\n with a matching email registers in the LMS.\n",
"bugtrack_url": null,
"license": "",
"summary": "Custom Braze integration for edx.org's edx-platform deployment",
"version": "2.1.1",
"project_urls": {
"Homepage": "https://github.com/edx/platform-plugin-braze"
},
"split_keywords": [
"python",
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6690414ac0a86827436fc6a12de48ee2e24fbd79daeb812bf8f5acd55d871fe7",
"md5": "6cd6c967dd14b55cb1b4a32639a44f40",
"sha256": "e60429a4a4906427eef79af90f479cc3d791b93b75590b919f4c8ac474d913cd"
},
"downloads": -1,
"filename": "platform_plugin_braze-2.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6cd6c967dd14b55cb1b4a32639a44f40",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 17665,
"upload_time": "2023-09-25T14:33:01",
"upload_time_iso_8601": "2023-09-25T14:33:01.603640Z",
"url": "https://files.pythonhosted.org/packages/66/90/414ac0a86827436fc6a12de48ee2e24fbd79daeb812bf8f5acd55d871fe7/platform_plugin_braze-2.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "84a60e4dde36ae8905ecb2a7844ca956f392831c89225143c399e0401cf872de",
"md5": "9fce7ea22643559e3fe5c684e1b6750f",
"sha256": "e58e5d464595e65503419653120bfba4c81ecefb51c020a3346046af5f20721d"
},
"downloads": -1,
"filename": "platform-plugin-braze-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "9fce7ea22643559e3fe5c684e1b6750f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20100,
"upload_time": "2023-09-25T14:33:03",
"upload_time_iso_8601": "2023-09-25T14:33:03.309488Z",
"url": "https://files.pythonhosted.org/packages/84/a6/0e4dde36ae8905ecb2a7844ca956f392831c89225143c399e0401cf872de/platform-plugin-braze-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 14:33:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edx",
"github_project": "platform-plugin-braze",
"github_not_found": true,
"lcname": "platform-plugin-braze"
}
JSON
