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
-------
One-line description for README and other doc files.
TODO: The ``README.rst`` file should start with a brief description of the repository and its purpose.
It should be described in the context of other repositories under the ``openedx``
organization. It should make clear where this fits in to the overall Open edX
codebase and should be oriented towards people who are new to the Open edX
project.
Getting Started
---------------
Developing
~~~~~~~~~~
One Time Setup
--------------
.. code-block::
# Clone the repository
git clone git@github.com:openedx/federated-content-connector.git
cd federated-content-connector
# Set up a virtualenv with the same name as the repo and activate it
# Here's how you might do that if you have virtualenvwrapper setup.
mkvirtualenv -p python3.8 federated-content-connector
Every time you develop something in this repo
---------------------------------------------
.. code-block::
# Activate the virtualenv
# Here's how you might do that if you're using virtualenvwrapper.
workon federated-content-connector
# Grab the latest code
git checkout main
git pull
# Install/update the dev requirements
make requirements
# Run the tests and quality checks (to verify the status before you make any changes)
make validate
# Make a new branch for your changes
git checkout -b <your_github_username>/<short_description>
# Using your favorite editor, edit the code to make your change.
vim ...
# Run your new tests
pytest ./path/to/new/tests
# Run all the tests and quality checks
make validate
# Commit all your changes
git commit ...
git push
# Open a PR and ask for review.
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.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": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Python edx",
"author": "edX",
"author_email": "oscm@edx.org",
"download_url": "https://files.pythonhosted.org/packages/cd/84/4936a02061393d5064e1e086ec7a80b5a7d5e08bb56d6656e1d109ae5905/federated-content-connector-1.4.3.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\nOne-line description for README and other doc files.\n\nTODO: The ``README.rst`` file should start with a brief description of the repository and its purpose.\nIt should be described in the context of other repositories under the ``openedx``\norganization. It should make clear where this fits in to the overall Open edX\ncodebase and should be oriented towards people who are new to the Open edX\nproject.\n\nGetting Started\n---------------\n\nDeveloping\n~~~~~~~~~~\n\nOne Time Setup\n--------------\n.. code-block::\n\n # Clone the repository\n git clone git@github.com:openedx/federated-content-connector.git\n cd federated-content-connector\n\n # Set up a virtualenv with the same name as the repo and activate it\n # Here's how you might do that if you have virtualenvwrapper setup.\n mkvirtualenv -p python3.8 federated-content-connector\n\n\nEvery time you develop something in this repo\n---------------------------------------------\n.. code-block::\n\n # Activate the virtualenv\n # Here's how you might do that if you're using virtualenvwrapper.\n workon federated-content-connector\n\n # Grab the latest code\n git checkout main\n git pull\n\n # Install/update the dev requirements\n make requirements\n\n # Run the tests and quality checks (to verify the status before you make any changes)\n make validate\n\n # Make a new branch for your changes\n git checkout -b <your_github_username>/<short_description>\n\n # Using your favorite editor, edit the code to make your change.\n vim ...\n\n # Run your new tests\n pytest ./path/to/new/tests\n\n # Run all the tests and quality checks\n make validate\n\n # Commit all your changes\n git commit ...\n git push\n\n # Open a PR and ask for review.\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\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.4.3",
"project_urls": {
"Homepage": "https://github.com/openedx/federated-content-connector"
},
"split_keywords": [
"python",
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "35acd908ca539636dab26a0baaefca3f94b3bef697348e346b58f10b0c6b8bd0",
"md5": "f3d5e7201af276ab9dabbd4b3474b705",
"sha256": "a878ec52ff209083257898af9ae8573f339f7c542ab42c57b75b971a71789f07"
},
"downloads": -1,
"filename": "federated_content_connector-1.4.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f3d5e7201af276ab9dabbd4b3474b705",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 31393,
"upload_time": "2023-09-27T09:41:29",
"upload_time_iso_8601": "2023-09-27T09:41:29.505218Z",
"url": "https://files.pythonhosted.org/packages/35/ac/d908ca539636dab26a0baaefca3f94b3bef697348e346b58f10b0c6b8bd0/federated_content_connector-1.4.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cd844936a02061393d5064e1e086ec7a80b5a7d5e08bb56d6656e1d109ae5905",
"md5": "fb3bce89cbeb2da1cc443b86f8808430",
"sha256": "9a5600dd214902ec7efe8ab78de6e16c782b700118c986e488ca6472795366ec"
},
"downloads": -1,
"filename": "federated-content-connector-1.4.3.tar.gz",
"has_sig": false,
"md5_digest": "fb3bce89cbeb2da1cc443b86f8808430",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 32320,
"upload_time": "2023-09-27T09:41:30",
"upload_time_iso_8601": "2023-09-27T09:41:30.641955Z",
"url": "https://files.pythonhosted.org/packages/cd/84/4936a02061393d5064e1e086ec7a80b5a7d5e08bb56d6656e1d109ae5905/federated-content-connector-1.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-27 09:41:30",
"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
