enterprise-integrated-channels
##############################
|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge| |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.
.. _guidance on Python development: https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html
Getting Help
************
Documentation
=============
Start by going through `the documentation`_. If you need more help see below.
.. _the documentation: https://github.com/openedx/enterprise-integrated-channels/blob/main/channel_integrations/README.md
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 <https://openedx.org/getting-help>`__ page.
.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/
License
*******
The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.
Please see `LICENSE.txt <LICENSE.txt>`_ for details.
Contributing
************
Contributions are very welcome.
Please read `How To Contribute <https://openedx.org/r/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`_.
.. _Open edX Code of Conduct: https://openedx.org/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.
.. _Backstage: https://backstage.openedx.org/catalog/default/component/enterprise-integrated-channels
Reporting Security Issues
*************************
Please do not report security issues in public. Please email security@openedx.org.
.. |pypi-badge| image:: https://img.shields.io/pypi/v/enterprise-integrated-channels.svg
:target: https://pypi.python.org/pypi/enterprise-integrated-channels/
:alt: PyPI
.. |ci-badge| image:: https://github.com/openedx/enterprise-integrated-channels/workflows/Python%20CI/badge.svg?branch=main
:target: https://github.com/openedx/enterprise-integrated-channels/actions
:alt: CI
.. |codecov-badge| image:: https://codecov.io/github/openedx/enterprise-integrated-channels/coverage.svg?branch=main
:target: https://codecov.io/github/openedx/enterprise-integrated-channels?branch=main
:alt: Codecov
.. |doc-badge| image:: https://readthedocs.org/projects/enterprise-integrated-channels/badge/?version=latest
:target: https://docs.openedx.org/projects/enterprise-integrated-channels
:alt: Documentation
.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/enterprise-integrated-channels.svg
:target: https://pypi.python.org/pypi/enterprise-integrated-channels/
:alt: Supported Python versions
.. |license-badge| image:: https://img.shields.io/github/license/openedx/enterprise-integrated-channels.svg
:target: https://github.com/openedx/enterprise-integrated-channels/blob/main/LICENSE.txt
:alt: License
.. TODO: Choose one of the statuses below and remove the other status-badge lines.
.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red
Change Log
##########
..
All enhancements and patches to channel_integrations will be documented
in this file. It adheres to the structure of https://keepachangelog.com/ ,
but in reStructuredText instead of Markdown (for ease of incorporation into
Sphinx documentation and the PyPI description).
This project adheres to Semantic Versioning (https://semver.org/).
.. There should always be an "Unreleased" section for changes pending release.
Unreleased
**********
*
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/enterprise-integrated-channels",
"name": "enterprise-integrated-channels",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "Python edx",
"author": "Open edX Project",
"author_email": "oscm@openedx.org",
"download_url": "https://files.pythonhosted.org/packages/ac/fd/8e5333d6be73c9b2ed807079608e0712cd1c1647df75d18d5183e9e3a191/enterprise_integrated_channels-0.1.11.tar.gz",
"platform": null,
"description": "enterprise-integrated-channels\n##############################\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge| |status-badge|\n\nPurpose\n*******\n\nAn 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.\n\n\nGetting Started with Development\n********************************\n\nPlease see the Open edX documentation for `guidance on Python development`_ in this repo.\n\n.. _guidance on Python development: https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html\n\n\nGetting Help\n************\n\nDocumentation\n=============\n\nStart by going through `the documentation`_. If you need more help see below.\n\n.. _the documentation: https://github.com/openedx/enterprise-integrated-channels/blob/main/channel_integrations/README.md\n\n\nMore Help\n=========\n\nIf you're having trouble, we have discussion forums at\nhttps://discuss.openedx.org where you can connect with others in the\ncommunity.\n\nOur real-time conversations are on Slack. You can request a `Slack\ninvitation`_, then join our `community Slack workspace`_.\n\nFor anything non-trivial, the best path is to open an issue in this\nrepository with as many details about the issue you are facing as you\ncan provide.\n\nhttps://github.com/openedx/enterprise-integrated-channels/issues\n\nFor more information about these options, see the `Getting Help <https://openedx.org/getting-help>`__ page.\n\n.. _Slack invitation: https://openedx.org/slack\n.. _community Slack workspace: https://openedx.slack.com/\n\nLicense\n*******\n\nThe code in this repository is licensed under the AGPL 3.0 unless\notherwise noted.\n\nPlease see `LICENSE.txt <LICENSE.txt>`_ for details.\n\nContributing\n************\n\nContributions are very welcome.\nPlease read `How To Contribute <https://openedx.org/r/how-to-contribute>`_ for details.\n\nThis project is currently accepting all types of contributions, bug fixes,\nsecurity fixes, maintenance work, or new features. However, please make sure\nto discuss your new feature idea with the maintainers before beginning development\nto maximize the chances of your change being accepted.\nYou can start a conversation by creating a new issue on this repo summarizing\nyour idea.\n\nThe Open edX Code of Conduct\n****************************\n\nAll community members are expected to follow the `Open edX Code of Conduct`_.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\nPeople\n******\n\nThe assigned maintainers for this component and other project details may be\nfound in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``\nfile in this repo.\n\n.. _Backstage: https://backstage.openedx.org/catalog/default/component/enterprise-integrated-channels\n\nReporting Security Issues\n*************************\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/enterprise-integrated-channels.svg\n :target: https://pypi.python.org/pypi/enterprise-integrated-channels/\n :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/openedx/enterprise-integrated-channels/workflows/Python%20CI/badge.svg?branch=main\n :target: https://github.com/openedx/enterprise-integrated-channels/actions\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/openedx/enterprise-integrated-channels/coverage.svg?branch=main\n :target: https://codecov.io/github/openedx/enterprise-integrated-channels?branch=main\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/enterprise-integrated-channels/badge/?version=latest\n :target: https://docs.openedx.org/projects/enterprise-integrated-channels\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/enterprise-integrated-channels.svg\n :target: https://pypi.python.org/pypi/enterprise-integrated-channels/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/openedx/enterprise-integrated-channels.svg\n :target: https://github.com/openedx/enterprise-integrated-channels/blob/main/LICENSE.txt\n :alt: License\n\n.. TODO: Choose one of the statuses below and remove the other status-badge lines.\n.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red\n\n\nChange Log\n##########\n\n..\n All enhancements and patches to channel_integrations will be documented\n in this file. It adheres to the structure of https://keepachangelog.com/ ,\n but in reStructuredText instead of Markdown (for ease of incorporation into\n Sphinx documentation and the PyPI description).\n\n This project adheres to Semantic Versioning (https://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n**********\n\n*\n\n0.1.11 \u2013 2025-07-15\n*******************\n\nAdded\n=====\n\n* Update CHANGELOG and README\n\n\n0.1.10 \u2013 2025-07-15\n*******************\n\nAdded\n=====\n\n* Fix admin redirects for various channel integrations to use the correct app namespace.\n* Upgrade Python Requirements\n\n\n0.1.9 \u2013 2025-07-04\n******************\n\nAdded\n=====\n\n* Upgrade Python Requirements\n\n\n0.1.8 \u2013 2025-06-26\n******************\n\nAdded\n=====\n\n* fix ``test_migrations_are_in_sync`` test on edx-platform\n\n\n0.1.7 \u2013 2025-06-25\n******************\n\nAdded\n=====\n\n* add migrations for various channel integrations\n\n\n0.1.6 \u2013 2025-06-25\n******************\n\nAdded\n=====\n\n* Upgrade Python Requirements\n\n\n0.1.5 \u2013 2025-06-16\n******************\n\nAdded\n=====\n\n* Rename xAPI management commands to avoid conflicts with existing commands in edx-enterprise.\n\n\n0.1.4 \u2013 2025-06-11\n******************\n\nAdded\n=====\n\n* Added django52 support.\n\n\n0.1.3 \u2013 2025-06-10\n******************\n\nAdded\n=====\n\n* Add DB migrations against ``index_together`` changes.\n\n\n0.1.2 \u2013 2025-05-30\n******************\n\nAdded\n=====\n\n* Added management command to copy data from legacy tables to new tables.\n* Added ``(Experimental)`` tag to app name in the admin interface.\n\n0.1.1 \u2013 2025-05-20\n******************\n\nAdded\n=====\n\n* Renamed jobs to avoid conflicts with existing jobs in edx-enterprise.\n\n\n0.1.0 \u2013 2025-01-16\n******************\n\nAdded\n=====\n\n* First release on PyPI.\n* Created ``mock_apps`` for testing purposes.\n* Updated requirements in ``base.in`` and run ``make requirements``.\n* Migrated ``integrated_channel`` app from edx-enterprise.\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "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.",
"version": "0.1.11",
"project_urls": {
"Homepage": "https://github.com/openedx/enterprise-integrated-channels"
},
"split_keywords": [
"python",
"edx"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "cb3fef70369d811e9793a942ba1cac4721a0c06c6e2f071253ae15c0d7b2dfc7",
"md5": "4b3f362ad765383c941fdaf11d36e0ee",
"sha256": "d9bcf99b791070b6c6f8686060e049d1d818b5cbadbb350d5312cc2f468c23e6"
},
"downloads": -1,
"filename": "enterprise_integrated_channels-0.1.11-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "4b3f362ad765383c941fdaf11d36e0ee",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.11",
"size": 271043,
"upload_time": "2025-07-16T13:48:36",
"upload_time_iso_8601": "2025-07-16T13:48:36.414702Z",
"url": "https://files.pythonhosted.org/packages/cb/3f/ef70369d811e9793a942ba1cac4721a0c06c6e2f071253ae15c0d7b2dfc7/enterprise_integrated_channels-0.1.11-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "acfd8e5333d6be73c9b2ed807079608e0712cd1c1647df75d18d5183e9e3a191",
"md5": "7cb296d5fa7198e319855eb400ff246c",
"sha256": "0969264664b4ba66892e97139758c98d0acd760a402288ca894efb77e4165219"
},
"downloads": -1,
"filename": "enterprise_integrated_channels-0.1.11.tar.gz",
"has_sig": false,
"md5_digest": "7cb296d5fa7198e319855eb400ff246c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 202191,
"upload_time": "2025-07-16T13:48:37",
"upload_time_iso_8601": "2025-07-16T13:48:37.897483Z",
"url": "https://files.pythonhosted.org/packages/ac/fd/8e5333d6be73c9b2ed807079608e0712cd1c1647df75d18d5183e9e3a191/enterprise_integrated_channels-0.1.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-16 13:48:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openedx",
"github_project": "enterprise-integrated-channels",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "enterprise-integrated-channels"
}
JSON
