openedx/openedx-platform

cleanup direct model imports from certificates djangoapp

Open

#36,647 opened on May 1, 2025

View on GitHub
 (4 comments) (0 reactions) (1 assignee)Python (4,331 forks)auto 404
good first issuehelp wanted

Repository metrics

Stars
 (8,150 stars)
PR merge metrics
 (PR metrics pending)

Description

There are a small number of direct imports from the certificates djangoapp's models.py. Wherever possible, we want to use the app's API) or data classes for use outside of the certificates app itself.

As of this writing, this appears to be all imports of the app that are not from api.py, data.py, test factories, the signals, or an exception definition:

the majority of them appear to be in legacy front-ends, unsurprisingly.

Acceptance Criteria

  • create any necessary data classes to get rid of direct imports of lms.djangoapps.certificates.models from outside the django app
  • change the code to reference the appropriate data class or API method
  • if it is difficult, costly, or impossible to make the change, consider adding a comment explaining why
  • verify that all the affected apps still work properly, and that all the tests pass

Contributor guide

Research direction
Identify each direct import from `lms.djangoapps.certificates.models` outside the certificates app. For each, create a data class in `data.py` if one doesn't exist, or use an existing API method. Replace the import and update the code. Run tests for affected apps and the certificates app to ensure nothing breaks. If impossible, add a comment explaining why.
Tech stack
pythondjango
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonDjangoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45