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 git@github.com: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
# Install uv: https://docs.astral.sh/uv/getting-started/installation/
# This creates and manages its own virtualenv, no need to set one up yourself.
make requirements
source .venv/bin/activate
# 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
# Install/update the dev requirements into this repo's own uv-managed .venv
make requirements
source .venv/bin/activate
# 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 security@openedx.org.
Metadata
Release files for edx-enterprise-subsidy-client 2.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| edx_enterprise_subsidy_client-2.3.0.tar.gz | 129.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| edx_enterprise_subsidy_client-2.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 161.4 kB
Release files / edx_enterprise_subsidy_client-2.3.0.tar.gz
| Download URL | edx_enterprise_subsidy_client-2.3.0.tar.gz |
|---|---|
| Size | 129.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b5c2b79c56a183b17d065698dfc9afd109611be19b0589d09824ef6e9b2eb7d6
|
|
BLAKE2b-256 checksum How to use checksums |
9b0ccb171687d58a80349b1d6e06d070563be884b7bd1b566d7b939d3147b0b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 1, 2026.
Transparency logRelease files / edx_enterprise_subsidy_client-2.3.0-py3-none-any.whl
| Download URL | edx_enterprise_subsidy_client-2.3.0-py3-none-any.whl |
|---|---|
| Size | 31.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
458865ba6438db385575b286b3a85480a4ab1beb38f78c118d9f02771c03a0d9
|
|
BLAKE2b-256 checksum How to use checksums |
30498864247117dce719f2b4bdbba09b1026e7cf2777b29cdb7c22c7493e28be
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 1, 2026.
Transparency log