Using Open response assessments as a package in a django codebase

Sam_Joel · April 16, 2022, 8:54am

Hi, we are building an application which requires peer review feature and Open edX seems to have a good peer review feature. Is there any possibility to use edx’s open response assessment as a pip package into our codebase and use its API.

PS: We just want the apis/ backend functionality of edx-ora. We plan to build a frontend for it by ourselves.

Any guidance or support is appreciated. Thanks.

dave · April 18, 2022, 3:56am

That’s a really interesting idea. I haven’t worked on that code base in a really long time. There are a handful of dependencies injected in the runtime_imports package that you might have to patch or make configurable. That being said, there aren’t that many dependencies, and most revolve around content definition or grabbing content info for aggregate reporting. Both edx-ora2 and the edx-submissions repos try to put their public interfaces in api packages or modules like:

I believe you’d be the first ones to try this, so I’m sure you’d run into some interesting code assumptions, but I think it is doable. It’d be great if someone who’s worked on it more recently could chime in though–maybe @jansenk?

Sam_Joel · April 18, 2022, 9:28am

Thank you. But as we were going through the source code there were some api functions that we could use although we were not sure what is the data format that we should pass to the api. It would be really helpful if there was a documentation which specifies what data format (the keys and nested dicts) that should be provided to the apis so that they do their job as intended. Any suggestion or guidance would help.Thanks.

dave · April 18, 2022, 3:08pm

The only documentation I’m aware of for that information are the docstrings, at least some of which expand on the keys, like:

github.com

openedx/edx-ora2/blob/3ca43c322a4b05fa74e583232acc003a4bfbe3b1/openassessment/workflow/api.py#L181-L269

      
        
            def update_from_assessments(submission_uuid, assessment_requirements, override_submitter_requirements=False):
                """
                Update our workflow status based on the status of the underlying assessments.
            
            
    We pass in the `assessment_requirements` each time we make the request
                because the canonical requirements are stored in the `OpenAssessmentBlock`
                problem definition and may change over time. Because this method also
                returns a copy of the `WorkflowAssessment` information as a convenience,
                it's functionally equivalent to calling `get_workflow_for_submission()`.
                This is a little wonky from a REST, get-doesn't-change-state point of view,
                except that what's stored in the `AssessmentWorkflow` isn't the canonical
                true value -- it's just the most recently known state of it based on the
                last known requirments. For now, we have to query for truth.
            
            
    Args:
                    submission_uuid (str): Identifier for the submission the
                        `AssessmentWorkflow` was created to track. There is a 1:1
                        relationship between submissions and workflows, so this uniquely
                        identifies the `AssessmentWorkflow`.
                    assessment_requirements (dict): Dictionary that currently looks like:

This file has been truncated. show original

If you point out a few places where this is missing, I might be able to help (again, it’s been a long time for me). You might also be able to figure it out based on the caller (which will usually be the XBlock code in this same repo). But I don’t think there’s any additional documentation for this anywhere.

Sam_Joel · April 23, 2022, 8:24am

Yeah we were able to figure it out through the Xblock code. Thank you for pointing this out.

Topic		Replies	Views
Open edX REST API python package Development api	13	881	August 21, 2024
Adding a django application to Open edX Development	9	833	September 1, 2023
Help on creating an extension in Open edX for a beginner Development	2	244	June 7, 2023
Integrate a custom assessment module into Open edX Development how-to	1	437	November 13, 2020
Edx-platform REST API Documentation Development	10	765	July 25, 2023

Using Open response assessments as a package in a django codebase

Related topics