GitLocker: The Coding Marketplace

Description:

federatedcontentconnector 1.5.1

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.

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

Getting Help

Documentation
PLACEHOLDER: Start by going through the documentation. If you need more help see below.
(TODO: Set up documentation)

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.

License
The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.
Please see LICENSE.txt for details.

Contributing
Contributions are very welcome.
Please read 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.

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.

Reporting Security Issues
Please do not report security issues in public. Please email security@tcril.org.

Change Log

Unreleased

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.