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.

(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/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.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.1.tar.gz (192.0 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.1-py2.py3-none-any.whl (252.2 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for enterprise_integrated_channels-0.1.1.tar.gz
Algorithm Hash digest
SHA256 78e2de6de082fcdf5344ca1b5175e10d99d7f543016ecd9172ca9bce07ca29ff
MD5 a85346ddd5ccc5dfa68dd16467f2d247
BLAKE2b-256 f84d0c04614bacb8036ca2204f28ef36847b65c91f28a8dda8c3d3b0e3c867e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for enterprise_integrated_channels-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4b8adda3ad01fbcfdc0b1313ce9347d7fa0f571a523e6b3f1a9421a26b67bba7
MD5 5d5c27bf3fcbc251fc176093bd40cf94
BLAKE2b-256 611d6330e183bdf81c500883091e87322378addb84bcb394563cee48c4017b0f

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