:gear: Ralph, the ultimate Learning Record Store (and more!) for your learning analytics
ralph.backends.data
and ralph.backends.lrs
entry points
to discover backends from plugins.get_backends
method now requires a list
of EntryPoints
, each pointing to a backend class, instead of a tuple of
packages containing backends.RUNSERVER_BACKEND
configuration value is no longer validated to
point to an existing backend.activity
when LRS contains statements with an object
lacking a objectType
attributequery_statements
and query_statements_by_ids
methods can now take an
optional user-specific targetevent_table_name
attribute of the ClickHouse data backendWritable
and Listable
interfaces to distinguish supported
functionalities among data
backendsmax_statements
option to data backends read
methodprefetch
option to async data backends read
methodconcurrency
option to async data backends write
methodget_backends
function to automatically discover backends
for CLI and LRS usageREAD_CHUNK_SIZE
and WRITE_CHUNK_SIZE
data backend settingsEdX
to xAPI
converters for enrollment eventsralph-malph
extra dependencies: backends
and
full
GET /statements
now has "mine" option which matches statements that
have an authority field matching that of the userid
, timestamp
, stored
and authority
RALPH_LRS_RESTRICT_BY_AUTHORITY
option making ?mine=True
implicitRALPH_LRS_RESTRICT_BY_SCOPE
option enabling endpoint access
control by user scopesRUNSERVER_AUTH_BACKEND
becomes RUNSERVER_AUTH_BACKENDS
, and
multiple authentication methods are supported simultaneouslyralph
APIdatabase
, storage
, http
and stream
backends under
the unified data
backend interface [BC]query_statements
and query_statements_by_ids
backends methods under the unified lrs
backend interface [BC]statementId
and voidedStatementId
to snake_case,
with camelCase alias, in LRSStatementsQuery
push
to write
and fetch
to read
[BC]-c --chunk-size
option to -s --chunk-size
[BC]-b ws
to -b async_ws
along with it's
uri option --ws-uri
to --async-ws-uri
[BC]RALPH_BACKENDS__{{DATABASE|HTTP|STORAGE|STREAM}}__{{BACKEND}}__{{OPTION}}
to RALPH_BACKENDS__DATA__{{BACKEND}}__{{OPTION}}
context.contextActivities.category
field is now mandatory
in the video and virtual classroom profiles. [BC]bcrypt
to 4.1.2
cachetools
to 5.3.2
fastapi
to 0.108.0
sentry_sdk
to 1.39.1
uvicorn
to 0.25.0
school
, course
, module
context extensions in Edx to xAPI
base convertername
field in VideoActivity
xAPI model mistakenly used in
video
profileDEFAULT_BACKEND_CHUNK_SIZE
environment variable configurationInstall with:
pip install --pre --upgrade ralph-malph
Writable
and Listable
interfaces to distinguish supported
functionalities among data
backendsmax_statements
option to data backends read
methodprefetch
option to async data backends read
methodconcurrency
option to async data backends write
methodget_backends
function to automatically discover backends
for CLI and LRS usageREAD_CHUNK_SIZE
and WRITE_CHUNK_SIZE
data backend settingsEdX
to xAPI
converters for enrollment eventsralph-malph
extra dependencies: backends
and
full
GET /statements
now has "mine" option which matches statements that
have an authority field matching that of the userid
, timestamp
, stored
and authority
RALPH_LRS_RESTRICT_BY_AUTHORITY
option making ?mine=True
implicitRALPH_LRS_RESTRICT_BY_SCOPE
option enabling endpoint access
control by user scopesRUNSERVER_AUTH_BACKEND
becomes RUNSERVER_AUTH_BACKENDS
, and
multiple authentication methods are supported simultaneouslyralph
APIdatabase
, storage
, http
and stream
backends under
the unified data
backend interface [BC]query_statements
and query_statements_by_ids
backends methods under the unified lrs
backend interface [BC]statementId
and voidedStatementId
to snake_case,
with camelCase alias, in LRSStatementsQuery
push
to write
and fetch
to read
[BC]-c --chunk-size
option to -s --chunk-size
[BC]-b ws
to -b async_ws
along with it's
uri option --ws-uri
to --async-ws-uri
[BC]RALPH_BACKENDS__{{DATABASE|HTTP|STORAGE|STREAM}}__{{BACKEND}}__{{OPTION}}
to RALPH_BACKENDS__DATA__{{BACKEND}}__{{OPTION}}
context.contextActivities.category
field is now mandatory
in the video and virtual classroom profiles. [BC]bcrypt
to 4.1.2
cachetools
to 5.3.2
fastapi
to 0.105.0
sentry_sdk
to 1.39.1
uvicorn
to 0.24.0.post1
school
, course
, module
context extensions in Edx to xAPI
base convertername
field in VideoActivity
xAPI model mistakenly used in
video
profileDEFAULT_BACKEND_CHUNK_SIZE
environment variable configurationfastapi
to 0.100.0
sentry_sdk
to 1.28.1
uvicorn
to 0.23.0
activity
parameter in GET /statements
clickhouse
backendGeneral improvement for the Helm Chart:
lrs
backendfastapi
to 0.97.0
sentry_sdk
to 1.25.1
client_options
to a dedicated Pydantic modelhttpx
to 0.24.1
/statements
GET query agent
filteringcachetools
to 5.3.1
verb
.display
field no longer mandatory in xAPI models and for converter