Package: federated-content-connector
federated-content-connectorNoteThis 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.PurposeOne-line description for README and other doc files.TODO: TheREADME.rstfile should start with a brief description of the repository and its purpose.
It should be described in the context of other repositories under theopenedxorganization. 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 StartedDevelopingOne Time Setup# 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-connectorEvery time you develop something in this repo# 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.DeployingTODO: 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 thedeployment how-toGetting HelpDocumentationPLACEHOLDER: Start by going throughthe documentation.  If you need more help see below.(TODO:Set up documentation)More HelpIf you’re having trouble, we have discussion forums athttps://discuss.openedx.orgwhere you can connect with others in the
community.Our real-time conversations are on Slack. You can request aSlack
invitation, then join ourcommunity 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/issuesFor more information about these options, see theGetting Helppage.LicenseThe code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.Please seeLICENSE.txtfor details.ContributingContributions are very welcome.
Please readHow To Contributefor 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 ConductAll community members are expected to follow theOpen edX Code of Conduct.PeopleThe assigned maintainers for this component and other project details may be
found inBackstage. Backstage pulls this data from thecatalog-info.yamlfile in this repo.Reporting Security IssuesPlease do not report security issues in public. Please emailsecurity@tcril.org.Change LogUnreleased1.4.4 – 2024-02-14No longer rely onadditional_metadatafield 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-27Improvements inimport_course_runs_metadataandrefresh_course_runs_metadata1.4.2 – 2023-09-26Refresh client token for requests1.4.1 – 2023-09-13Remove inner function fromget_response_from_api1.4.0 – 2023-09-12Refactor to fetch course data using course uuid1.3.2 – 2023-09-04addinclude_hidden_course_runsquery param to fetch hidden courserunsadd retry decorator to handle exceptions during calls to/coursesapi1.3.1 – 2023-08-28fix: resumeUrl for exec-ed courses in B2C dashboard1.3.0 – 2023-08-18feat: hook to modify courserun data for B2C dashboard1.2.1 – 2023-08-03feat: hook for modify course enrollment data1.2.0 – 2023-07-18Refactorimport_course_runs_metadatacommand to import all courseruns1.1.0 – 2023-06-21Management command to refresh CourseDetails data1.0.3 – 2023-06-15backfill all data1.0.2 – 2023-06-15Handle empty courserun seats.Add limit query param in api call1.0.1 – 2023-06-14Update courserun seat sorting logic.1.0.0 – 2023-06-06Fetch course metadata from discovery and store.0.2.1 – 2023-06-5Fixed issue with product source data type0.2.0 – 2023-05-31Added support for stage and prod landing pages via settings0.1.1 – 2023-05-26Fixes for PyPI description markup.0.1.0 – 2023-05-26Basic skeleton of the app.CreateCustomUrlForCourseStep pipeline.First release on PyPI.