Package: getsmarter-api-clients
Clients to interact with GetSmarter APIs.TheREADME.rstfile should start with a brief description of the repository,
which sets it in the context of other repositories under theedxorganization. It should make clear where this fits in to the overall edX
codebase.Overview (please modify)TheREADME.rstfile should then provide an overview of the code in this
repository, including the main components and useful entry points for starting
to understand the code in more detail.Documentation(TODO:Set up documentation)Development WorkflowOne 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-clientsEvery 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.LicenseThe code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.Please seeLICENSE.txtfor details.How To ContributeContributions are very welcome.
Please readHow To Contributefor details.
Even though they were written withedx-platformin 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 atPULL_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 atISSUE_TEMPLATE.md.Reporting Security IssuesPlease do not report security issues in public. Please emailsecurity@edx.org.Getting HelpIf you’re having trouble, we have discussion forums athttps://discuss.openedx.orgwhere you can connect with others in the community.Our real-time conversations are on Slack. You can request aSlack invitation, then join ourcommunity Slack workspace.For more information about these options, see theGetting Helppage.Change LogUnreleasedNothing unreleased[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]Addorg_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 arequests.HTTPError, not anurllib.error.HTTPError.[0.5.0] - 2023-04-12Added new field for data_share_consent in enterprise_allocations[0.4.0] - 2022-09-12Add enterprise_allocations endpoint functionality to client[0.1.0] - 2022-08-01AddedFirst release on PyPI.