nice-gui-utils 0.2.4__tar.gz → 0.3.1.dev1__tar.gz

{nice_gui_utils-0.2.4 → nice_gui_utils-0.3.1.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nice_gui_utils
-Version: 0.2.4
+Version: 0.3.1.dev1
 Summary: Utils to use with NiceGUI.
 Author: Harter Kern
 Project-URL: Homepage, https://gitlab.com/harter-kern-public/nice-gui-utils
@@ -13,6 +13,9 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: nicegui>=1.4.0
 
-# Pipeline status
+# nice_gui_utils - a collection of utilities for [nicegui](https://nicegui.io/)
 
+## [Documentation](https://nice-gui-utils-harter-kern-8e1d5c74ce521b132e29aa9329b109a50ad7.gitlab.io)
+
+## Pipeline status
 [![pipeline status](https://gitlab.com/harter-kern/nice-gui-utils/badges/main/pipeline.svg)](https://gitlab.com/harter-kern/nice-gui-utils/-/commits/main)

nice_gui_utils-0.3.1.dev1/README.md

@@ -0,0 +1,6 @@
+# nice_gui_utils - a collection of utilities for [nicegui](https://nicegui.io/)
+
+## [Documentation](https://nice-gui-utils-harter-kern-8e1d5c74ce521b132e29aa9329b109a50ad7.gitlab.io)
+
+## Pipeline status
+[![pipeline status](https://gitlab.com/harter-kern/nice-gui-utils/badges/main/pipeline.svg)](https://gitlab.com/harter-kern/nice-gui-utils/-/commits/main)

{nice_gui_utils-0.2.4 → nice_gui_utils-0.3.1.dev1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "nice_gui_utils"
-version = "0.2.4"
+version = "0.3.1dev1"
 dynamic = ["dependencies"]
 authors = [
     { name = "Harter Kern" },

nice_gui_utils-0.3.1.dev1/src/nice_gui_utils/__init__.py

@@ -0,0 +1,5 @@
+"""
+.. include:: ../../README.md
+"""
+from .keycloak_js import KeycloakConfig, Keycloak
+from .router import Router

nice_gui_utils-0.3.1.dev1/src/nice_gui_utils/keycloak_js/__init__.py

@@ -0,0 +1,4 @@
+"""
+.. include:: ../../../docs/keycloak_js/README.md
+"""
+from .keycloak import KeycloakConfig, Keycloak

nice_gui_utils-0.3.1.dev1/src/nice_gui_utils/keycloak_js/keycloak.py

@@ -0,0 +1,94 @@
+"""
+Implementation of the keycloak wrapper class.
+See keycloak-js api reference for more info.
+"""
+from dataclasses import dataclass
+from typing import AnyStr, Dict, Any
+
+from nicegui import ui
+from nicegui.awaitable_response import AwaitableResponse
+
+
+@dataclass
+class KeycloakConfig:
+    """
+    Base Keycloak config.
+    """
+    url: AnyStr
+    realm: AnyStr
+    client_id: AnyStr
+
+
+class Keycloak(ui.element, component='keycloak.js'):
+    """
+    Wrapper class. Exposes part of the api of keycloak-js.
+    Will automatically refresh tokens after initialization.
+    """
+
+    config: KeycloakConfig = None
+    require_login: bool = None
+
+    def __init__(self,
+                 config: KeycloakConfig,
+                 js_source: AnyStr = '/static/keycloak.js',
+                 init_options: Dict = None):
+        """
+
+        :param config: base keycloak config
+        :param js_source: url of keycloak-js source
+        :param init_options: options used for initialization
+        """
+        super().__init__()
+
+        ui.add_head_html(f'<script src="{js_source}"></script>')
+
+        props: Dict[str, Any] = self._props
+        props['url'] = config.url
+        props['realm'] = config.realm
+        props['clientId'] = config.client_id
+
+        props['initOptions'] = init_options if init_options else {}
+
+    def token(self) -> AwaitableResponse:
+        """
+        Get a token that can be sent in the Authorization header in requests to services.
+
+        :return: base64 encoded token
+        """
+        return self.run_method('token')
+
+    def refresh_token(self) -> AwaitableResponse:
+        """
+        Get a refresh token that can be used to retrieve a new token.
+
+        :return: base64 encoded refresh token
+        """
+        return self.run_method('refreshToken')
+
+    def authenticated(self) -> AwaitableResponse:
+        """
+        Returns true if the user is authenticated, false otherwise.
+
+        :return: whether the used is authenticated
+        """
+        return self.run_method('authenticated')
+
+    async def login(self, options: Dict = None) -> None:
+        """
+        Redirects to login form.
+        See keycloak-js api reference
+        for more info about available options.
+
+        :param options: optional object
+        """
+        await self.run_method('login', options if options else {})
+
+    async def logout(self, options: Dict = None) -> None:
+        """
+        Redirects to logout.
+        See keycloak-js api reference
+        for more info about available options.
+
+        :param options: optional object
+        """
+        await self.run_method('logout', options if options else {})

nice_gui_utils-0.3.1.dev1/src/nice_gui_utils/router/__init__.py

@@ -0,0 +1,4 @@
+"""
+.. include:: ../../../docs/router/README.md
+"""
+from .router import Router

{nice_gui_utils-0.2.4 → nice_gui_utils-0.3.1.dev1}/src/nice_gui_utils/router/router.py

@@ -1,3 +1,6 @@
+"""
+A single page router enabling navigation without page reloading.
+"""
 from functools import singledispatchmethod
 from typing import Callable, Dict, Optional, AnyStr, Union, Any
 
@@ -12,18 +15,33 @@ class _RouterFrame(ui.element, component='router_frame.js'):
         props: Dict[AnyStr, Any] = self._props
         props['checkInterval'] = check_interval
 
-    def update_history(self, path):
+    def update_history(self, path) -> None:
+        """
+        Update browser history.
+        You do not need to call this directly.
+
+        :param path: path to add to the history
+        """
         self.run_method('updateHistory', path)
 
 
 class Router:
+    """
+    Single page router.
+    """
 
     def __init__(self, check_interval: int = None) -> None:
         self.routes: Dict[AnyStr, Callable] = {}
         self.content: Optional[ui.element] = None
         self.router_frame: _RouterFrame = _RouterFrame(check_interval if check_interval else 10)
 
-    def path(self, path: str):
+    def path(self, path: AnyStr):
+        """
+        Decorator method. Register a path with this router.
+
+        :param path: path to register
+        """
+
         def decorator(func: Callable):
             self.routes[path] = func
             return func
@@ -31,7 +49,12 @@ class Router:
         return decorator
 
     @singledispatchmethod
-    def go_to(self, target: Union[Callable, AnyStr]):
+    def go_to(self, target: Union[Callable, AnyStr]) -> None:
+        """
+        Navigate to another registered page.
+
+        :param target: page to go to
+        """
         path = {target: path for path, target in self.routes.items()}[target]
         self.go_to(path)
 
@@ -51,5 +74,10 @@ class Router:
         background_tasks.create(build())
 
     def frame(self) -> ui.element:
+        """
+        Add content to page.
+
+        :return: the ui element to display
+        """
         self.content = self.router_frame.on('open', lambda e: self.go_to(e.args))
         return self.content

{nice_gui_utils-0.2.4 → nice_gui_utils-0.3.1.dev1}/src/nice_gui_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nice_gui_utils
-Version: 0.2.4
+Version: 0.3.1.dev1
 Summary: Utils to use with NiceGUI.
 Author: Harter Kern
 Project-URL: Homepage, https://gitlab.com/harter-kern-public/nice-gui-utils
@@ -13,6 +13,9 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: nicegui>=1.4.0
 
-# Pipeline status
+# nice_gui_utils - a collection of utilities for [nicegui](https://nicegui.io/)
 
+## [Documentation](https://nice-gui-utils-harter-kern-8e1d5c74ce521b132e29aa9329b109a50ad7.gitlab.io)
+
+## Pipeline status
 [![pipeline status](https://gitlab.com/harter-kern/nice-gui-utils/badges/main/pipeline.svg)](https://gitlab.com/harter-kern/nice-gui-utils/-/commits/main)

nice_gui_utils-0.2.4/README.md

@@ -1,3 +0,0 @@
-# Pipeline status
-
-[![pipeline status](https://gitlab.com/harter-kern/nice-gui-utils/badges/main/pipeline.svg)](https://gitlab.com/harter-kern/nice-gui-utils/-/commits/main)

nice_gui_utils-0.2.4/src/nice_gui_utils/keycloak_js/__init__.py

@@ -1 +0,0 @@
-from .keycloak import KeycloakConfig, Keycloak

nice_gui_utils-0.2.4/src/nice_gui_utils/keycloak_js/keycloak.py

@@ -1,47 +0,0 @@
-from dataclasses import dataclass
-from typing import AnyStr, Dict, Any
-
-from nicegui import ui
-from nicegui.awaitable_response import AwaitableResponse
-
-
-@dataclass
-class KeycloakConfig:
-    url: AnyStr
-    realm: AnyStr
-    client_id: AnyStr
-
-
-class Keycloak(ui.element, component='keycloak.js'):
-    config: KeycloakConfig = None
-    require_login: bool = None
-
-    def __init__(self,
-                 config: KeycloakConfig,
-                 js_source: AnyStr = '/static/keycloak.js',
-                 init_options: Dict = None):
-        super().__init__()
-
-        ui.add_head_html(f'<script src="{js_source}"></script>')
-
-        props: Dict[str, Any] = self._props
-        props['url'] = config.url
-        props['realm'] = config.realm
-        props['clientId'] = config.client_id
-
-        props['initOptions'] = init_options if init_options else {}
-
-    def token(self) -> AwaitableResponse:
-        return self.run_method('token')
-
-    def refresh_token(self) -> AwaitableResponse:
-        return self.run_method('refreshToken')
-
-    def authenticated(self) -> AwaitableResponse:
-        return self.run_method('authenticated')
-
-    def login(self, options=None) -> AwaitableResponse:
-        return self.run_method('login', options if options else {})
-
-    def logout(self, options=None) -> AwaitableResponse:
-        return self.run_method('logout', options if options else {})

nice_gui_utils-0.2.4/src/nice_gui_utils/router/__init__.py

@@ -1 +0,0 @@
-from .router import Router