datalab-ltiauthenticator


Namedatalab-ltiauthenticator JSON
Version 4.0.1 PyPI version JSON
download
home_page
SummaryJupyterHub authenticator implementing LTI v1.1 and LTI v1.3
upload_time2024-02-15 11:33:14
maintainer
docs_urlNone
author
requires_python>=3.8
licenseBSD 3-Clause License Copyright (c) 2016, Project Jupyter Contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords authenticator jupyterhub
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # LTI dataLAB Authenticator
This package contains LTI authenticators for JupyterHub with some custom config for username_key.

[![Documentation build status](https://img.shields.io/readthedocs/ltiauthenticator?logo=read-the-docs)](https://ltiauthenticator.readthedocs.io/en/latest/?badge=latest)
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jupyterhub/ltiauthenticator/Tests?logo=github)](https://github.com/jupyterhub/ltiauthenticator/actions)
[![Latest PyPI version](https://img.shields.io/pypi/v/jupyterhub-ltiauthenticator?logo=pypi)](https://pypi.python.org/pypi/jupyterhub-ltiauthenticator)

Implements the [LTI 1.3](http://www.imsglobal.org/spec/lti/v1p3/impl) and the [LTI v1.1](http://www.imsglobal.org/specs/ltiv1p1p1/implementation-guide) authenticators for use with JupyterHub.

This converts JupyterHub into an LTI **Tool Provider**, which can be then easily be used with various **Tool Consumers**, such as Canvas, Open EdX, Moodle, Blackboard, etc.

So far, `ltiauthenticator` has been tested with [Open edX](http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/lti_component.html), [Canvas](https://canvas.instructure.com/doc/api/file.tools_intro.html), and [Moodle](https://docs.moodle.org/311/en/LTI_and_Moodle). Documentation contributions are highly welcome!

Note that with these `LTI` authenticators going directly to the hub URL will no longer allow you to log in. You _must_ visit the hub through an appropriate LTI 1.1 compliant Tool Consumer or LTI 1.3 compliant Platform (such as Canvas, Moodle, Open edX, etc.) to be able to log in.

> **Note**: LTI 1.1 identifies the LMS as the `Tool Consumer` and LTI 1.3 identifies the LMS as the `Platform` for all practical purposes these terms are equivalent.

## Installation

You can install the authenticator from PyPI:

```bash
pip install datalab-ltiauthenticator
```

## Using the LTI Authenticators

For detailed instructions on how to configure the `LTI13Authenticator` or `LTI11Authenticator` and integrate it with an LMS, such as Canvas, Open EdX, Moodle, Blackboard, etc., please take a look at the [documentation](https://ltiauthenticator.readthedocs.io/).

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "datalab-ltiauthenticator",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "authenticator,jupyterhub",
    "author": "",
    "author_email": "Yuvi Panda <yuvipanda@gmail.com>, Jupyter Contributors <jupyter@googlegroups.com>",
    "download_url": "https://files.pythonhosted.org/packages/c7/1e/65aad6cfe63f6721efd6e686573df505d136c680eccf025a1f87a3f150e6/datalab_ltiauthenticator-4.0.1.tar.gz",
    "platform": null,
    "description": "# LTI dataLAB Authenticator\nThis package contains LTI authenticators for JupyterHub with some custom config for username_key.\n\n[![Documentation build status](https://img.shields.io/readthedocs/ltiauthenticator?logo=read-the-docs)](https://ltiauthenticator.readthedocs.io/en/latest/?badge=latest)\n[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jupyterhub/ltiauthenticator/Tests?logo=github)](https://github.com/jupyterhub/ltiauthenticator/actions)\n[![Latest PyPI version](https://img.shields.io/pypi/v/jupyterhub-ltiauthenticator?logo=pypi)](https://pypi.python.org/pypi/jupyterhub-ltiauthenticator)\n\nImplements the [LTI 1.3](http://www.imsglobal.org/spec/lti/v1p3/impl) and the [LTI v1.1](http://www.imsglobal.org/specs/ltiv1p1p1/implementation-guide) authenticators for use with JupyterHub.\n\nThis converts JupyterHub into an LTI **Tool Provider**, which can be then easily be used with various **Tool Consumers**, such as Canvas, Open EdX, Moodle, Blackboard, etc.\n\nSo far, `ltiauthenticator` has been tested with [Open edX](http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/lti_component.html), [Canvas](https://canvas.instructure.com/doc/api/file.tools_intro.html), and [Moodle](https://docs.moodle.org/311/en/LTI_and_Moodle). Documentation contributions are highly welcome!\n\nNote that with these `LTI` authenticators going directly to the hub URL will no longer allow you to log in. You _must_ visit the hub through an appropriate LTI 1.1 compliant Tool Consumer or LTI 1.3 compliant Platform (such as Canvas, Moodle, Open edX, etc.) to be able to log in.\n\n> **Note**: LTI 1.1 identifies the LMS as the `Tool Consumer` and LTI 1.3 identifies the LMS as the `Platform` for all practical purposes these terms are equivalent.\n\n## Installation\n\nYou can install the authenticator from PyPI:\n\n```bash\npip install datalab-ltiauthenticator\n```\n\n## Using the LTI Authenticators\n\nFor detailed instructions on how to configure the `LTI13Authenticator` or `LTI11Authenticator` and integrate it with an LMS, such as Canvas, Open EdX, Moodle, Blackboard, etc., please take a look at the [documentation](https://ltiauthenticator.readthedocs.io/).\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2016, Project Jupyter Contributors All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
    "summary": "JupyterHub authenticator implementing LTI v1.1 and LTI v1.3",
    "version": "4.0.1",
    "project_urls": {
        "Documentation": "https://ltiauthenticator.readthedocs.io",
        "Issues": "https://github.com/jupyterhub/ltiauthenticator/issues",
        "Source": "https://github.com/jupyterhub/ltiauthenticator"
    },
    "split_keywords": [
        "authenticator",
        "jupyterhub"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "70974222cc319024253fcf3f1cd23417629ed1d58b3a1fe51767c19940a2fced",
                "md5": "648b95e373d0d47cd3594d3ed88c93a0",
                "sha256": "39e214185b7c1eef35baf7393314883e14d56e8ba6abac4d88bdc8b5830da8bd"
            },
            "downloads": -1,
            "filename": "datalab_ltiauthenticator-4.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "648b95e373d0d47cd3594d3ed88c93a0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 28394,
            "upload_time": "2024-02-15T11:33:12",
            "upload_time_iso_8601": "2024-02-15T11:33:12.321530Z",
            "url": "https://files.pythonhosted.org/packages/70/97/4222cc319024253fcf3f1cd23417629ed1d58b3a1fe51767c19940a2fced/datalab_ltiauthenticator-4.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c71e65aad6cfe63f6721efd6e686573df505d136c680eccf025a1f87a3f150e6",
                "md5": "1ce52ef0fd5ba12df944dcbfcd04527b",
                "sha256": "623b322604aa5ede97b5c2eb2f0289df31635d76819cf196eab1e1339370a3a6"
            },
            "downloads": -1,
            "filename": "datalab_ltiauthenticator-4.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "1ce52ef0fd5ba12df944dcbfcd04527b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 21940,
            "upload_time": "2024-02-15T11:33:14",
            "upload_time_iso_8601": "2024-02-15T11:33:14.284175Z",
            "url": "https://files.pythonhosted.org/packages/c7/1e/65aad6cfe63f6721efd6e686573df505d136c680eccf025a1f87a3f150e6/datalab_ltiauthenticator-4.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-15 11:33:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jupyterhub",
    "github_project": "ltiauthenticator",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "datalab-ltiauthenticator"
}
        
Elapsed time: 0.20124s