fps_notebook 0.9.5__tar.gz

fps_notebook-0.9.5/COPYING.md

@@ -0,0 +1,59 @@
+# Licensing terms
+
+This project is licensed under the terms of the Modified BSD License
+(also known as New or Revised or 3-Clause BSD), as follows:
+
+- Copyright (c) 2021-, Jupyter Development Team
+
+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 Jupyter Development Team 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 OWNER 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.
+
+## About the Jupyter Development Team
+
+The Jupyter Development Team is the set of all contributors to the Jupyter project.
+This includes all of the Jupyter subprojects.
+
+The core team that coordinates development on GitHub can be found here:
+https://github.com/jupyter/.
+
+## Our Copyright Policy
+
+Jupyter uses a shared copyright model. Each contributor maintains copyright
+over their contributions to Jupyter. But, it is important to note that these
+contributions are typically only changes to the repositories. Thus, the Jupyter
+source code, in its entirety is not the copyright of any single person or
+institution. Instead, it is the collective copyright of the entire Jupyter
+Development Team. If individual contributors want to maintain a record of what
+changes/contributions they have specific copyright on, they should indicate
+their copyright in the commit message of the change, when they commit the
+change to one of the Jupyter repositories.
+
+With this in mind, the following banner should be used in any source code file
+to indicate the copyright and license terms:
+
+    # Copyright (c) Jupyter Development Team.
+    # Distributed under the terms of the Modified BSD License.

fps_notebook-0.9.5/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: fps_notebook
+Version: 0.9.5
+Summary: An FPS plugin for the Notebook API
+Keywords: jupyter,server,fastapi,plugins
+Author: Jupyter Development Team
+Author-email: Jupyter Development Team <jupyter@googlegroups.com>
+License-Expression: BSD-3-Clause
+License-File: COPYING.md
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Dist: notebook-frontend>=7.4.2,<8.0.0
+Requires-Dist: jupyverse-api>=0.12.0,<0.13.0
+Requires-Python: >=3.10
+Project-URL: Homepage, https://jupyter.org
+Description-Content-Type: text/markdown
+
+# fps-notebook
+
+An FPS plugin for the Notebook API.

fps_notebook-0.9.5/README.md

@@ -0,0 +1,3 @@
+# fps-notebook
+
+An FPS plugin for the Notebook API.

fps_notebook-0.9.5/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["uv_build"]
+build-backend = "uv_build"
+
+[project]
+name = "fps_notebook"
+version = "0.9.5"
+description = "An FPS plugin for the Notebook API"
+keywords = ["jupyter", "server", "fastapi", "plugins"]
+requires-python = ">=3.10"
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: BSD License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+  "notebook-frontend >=7.4.2,<8.0.0",
+  "jupyverse-api >=0.12.0,<0.13.0",
+]
+license = "BSD-3-Clause"
+license-files = ["COPYING.md"]
+
+[[project.authors]]
+name = "Jupyter Development Team"
+email = "jupyter@googlegroups.com"
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[project.urls]
+Homepage = "https://jupyter.org"
+
+[project.entry-points]
+"fps.modules" = {notebook = "fps_notebook.main:NotebookModule"}
+"jupyverse.modules" = {notebook = "fps_notebook.main:NotebookModule"}

fps_notebook-0.9.5/src/fps_notebook/__init__.py

@@ -0,0 +1,6 @@
+import importlib.metadata
+
+try:
+    __version__ = importlib.metadata.version("fps_notebook")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "unknown"

fps_notebook-0.9.5/src/fps_notebook/main.py

