edx-braze-client 0.2.5

Python client for interacting with Braze APIs

Python client for interacting with Braze APIs.

Development Workflow

One Time Setup

# Clone the repository
git clone [e-mail]:edx/braze-client.git
cd braze-client

# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.8 braze-client
or
virtualenv --python=python3 <venv>

Every time you develop something in this repo

# Activate the virtualenv
workon braze-client
or
source <venv>/bin/activate

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

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome. Please read How To Contribute for details. Even though they were written with edx-platform in mind, the guidelines should be followed for all Open edX projects.

The pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you can find it at PULL_REQUEST_TEMPLATE.md.

The issue report template should be automatically applied if you are creating an issue on GitHub as well. Otherwise you can find it at ISSUE_TEMPLATE.md.

Reporting Security Issues

Please do not report security issues in public. Please email [e-mail].

Getting 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 more information about these options, see the Getting Help page.

Change Log

Unreleased

[0.2.5]

chore: Updates version

[0.2.4]

feat: adds ‘create_recipients’ function to the braze client

[0.2.3]

feat: pass error response content into raised exceptions

[0.2.2]

fix: be defensive about pulling both email and external_id from braze export.

[0.2.1]

fix: be defensive about pulling external_id from braze export.

[0.2.0]

feat: check for external ids in batchs when creating aliases.

[0.1.8]

fix: always create an alias for existing profiles

[0.1.7]

feat: add retrieve_unsubscribed_emails method

[0.1.6]

feat: add unsubscribe_user_email method

[0.1.5]

feat: add send_canvas_message method

[0.1.4]

feat: add identify_users method

[0.1.3]

fix: handle intermittent JSONDecodeError from from Braze

[0.1.2]

feat: add override_frequency_capping arg for send_email

[0.1.1]

feat: advertise constraints in setup.py

[0.1.0] - 2021-10-20

Added

• First release on PyPI.