| Name | jupyter-server-user-token JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Jupyter Server Extension to inject the User Token into the Jupyter Server environment |
| upload_time | 2024-07-11 18:10:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | Copyright 2024 Curvenote Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
auth
extension
jupyter
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyter-server-user-token
A simple Jupyter Server extension that adds the server's User Token (if it exists) into the process's environment as `JUPYTER_SERVER_USER_TOKEN`.
## Why?
Some frontend extensions and visualisation libraries use iframes to render documents served out on Jupyter Server Proxy.
These iframes might have an href target like: `/proxy/index.html?some=query-params` and work happily when used in notebooks and lab.
In the context of `myst` the same visualisations run into issues when connecting to remote Jupyter servers running on different origins, as the cookie-based auth in play in a same-origin lab front ends, will fail on a typlical myst website.
By exposing the user token, end user code can do something about this and supply the user token string to the library / extension code that needs it.
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyter-server-user-token",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Auth, Extension, Jupyter",
"author": null,
"author_email": "Steve Purves <steve@curvenote.com>",
"download_url": "https://files.pythonhosted.org/packages/aa/7a/b17fa1e8872a610cf2544b6dfd2921d69db216ef5e310c8114372f2ea0a2/jupyter_server_user_token-0.1.0.tar.gz",
"platform": null,
"description": "# jupyter-server-user-token\n\nA simple Jupyter Server extension that adds the server's User Token (if it exists) into the process's environment as `JUPYTER_SERVER_USER_TOKEN`.\n\n## Why?\n\nSome frontend extensions and visualisation libraries use iframes to render documents served out on Jupyter Server Proxy.\n\nThese iframes might have an href target like: `/proxy/index.html?some=query-params` and work happily when used in notebooks and lab.\n\nIn the context of `myst` the same visualisations run into issues when connecting to remote Jupyter servers running on different origins, as the cookie-based auth in play in a same-origin lab front ends, will fail on a typlical myst website.\n\nBy exposing the user token, end user code can do something about this and supply the user token string to the library / extension code that needs it.\n",
"bugtrack_url": null,
"license": "Copyright 2024 Curvenote Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Jupyter Server Extension to inject the User Token into the Jupyter Server environment",
"version": "0.1.0",
"project_urls": {
"Home": "https://github.com/curvenote/jupyter-server-user-token"
},
"split_keywords": [
"auth",
" extension",
" jupyter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3918b78901297239a7962ea2dfee69510b6c579d353b30fb8c726d0151c45b76",
"md5": "e1f57ff6937d19c72909dab854c7e967",
"sha256": "0ccfcb8b2a9bca77b806f66c2f15828e1464536ced5109b09fe71577b49c31cc"
},
"downloads": -1,
"filename": "jupyter_server_user_token-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e1f57ff6937d19c72909dab854c7e967",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 3981,
"upload_time": "2024-07-11T18:10:01",
"upload_time_iso_8601": "2024-07-11T18:10:01.500141Z",
"url": "https://files.pythonhosted.org/packages/39/18/b78901297239a7962ea2dfee69510b6c579d353b30fb8c726d0151c45b76/jupyter_server_user_token-0.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aa7ab17fa1e8872a610cf2544b6dfd2921d69db216ef5e310c8114372f2ea0a2",
"md5": "898fd549fdc779e71bb971779634467e",
"sha256": "1d4325fcfa61ccb4d1171321a8076a3ab7a157cc5cbf96a76aad608a0e812fa9"
},
"downloads": -1,
"filename": "jupyter_server_user_token-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "898fd549fdc779e71bb971779634467e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2696,
"upload_time": "2024-07-11T18:10:09",
"upload_time_iso_8601": "2024-07-11T18:10:09.486307Z",
"url": "https://files.pythonhosted.org/packages/aa/7a/b17fa1e8872a610cf2544b6dfd2921d69db216ef5e310c8114372f2ea0a2/jupyter_server_user_token-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-11 18:10:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "curvenote",
"github_project": "jupyter-server-user-token",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jupyter-server-user-token"
}
