getsmarter-api-clients 0.6.3

One Time Setup

# Clone the repository
git clone git@github.com:edx/getsmarter-api-clients.git
cd getsmarter-api-clients

# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.8 getsmarter-api-clients

Every time you develop something in this repo

# Activate the virtualenv
workon getsmarter-api-clients

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

Unreleased

• Nothing unreleased

[0.6.3]

• Logs the allocation payload sent to GEAG within the create_enterprise_allocation method.

• Ensures the logging of the allocation payload in both create_allocation and create_enterprise_allocation methods only includes specified non-PII fields.

[0.6.2]

• Logs the allocation payload sent to GEAG within the create_allocation method.

• Upgrades requirements.

[0.6.1]

• Adds an enterprise allocation cancellation method

[0.6.0]

• Adds optional arg to create_enterprise_allocation() to either raise (current/default behavior), or not raise and fall through to returning the response. This will allow callers to do things with the response payload in error conditions.

[0.5.4]

• Add org_id` as an optional enterprise allocation param

[0.5.3]

• Return allocation response objects

[0.5.2]

• Include payload in error message

[0.5.1]

• Catch a requests.HTTPError, not an urllib.error.HTTPError.

[0.5.0] - 2023-04-12

• Added new field for data_share_consent in enterprise_allocations

[0.4.0] - 2022-09-12

• Add enterprise_allocations endpoint functionality to client

[0.1.0] - 2022-08-01

Added

• First release on PyPI.