edx-enterprise-subsidy-client 0.3.3

Client for interacting with the enterprise-subsidy service.

edx-enterprise-subsidy-client

Purpose

Client for interacting with the enterprise-subsidy service.

Getting Started

Developing

One Time Setup

# Clone the repository into your ``[DEVSTACK]/src/`` folder
git clone [e-mail]:openedx/edx-enterprise-subsidy-client.git
# Use a service container that would reasonably install this client, e.g.
cd [DEVSTACK]/enterprise-subsidy && make app-shell
cd /edx/src/edx-enterprise-subsidy-client

# Set up a virtualenv in a ``venv/`` directory
# You might need to install virtualenv first:
# apt-get update
# apt-get install -y virtualenv
virtualenv venv/
make requirements

# Ensure things are looking ok by running tests
make test

Every time you develop something in this repo

# Grab the latest code
git checkout main
git pull

# Use a service container that would reasonably install this client, e.g.
cd [DEVSTACK]/enterprise-subsidy && make app-shell
cd /edx/src/edx-enterprise-subsidy-client

# Activate the virtualenv
source venv/bin/activate

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

Deploying

TODO: How can a new user go about deploying this component? Is it just a few commands? Is there a larger how-to that should be linked here?

PLACEHOLDER: For details on how to deploy this component, see the deployment how-to

Getting Help

Documentation

PLACEHOLDER: Start by going through the documentation. If you need more help see below.

(TODO: Set up documentation)

More 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 anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.

https://github.com/openedx/edx-enterprise-subsidy-client/issues

For more information about these options, see the Getting Help page.

License

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

Please see LICENSE.txt for details.

Contributing

Contributions are very welcome. Please read How To Contribute for details.

This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.

The Open edX Code of Conduct

All community members are expected to follow the Open edX Code of Conduct.

People

The assigned maintainers for this component and other project details may be found in Backstage. Backstage pulls this data from the catalog-info.yaml file in this repo.

Reporting Security Issues

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

Change Log

Unreleased

• Switch from edx-sphinx-theme to sphinx-book-theme since the former is deprecated

[0.3.3]

• admin-list transactions will also be filtered by created state by default.

• Adds an ADR explaining the default states for which this client filters transactions.

[0.3.2]

• admin-list transactions will ask to be filtered for only committed and pending states by default. Caller may specify other valid states (e.g. failed or created).

[0.3.1]

• fix: correctly pass subsidy_uuid to subsidy API V2 endpoint string format.

[0.3.0]

• feat: add new client for v2 transaction endpoint.

[0.2.6]

• feat: transaction endpoint accepts lms_user_id instead of learner_id

[0.2.5]

• feat: redemption metadata.

[0.2.4]

• fix: don’t directly access a status code on a failed response for logging.

[0.2.3]

• DON’T be flexible about settings variable names for client initialization.

[0.2.2]

• str() incoming UUID arguments

[0.2.1]

• Be flexible about settings variable names for client initialization.

[0.2.0]

• Add implementation for many of the client methods; currently defering on unit tests.

• Add a scripts/e2e.py script for end-to-end testing between enterprise-subsidy and edx-enterprise.

[0.1.0] - 2023-02-01

Added

• First release on PyPI.