federated-content-connector
===========================
.. note::
This README was auto-generated. Maintainer: please review its contents and
update all relevant sections. Instructions to you are marked with
"PLACEHOLDER" or "TODO". Update or remove those sections, and remove this
note when you are done.
|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge| |status-badge|
Purpose
-------
edx-platform plugin to run extra, business-specific, processing steps on course metadata.
Getting Started
---------------
Developing
~~~~~~~~~~
.. code-block::
# Clone the repository into your $DEVSTACK_WORKSPACE/src
# so that your local code is mounted into your LMS docker container
git clone git@github.com:openedx/federated-content-connector.git
# get into your running LMS container shell (from your devstack directory)
make lms-shell
# install your local changes in editable mode
pip install -e /edx/src/federated-content-connector
# outside of your LMS shell, you may need to restart
# your LMS devserver to get local changes loading
make lms-restart-devserver
# To run unit tests for this repo,
# set up a virtualenv with the same name as the repo and activate it
cd /edx/src/federated-content-connector
virtaulenv venv/fcc
source venv/fcc/bin/activate
# run tests, quality, etc.
make test
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`_
.. _deployment how-to: https://docs.openedx.org/projects/federated-content-connector/how-tos/how-to-deploy-this-component.html
Getting Help
============
Documentation
=============
PLACEHOLDER: Start by going through `the documentation`_. If you need more help see below.
.. _the documentation: https://docs.openedx.org/projects/federated-content-connector
(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
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/federated-content-connector/issues
For more information about these options, see the `Getting Help`_ page.
.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/
.. _Getting Help: https://openedx.org/getting-help
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 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`_.
.. _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/federated-content-connector
Reporting Security Issues
=========================
Please do not report security issues in public. Please email security@tcril.org.
.. |pypi-badge| image:: https://img.shields.io/pypi/v/federated-content-connector.svg
:target: https://pypi.python.org/pypi/federated-content-connector/
:alt: PyPI
.. |ci-badge| image:: https://github.com/openedx/federated-content-connector/workflows/Python%20CI/badge.svg?branch=main
:target: https://github.com/openedx/federated-content-connector/actions
:alt: CI
.. |codecov-badge| image:: https://codecov.io/github/openedx/federated-content-connector/coverage.svg?branch=main
:target: https://codecov.io/github/openedx/federated-content-connector?branch=main
:alt: Codecov
.. |doc-badge| image:: https://readthedocs.org/projects/federated-content-connector/badge/?version=latest
:target: https://docs.openedx.org/projects/federated-content-connector
:alt: Documentation
.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/federated-content-connector.svg
:target: https://pypi.python.org/pypi/federated-content-connector/
:alt: Supported Python versions
.. |license-badge| image:: https://img.shields.io/github/license/openedx/federated-content-connector.svg
:target: https://github.com/openedx/federated-content-connector/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 federated_content_connector 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
----------
* Nothing unreleased
1.6.0
-----
* feat: request restricted runs when importing course run data
1.5.2
-----
* fix: gets custom course URL from DB if possible
1.5.1 – 2024-07-25
------------------
* Update release notes
1.5.0 – 2024-07-25
------------------
* Adds a `course_key` field to the `CourseDetails` model with a default value of an empty string
1.4.4 – 2024-02-14
------------------
* No longer rely on `additional_metadata` field to extract metadata such as start, end, and enroll by dates for external courses. Instead, pull directly from the course runs metadata instead.
1.4.3 – 2023-09-27
------------------
* Improvements in `import_course_runs_metadata` and `refresh_course_runs_metadata`
1.4.2 – 2023-09-26
------------------
* Refresh client token for requests
1.4.1 – 2023-09-13
------------------
* Remove inner function from `get_response_from_api`
1.4.0 – 2023-09-12
------------------
* Refactor to fetch course data using course uuid
1.3.2 – 2023-09-04
------------------
* add `include_hidden_course_runs` query param to fetch hidden courseruns
* add retry decorator to handle exceptions during calls to `/courses` api
1.3.1 – 2023-08-28
------------------
* fix: resumeUrl for exec-ed courses in B2C dashboard
1.3.0 – 2023-08-18
------------------
* feat: hook to modify courserun data for B2C dashboard
1.2.1 – 2023-08-03
------------------
* feat: hook for modify course enrollment data
1.2.0 – 2023-07-18
------------------
* Refactor `import_course_runs_metadata` command to import all courseruns
1.1.0 – 2023-06-21
------------------
* Management command to refresh CourseDetails data
1.0.3 – 2023-06-15
------------------
* backfill all data
1.0.2 – 2023-06-15
------------------
* Handle empty courserun seats.
* Add limit query param in api call
1.0.1 – 2023-06-14
------------------
* Update courserun seat sorting logic.
1.0.0 – 2023-06-06
------------------
* Fetch course metadata from discovery and store.
0.2.1 – 2023-06-5
------------------
* Fixed issue with product source data type
0.2.0 – 2023-05-31
------------------
* Added support for stage and prod landing pages via settings
0.1.1 – 2023-05-26
------------------
* Fixes for PyPI description markup.
0.1.0 – 2023-05-26
------------------
* Basic skeleton of the app.
* CreateCustomUrlForCourseStep pipeline.
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/federated-content-connector",
"name": "federated-content-connector",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Python edx",
"author": "edX",
"author_email": "oscm@edx.org",
"download_url": "https://files.pythonhosted.org/packages/f0/13/7d17b330af2629ea031e951d6fea2b29c40e53b8917cbadc4e2c755a812d/federated-content-connector-1.6.0.tar.gz",
"platform": null,
"description": "federated-content-connector\n===========================\n\n.. note::\n\n This README was auto-generated. Maintainer: please review its contents and\n update all relevant sections. Instructions to you are marked with\n \"PLACEHOLDER\" or \"TODO\". Update or remove those sections, and remove this\n note when you are done.\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge| |status-badge|\n\nPurpose\n-------\n\nedx-platform plugin to run extra, business-specific, processing steps on course metadata.\n\nGetting Started\n---------------\n\nDeveloping\n~~~~~~~~~~\n.. code-block::\n\n # Clone the repository into your $DEVSTACK_WORKSPACE/src\n # so that your local code is mounted into your LMS docker container\n git clone git@github.com:openedx/federated-content-connector.git\n\n # get into your running LMS container shell (from your devstack directory)\n make lms-shell\n\n # install your local changes in editable mode\n pip install -e /edx/src/federated-content-connector\n\n # outside of your LMS shell, you may need to restart\n # your LMS devserver to get local changes loading\n make lms-restart-devserver\n\n # To run unit tests for this repo,\n # set up a virtualenv with the same name as the repo and activate it\n cd /edx/src/federated-content-connector\n virtaulenv venv/fcc\n source venv/fcc/bin/activate\n\n # run tests, quality, etc.\n make test\n\nDeploying\n=========\n\nTODO: How can a new user go about deploying this component? Is it just a few\ncommands? Is there a larger how-to that should be linked here?\n\nPLACEHOLDER: For details on how to deploy this component, see the `deployment how-to`_\n\n.. _deployment how-to: https://docs.openedx.org/projects/federated-content-connector/how-tos/how-to-deploy-this-component.html\n\nGetting Help\n============\n\nDocumentation\n=============\n\nPLACEHOLDER: Start by going through `the documentation`_. If you need more help see below.\n\n.. _the documentation: https://docs.openedx.org/projects/federated-content-connector\n\n(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)\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/federated-content-connector/issues\n\nFor more information about these options, see the `Getting Help`_ page.\n\n.. _Slack invitation: https://openedx.org/slack\n.. _community Slack workspace: https://openedx.slack.com/\n.. _Getting Help: https://openedx.org/getting-help\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 have a discussion about your new feature idea with the maintainers prior to\nbeginning development to 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/federated-content-connector\n\nReporting Security Issues\n=========================\n\nPlease do not report security issues in public. Please email security@tcril.org.\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/federated-content-connector.svg\n :target: https://pypi.python.org/pypi/federated-content-connector/\n :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/openedx/federated-content-connector/workflows/Python%20CI/badge.svg?branch=main\n :target: https://github.com/openedx/federated-content-connector/actions\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/openedx/federated-content-connector/coverage.svg?branch=main\n :target: https://codecov.io/github/openedx/federated-content-connector?branch=main\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/federated-content-connector/badge/?version=latest\n :target: https://docs.openedx.org/projects/federated-content-connector\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/federated-content-connector.svg\n :target: https://pypi.python.org/pypi/federated-content-connector/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/openedx/federated-content-connector.svg\n :target: https://github.com/openedx/federated-content-connector/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 federated_content_connector 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* Nothing unreleased\n\n1.6.0\n-----\n* feat: request restricted runs when importing course run data\n\n1.5.2\n-----\n* fix: gets custom course URL from DB if possible\n\n1.5.1 \u2013 2024-07-25\n------------------\n* Update release notes\n\n1.5.0 \u2013 2024-07-25\n------------------\n* Adds a `course_key` field to the `CourseDetails` model with a default value of an empty string\n\n1.4.4 \u2013 2024-02-14\n------------------\n* No longer rely on `additional_metadata` field to extract metadata such as start, end, and enroll by dates for external courses. Instead, pull directly from the course runs metadata instead.\n\n1.4.3 \u2013 2023-09-27\n------------------\n* Improvements in `import_course_runs_metadata` and `refresh_course_runs_metadata`\n\n1.4.2 \u2013 2023-09-26\n------------------\n* Refresh client token for requests\n\n1.4.1 \u2013 2023-09-13\n------------------\n* Remove inner function from `get_response_from_api`\n\n1.4.0 \u2013 2023-09-12\n------------------\n* Refactor to fetch course data using course uuid\n\n1.3.2 \u2013 2023-09-04\n------------------\n* add `include_hidden_course_runs` query param to fetch hidden courseruns\n* add retry decorator to handle exceptions during calls to `/courses` api\n\n1.3.1 \u2013 2023-08-28\n------------------\n* fix: resumeUrl for exec-ed courses in B2C dashboard\n\n1.3.0 \u2013 2023-08-18\n------------------\n* feat: hook to modify courserun data for B2C dashboard\n\n1.2.1 \u2013 2023-08-03\n------------------\n* feat: hook for modify course enrollment data\n\n1.2.0 \u2013 2023-07-18\n------------------\n* Refactor `import_course_runs_metadata` command to import all courseruns\n\n1.1.0 \u2013 2023-06-21\n------------------\n* Management command to refresh CourseDetails data\n\n1.0.3 \u2013 2023-06-15\n------------------\n* backfill all data\n\n1.0.2 \u2013 2023-06-15\n------------------\n* Handle empty courserun seats.\n* Add limit query param in api call\n\n1.0.1 \u2013 2023-06-14\n------------------\n* Update courserun seat sorting logic.\n\n1.0.0 \u2013 2023-06-06\n------------------\n* Fetch course metadata from discovery and store.\n\n0.2.1 \u2013 2023-06-5\n------------------\n* Fixed issue with product source data type\n\n0.2.0 \u2013 2023-05-31\n------------------\n* Added support for stage and prod landing pages via settings\n\n0.1.1 \u2013 2023-05-26\n------------------\n* Fixes for PyPI description markup.\n\n0.1.0 \u2013 2023-05-26\n------------------\n* Basic skeleton of the app.\n* CreateCustomUrlForCourseStep pipeline.\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "One-line description for README and other doc files.",
"version": "1.6.0",
"project_urls": {
"Homepage": "https://github.com/openedx/federated-content-connector"
},
"split_keywords": [
"python",
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95f6eba248eeb246dfc3a524c4e31bb4af1ccec4fdb241bdb5f1a6f663662cb3",
"md5": "42f500eb2297960e5e5d3092802124f0",
"sha256": "7f836120a918672d827394877af99be2b5fceb089be31b9e11b493d733dce205"
},
"downloads": -1,
"filename": "federated_content_connector-1.6.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "42f500eb2297960e5e5d3092802124f0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 32379,
"upload_time": "2024-12-11T21:02:24",
"upload_time_iso_8601": "2024-12-11T21:02:24.376366Z",
"url": "https://files.pythonhosted.org/packages/95/f6/eba248eeb246dfc3a524c4e31bb4af1ccec4fdb241bdb5f1a6f663662cb3/federated_content_connector-1.6.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f0137d17b330af2629ea031e951d6fea2b29c40e53b8917cbadc4e2c755a812d",
"md5": "03bb520f95d9d2e333b3d7505275119d",
"sha256": "3543bd4552735a37136bff68793caa293cb0471af0a72914d7cceeb97fc5c969"
},
"downloads": -1,
"filename": "federated-content-connector-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "03bb520f95d9d2e333b3d7505275119d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 33104,
"upload_time": "2024-12-11T21:02:29",
"upload_time_iso_8601": "2024-12-11T21:02:29.214526Z",
"url": "https://files.pythonhosted.org/packages/f0/13/7d17b330af2629ea031e951d6fea2b29c40e53b8917cbadc4e2c755a812d/federated-content-connector-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 21:02:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openedx",
"github_project": "federated-content-connector",
"github_not_found": true,
"lcname": "federated-content-connector"
}
JSON
