tutor-contrib-nudge


Nametutor-contrib-nudge JSON
Version 17.0.0 PyPI version JSON
download
home_pagehttps://github.com/aulasneo/tutor-contrib-nudge
Summarynudge plugin for Tutor
upload_time2024-07-26 19:06:49
maintainerNone
docs_urlNone
authorAulasneo
requires_python>=3.7
licenseAGPLv3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            nudge plugin for `Tutor <https://docs.tutor.overhang.io>`_
==========================================================

Plugin to enable nudge and highlights emails.

It creates a CronJob in K8s based on the openedx docker image that calls
the `send_course_update` and `send_recurring_nudge` management commands



Installation
------------

::

    pip install git+https://github.com/aulasneo/tutor-contrib-nudge

Configuration
-------------

- NUDGE_SCHEDULE: Set the schedule for the nudge emails. Default is "0 10 \* \* \*" (everyday at 10am).
- NUDGE_SEND_COURSE_UPDATE: Enable course updates. Default is True.
- NUDGE_SEND_RECURRING_NUDGE: Enable recurring nudges. Default is True.


Usage
-----

::

    tutor plugins enable nudge


License
-------

This software is licensed under the terms of the AGPLv3.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/aulasneo/tutor-contrib-nudge",
    "name": "tutor-contrib-nudge",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": "Aulasneo",
    "author_email": "andres@aulasneo.com",
    "download_url": "https://files.pythonhosted.org/packages/d3/93/2099454bf1428ddf40fe5b2e50b60e0a1d18a91ee3cfc92c81dc60f5b7c7/tutor_contrib_nudge-17.0.0.tar.gz",
    "platform": null,
    "description": "nudge plugin for `Tutor <https://docs.tutor.overhang.io>`_\n==========================================================\n\nPlugin to enable nudge and highlights emails.\n\nIt creates a CronJob in K8s based on the openedx docker image that calls\nthe `send_course_update` and `send_recurring_nudge` management commands\n\n\n\nInstallation\n------------\n\n::\n\n    pip install git+https://github.com/aulasneo/tutor-contrib-nudge\n\nConfiguration\n-------------\n\n- NUDGE_SCHEDULE: Set the schedule for the nudge emails. Default is \"0 10 \\* \\* \\*\" (everyday at 10am).\n- NUDGE_SEND_COURSE_UPDATE: Enable course updates. Default is True.\n- NUDGE_SEND_RECURRING_NUDGE: Enable recurring nudges. Default is True.\n\n\nUsage\n-----\n\n::\n\n    tutor plugins enable nudge\n\n\nLicense\n-------\n\nThis software is licensed under the terms of the AGPLv3.\n",
    "bugtrack_url": null,
    "license": "AGPLv3",
    "summary": "nudge plugin for Tutor",
    "version": "17.0.0",
    "project_urls": {
        "Code": "https://github.com/aulasneo/tutor-contrib-nudge",
        "Homepage": "https://github.com/aulasneo/tutor-contrib-nudge",
        "Issue tracker": "https://github.com/aulasneo/tutor-contrib-nudge/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cbb5f8d4f22be35709bc65bf8a5bd9d7802844ba2e001c2b757b9cd292eeccc0",
                "md5": "fe1b82aca109587be58fa029ac6b8df7",
                "sha256": "ea38812db63b085d2444d4740af75ebab33bc3baa93762a60492fb69d44ca418"
            },
            "downloads": -1,
            "filename": "tutor_contrib_nudge-17.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fe1b82aca109587be58fa029ac6b8df7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 3996,
            "upload_time": "2024-07-26T19:06:46",
            "upload_time_iso_8601": "2024-07-26T19:06:46.070351Z",
            "url": "https://files.pythonhosted.org/packages/cb/b5/f8d4f22be35709bc65bf8a5bd9d7802844ba2e001c2b757b9cd292eeccc0/tutor_contrib_nudge-17.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d3932099454bf1428ddf40fe5b2e50b60e0a1d18a91ee3cfc92c81dc60f5b7c7",
                "md5": "8b63cb2a189500871010f636db1dd8d5",
                "sha256": "79774388c1521b2f3f82a4398bb468064a981868b8c2952f473b0d0a2bb2c003"
            },
            "downloads": -1,
            "filename": "tutor_contrib_nudge-17.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "8b63cb2a189500871010f636db1dd8d5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 3366,
            "upload_time": "2024-07-26T19:06:49",
            "upload_time_iso_8601": "2024-07-26T19:06:49.963271Z",
            "url": "https://files.pythonhosted.org/packages/d3/93/2099454bf1428ddf40fe5b2e50b60e0a1d18a91ee3cfc92c81dc60f5b7c7/tutor_contrib_nudge-17.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-26 19:06:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "aulasneo",
    "github_project": "tutor-contrib-nudge",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "tutor-contrib-nudge"
}
        
Elapsed time: 4.79446s