Skip to main content

An integrated channel is an abstraction meant to represent a third-party system which provides an API that can be used to transmit EdX data to the third-party system.

Project description

enterprise-integrated-channels

PyPI CI Codecov Documentation Supported Python versions License status-badge

Purpose

An integrated channel is an abstraction meant to represent a third-party system which provides an API that can be used to transmit EdX data to the third-party system. The most common example of such a third-party system is an enterprise-level learning management system (LMS). LMS users are able to discover content made available by many different content providers and manage the learning outcomes that are produced by interaction with the content providers. In such a scenario, EdX would be the content provider while a system like SAP SuccessFactors would be the integrated channel.

Getting Started with Development

Please see the Open edX documentation for guidance on Python development in this repo.

Getting Help

Documentation

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

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/enterprise-integrated-channels/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 discuss your new feature idea with the maintainers before 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.

Change Log

Unreleased

0.1.20 – 2025-10-19

Added

  • Upgrade Python Requirements

0.1.19 – 2025-10-09

Added

  • Upgrade Python Requirements

0.1.18 – 2025-10-03

Added

  • Upgrade Python Requirements

0.1.17 – 2025-09-26

Added

  • Upgrade Python Requirements

0.1.16 – 2025-09-15

Added

  • Enhances the migration command with customer-specific functionality to support targeted data migration during the integrated channels transition.

0.1.15 – 2025-09-01

Added

  • Add explicit index naming for SAP SuccessFactors audit table and corresponding database migration.

0.1.14 – 2025-08-13

Added

  • Upgrade Python Requirements

0.1.13 – 2025-07-23

Added

  • Add __init__.py to api/v1/ directory to ensure it is recognized as a package.

0.1.12 – 2025-07-22

Added

  • Upgrade Python Requirements

0.1.11 – 2025-07-15

Added

  • Update CHANGELOG and README

0.1.10 – 2025-07-15

Added

  • Fix admin redirects for various channel integrations to use the correct app namespace.

  • Upgrade Python Requirements

0.1.9 – 2025-07-04

Added

  • Upgrade Python Requirements

0.1.8 – 2025-06-26

Added

  • fix test_migrations_are_in_sync test on edx-platform

0.1.7 – 2025-06-25

Added

  • add migrations for various channel integrations

0.1.6 – 2025-06-25

Added

  • Upgrade Python Requirements

0.1.5 – 2025-06-16

Added

  • Rename xAPI management commands to avoid conflicts with existing commands in edx-enterprise.

0.1.4 – 2025-06-11

Added

  • Added django52 support.

0.1.3 – 2025-06-10

Added

  • Add DB migrations against index_together changes.

0.1.2 – 2025-05-30

Added

  • Added management command to copy data from legacy tables to new tables.

  • Added (Experimental) tag to app name in the admin interface.

0.1.1 – 2025-05-20

Added

  • Renamed jobs to avoid conflicts with existing jobs in edx-enterprise.

0.1.0 – 2025-01-16

Added

  • First release on PyPI.

  • Created mock_apps for testing purposes.

  • Updated requirements in base.in and run make requirements.

  • Migrated integrated_channel app from edx-enterprise.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

enterprise_integrated_channels-0.1.21.tar.gz (215.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

enterprise_integrated_channels-0.1.21-py2.py3-none-any.whl (295.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file enterprise_integrated_channels-0.1.21.tar.gz.

File metadata

File hashes

Hashes for enterprise_integrated_channels-0.1.21.tar.gz
Algorithm Hash digest
SHA256 f9bf530e360ac65e98f66eac95119a29ce0c645db6ec4e13bfd2718f8979036d
MD5 e2f1303b95c96866d293f90910ecab28
BLAKE2b-256 2a84d9d0e990a202a1a2d7b800928cb892c2dc68fd7f9ba9938ea75ee2584cdd

See more details on using hashes here.

File details

Details for the file enterprise_integrated_channels-0.1.21-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for enterprise_integrated_channels-0.1.21-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 50309044cb7781436cee90cb4a8622f2b02e855085c47b1aa03bbb7cee0f7f5d
MD5 803960f5bfc241be0f60bcc7cb36f82b
BLAKE2b-256 ed345b2810457e24e9e1ff5a4d755b5093f5fee9efc2491e48e67567bea47c93

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page