@@ -0,0 +1,24 @@
+import structlog
+from fps import Module
+from jupyverse_api.app import App
+from jupyverse_api.auth import Auth
+from jupyverse_api.frontend import FrontendConfig
+from jupyverse_api.jupyterlab import JupyterLabConfig
+from jupyverse_api.lab import Lab
+from jupyverse_api.notebook import Notebook
+
+from .routes import _Notebook
+
+logger = structlog.get_logger()
+
+
+class NotebookModule(Module):
+    async def prepare(self) -> None:
+        self.put(None, JupyterLabConfig)
+        app = await self.get(App)
+        auth = await self.get(Auth)  # type: ignore[type-abstract]
+        frontend_config = await self.get(FrontendConfig)
+        lab = await self.get(Lab)  # type: ignore[type-abstract]
+
+        notebook = _Notebook(app, auth, frontend_config, lab)
+        self.put(notebook, Notebook)

fps_notebook-0.9.5/src/fps_notebook/routes.py

@@ -0,0 +1,207 @@
+import json
+from pathlib import Path
+
+import notebook_frontend
+from fastapi.staticfiles import StaticFiles
+from jupyverse_api.app import App
+from jupyverse_api.auth import Auth, User
+from jupyverse_api.frontend import FrontendConfig
+from jupyverse_api.lab import Lab
+from jupyverse_api.notebook import Notebook
+
+
+class _Notebook(Notebook):
+    def __init__(self, app: App, auth: Auth, frontend_config: FrontendConfig, lab: Lab) -> None:
+        super().__init__(app, auth, lab)
+        self.frontend_config = frontend_config
+        self.lab = lab
+        lab.redirect_after_root = "tree"
+
+        extensions_dir = lab.prefix_dir / "share" / "jupyter" / "labextensions"
+        self.federated_extensions, self.disabled_extensions = lab.get_federated_extensions(
+            extensions_dir
+        )
+        self.notebook_dir = Path(notebook_frontend.__file__).parent
+
+        self.mount(
+            "/static/notebook",
+            StaticFiles(directory=self.notebook_dir / "static"),
+            name="static",
+        )
+
+    async def get_tree(
+        self,
+        user: User,
+    ):
+        return get_index(
+            self.lab,
+            self.notebook_dir,
+            self.federated_extensions,
+            self.disabled_extensions,
+            "Tree",
+            "tree",
+            self.frontend_config.collaborative,
+            self.frontend_config.base_url,
+        )
+
+    async def get_notebook(
+        self,
+        path,
+        user: User,
+    ):
+        return get_index(
+            self.lab,
+            self.notebook_dir,
+            self.federated_extensions,
+            self.disabled_extensions,
+            path,
+            "notebooks",
+            self.frontend_config.collaborative,
+            self.frontend_config.base_url,
+        )
+
+    async def edit_file(
+        self,
+        path,
+        user: User,
+    ):
+        return get_index(
+            self.lab,
+            self.notebook_dir,
+            self.federated_extensions,
+            self.disabled_extensions,
+            path,
+            "edit",
+            self.frontend_config.collaborative,
+            self.frontend_config.base_url,
+        )
+
+    async def get_console(
+        self,
+        path,
+        user: User,
+    ):
+        return get_index(
+            self.lab,
+            self.notebook_dir,
+            self.federated_extensions,
+            self.disabled_extensions,
+            path,
+            "consoles",
+            self.frontend_config.collaborative,
+            self.frontend_config.base_url,
+        )
+
+    async def get_terminal(
+        self,
+        name: str,
+        user: User,
+    ):
+        return get_index(
+            self.lab,
+            self.notebook_dir,
+            self.federated_extensions,
+            self.disabled_extensions,
+            name,
+            "terminals",
+            self.frontend_config.collaborative,
+            self.frontend_config.base_url,
+        )
+
+
+INDEX_HTML = """\
+<!doctype html>
+<html>
+    <head>
+        <meta charset="utf-8"/>
+        <meta name="viewport" content="width=device-width,initial-scale=1"/>
+        <title>Home</title>
+        <link rel="icon" type="image/x-icon" href="/static/favicons/favicon.ico" class="favicon"/>
+        <link rel="stylesheet" href="/custom/custom.css"/>
+        <script defer="defer" src="FULL_STATIC_URL/main.MAIN_ID.js?v=MAIN_ID"></script>
+    </head>
+    <body class="jp-ThemedContainer">
+        <script id="jupyter-config-data" type="application/json">
+            PAGE_CONFIG
+        </script>
+        <script>
+            /* Remove token from URL. */
+            (function() {
+                var parsedUrl = new URL(window.location.href);
+                if (parsedUrl.searchParams.get('token')) {
+                    parsedUrl.searchParams.delete('token');
+                    window.history.replaceState({}, '', parsedUrl.href);
+                }
+            }
+            )();
+        </script>
+    </body>
+</html>
+"""
+
+
+def get_index(
+    lab,
+    notebook_dir,
+    federated_extensions,
+    disabled_extensions,
+    doc_name,
+    notebook_page,
+    collaborative,
+    base_url="/",
+):
+    full_static_url = f"{base_url}static/notebook"
+    for path in (notebook_dir / "static").glob("main.*.js"):
+        main_id = path.name.split(".")[1]
+        break
+    page_config = {
+        "appName": "Notebook",
+        "appNamespace": "notebook",
+        "appSettingsDir": (lab.prefix_dir / "share" / "jupyter" / "lab" / "settings").as_posix(),
+        "appUrl": "/lab",
+        "appVersion": notebook_frontend.__version__,
+        "baseUrl": base_url,
+        "cacheFiles": True,
+        "collaborative": collaborative,
+        "disabledExtensions": disabled_extensions,
+        "extraLabextensionsPath": [],
+        "federated_extensions": federated_extensions,
+        "frontendUrl": "/notebook/",
+        "fullAppUrl": f"{base_url}lab",
+        "fullLabextensionsUrl": f"{base_url}lab/extensions",
+        "fullLicensesUrl": f"{base_url}lab/api/licenses",
+        "fullListingsUrl": f"{base_url}lab/api/listings",
+        "fullMathjaxUrl": f"{base_url}static/notebook/components/MathJax/MathJax.js",
+        "fullSettingsUrl": f"{base_url}lab/api/settings",
+        "fullStaticUrl": f"{base_url}static/notebook",
+        "fullThemesUrl": f"{base_url}lab/api/themes",
+        "fullTranslationsApiUrl": f"{base_url}lab/api/translations",
+        "fullTreeUrl": f"{base_url}lab/tree",
+        "fullWorkspacesApiUrl": f"{base_url}lab/api/workspaces",
+        "labextensionsPath": [(lab.prefix_dir / "share" / "jupyter" / "labextensions").as_posix()],
+        "labextensionsUrl": "/lab/extensions",
+        "licensesUrl": "/lab/api/licenses",
+        "listingsUrl": "/lab/api/listings",
+        "mathjaxConfig": "TeX-AMS-MML_HTMLorMML-full,Safe",
+        "notebookLogo": False,
+        "notebookPage": notebook_page,
+        "schemasDir": (lab.prefix_dir / "share" / "jupyter" / "lab" / "schemas").as_posix(),
+        "settingsUrl": "/lab/api/settings",
+        "staticDir": (notebook_dir / "static").as_posix(),
+        "templatesDir": (notebook_dir / "templates").as_posix(),
+        "terminalsAvailable": True,
+        "themesDir": (lab.prefix_dir / "share" / "jupyter" / "lab" / "themes").as_posix(),
+        "themesUrl": "/lab/api/themes",
+        "translationsApiUrl": "/lab/api/translations",
+        "treeUrl": "/lab/tree",
+        "workspacesApiUrl": "/lab/api/workspaces",
+        "wsUrl": "",
+    }
+    index = (
+        INDEX_HTML.replace("PAGE_CONFIG", json.dumps(page_config))
+        .replace("MAIN_ID", main_id)
+        .replace("DOC_NAME", doc_name)
+        .replace("BASE_URL", base_url)
+        .replace("FULL_STATIC_URL", full_static_url)
+    )
+    return index