diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index af2a2e2..4cd436c 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,8 +1,11 @@ variables: TUTOR_PLUGIN: cairn TUTOR_IMAGES: cairn-clickhouse cairn-superset - TUTOR_PYPI_PRIVATE_PACKAGE: tutor-cairn + # TODO uncomment to publish package on pypi + # TUTOR_PYPI_PACKAGE: tutor-cairn OPENEDX_RELEASE: olive + GITHUB_REPO: overhangio/tutor-cairn + include: - project: 'community/tutor-ci' diff --git a/README.rst b/README.rst index 7e901bf..3db256c 100644 --- a/README.rst +++ b/README.rst @@ -43,9 +43,9 @@ Cairn uses the same collect/store/expose paradigm made popular by other framewor Installation ------------ -Cairn requires a `Tutor Wizard Edition license `__. Once you have enabled your license, installing the plugin is as simple as running:: +Cairn used to be a commercial plugin, but is now available for free to all Tutor users. Install the plugin with:: - tutor license install tutor-cairn + pip install tutor-cairn Usage ----- @@ -79,11 +79,11 @@ You can then access the frontend with the user credentials you just created. Ope Some event data might be missing from your dashboards: just start using your LMS and refresh your dashboard. The new events should appear immediately. -.. image:: https://overhang.io/static/catalog/img/cairn/courseoverview-01.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-cairn/master/static/screenshots/courseoverview-01.png :alt: Course overview dashboard part 1 -.. image:: https://overhang.io/static/catalog/img/cairn/courseoverview-02.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-cairn/master/static/screenshots/courseoverview-02.png :alt: Course overview dashboard part 2 -.. image:: https://overhang.io/static/catalog/img/cairn/courseoverview-03.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-cairn/master/static/screenshots/courseoverview-03.png :alt: Course overview dashboard part 3 Available metrics @@ -140,7 +140,7 @@ Or, if you want to avoid running the full plugin initialization:: Running on Kubernetes ~~~~~~~~~~~~~~~~~~~~~ -When running on Kubernetes instead of locally, most commands above can be re-written with `tutor k8s exec service "command"` instead of `tutor local run service command`. For instance:: +When running on Kubernetes instead of locally, most commands above can be re-written with ``tutor k8s exec service "command"`` instead of ``tutor local run service command``. For instance:: # Privileged user creation tutor k8s exec cairn-superset "superset fab create-admin --username YOURUSERNAME --email user@example.com" @@ -232,11 +232,10 @@ Postgresql/Superset settings - ``CAIRN_POSTGRESQL_PASSWORD`` (default: ``"{{ 20|random_string }}"``): Postgresql password. - ``CAIRN_SUPERSET_SECRET_KEY`` (default: ``"{{ 20|random_string }}"``): randomly-generated secret key for the Superset frontend. +Troubleshooting +--------------- -Support -------- - -Are you having trouble with Cairn? Do you have questions about this plugin? Please get in touch with us at contact@overhang.io. Community support is also available on the official Tutor forums: https://discuss.overhang.io +This Tutor plugin is maintained by RĂ©gis Behmo from `Overhang.IO `__. Community support is available from the official `Open edX forum `__. Do you need help with this plugin? See the `troubleshooting `__ section from the Tutor documentation. License ------- diff --git a/setup.py b/setup.py index 139b2a8..643b84a 100644 --- a/setup.py +++ b/setup.py @@ -34,7 +34,7 @@ def load_about(): }, license="AGPLv3", author="Overhang.IO", - description="cairn plugin for Tutor", + description="Scalable, real-time analytics for Open edX", long_description=load_readme(), packages=find_packages(exclude=["tests*"]), include_package_data=True,