ralph-malph 1.1.0

An OpenEdx's tracking logs processor to feed your LRS

Ralph, a learning analytics processor to feed your LRS

Getting started with development

Core development

To start playing with ralph, you should build it using the bootstrap Make target:

$ make bootstrap

Now you can start playing the CLI:

$ bin/ralph --help

To lint your code, either use the lint meta target or one of the linting tools we use:

# Run all linters
$ make lint

# Run pylint
$ make lint-pylint

# List available linters
$ make help | grep lint-

To run tests on your code, either use the test Make target or the bin/pytest script to pass specific arguments to the test runner:

# Run all tests
$ make test

# Run pytest with options
$ bin/pytest -x -k mixins

Tray development

Ralph is distributed along with its tray (a deployable package for Kubernetes clusters using Arnold). If you intend to work on this tray, please refer to Arnold's documentation.

Local Swift Storage development

To make ralph work with a local instance of Swift:

1. Setup environment variables for demo swift user in .env

RALPH_SWIFT_OS_USERNAME=demo
RALPH_SWIFT_OS_PASSWORD=demo
RALPH_SWIFT_OS_USER_DOMAIN_NAME=Default
RALPH_SWIFT_OS_PROJECT_DOMAIN_NAME=Default
RALPH_SWIFT_OS_AUTH_URL=http://swift:35357/v3/
RALPH_SWIFT_OS_IDENTITY_API_VERSION=3
RALPH_SWIFT_OS_REGION_NAME=RegionOne
RALPH_SWIFT_OS_TENANT_ID=cd238e84310a46e58af7f1d515887d88
RALPH_SWIFT_OS_TENANT_NAME=RegionOne
RALPH_SWIFT_OS_STORAGE_URL=http://swift:8080/v1/KEY_cd238e84310a46e58af7f1d515887d88/test_container

2. Push a first object (forcefully) to create the test container

$ echo "some content" | ./bin/ralph push -b swift -f some_archive_name

Now ralph should be fully functional with the local Swift storage.

Contributing

This project is intended to be community-driven, so please, do not hesitate to get in touch if you have any question related to our implementation or design decisions.

We try to raise our code quality standards and expect contributors to follow the recommandations from our handbook.

License

This work is released under the MIT License (see LICENSE).