Metadata-Version: 2.1
Name: federated-content-connector
Version: 1.5.2
Summary: One-line description for README and other doc files.
Home-page: https://github.com/openedx/federated-content-connector
Author: edX
Author-email: oscm@edx.org
License: AGPL 3.0
Keywords: Python edx
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE.txt

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
----------

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.
