opensignalbox-ui-web 0.1.0__tar.gz

opensignalbox_ui_web-0.1.0/.gitignore

@@ -0,0 +1,182 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### opensignalbox ###
+tests/**/settings.toml
+tests/workspace/boxes/*/resources/*
+tests/workspace/boxes/Lowdham
+opensignalbox/trainplanning/ltsv/icons
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+#dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

opensignalbox_ui_web-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12.2

opensignalbox_ui_web-0.1.0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+- WIP

opensignalbox_ui_web-0.1.0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: opensignalbox-ui-web
+Version: 0.1.0
+Summary: The official web UI module for the opensignalbox simulation framework.
+Project-URL: Homepage, https://opensignalbox.org/
+Project-URL: Repository, https://github.com/opensignalbox/opensignalbox
+Author-email: The openSignalBox project <info@opensignalbox.org>
+Maintainer-email: Laurence Stant <laurence@stant.phd>
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: fastapi>=0.110.0
+Description-Content-Type: text/markdown
+
+openSignalBox package code repo.

opensignalbox_ui_web-0.1.0/README.md

@@ -0,0 +1 @@
+openSignalBox package code repo.

opensignalbox_ui_web-0.1.0/pyproject.toml

@@ -0,0 +1,30 @@
+[project]
+name = "opensignalbox-ui-web"
+version = "0.1.0"
+description = "The official web UI module for the opensignalbox simulation framework."
+authors = [
+    { name = "The openSignalBox project", email = "info@opensignalbox.org" },
+]
+maintainers = [{ name = "Laurence Stant", email = "laurence@stant.phd" }]
+dependencies = ["fastapi>=0.110.0"]
+readme = "README.md"
+requires-python = ">= 3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://opensignalbox.org/"
+"Repository" = "https://github.com/opensignalbox/opensignalbox"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project.scripts]
+opensignalbox-ui-web = 'opensignalbox.ui.web.main:entry_point'
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/opensignalbox"]

opensignalbox_ui_web-0.1.0/src/opensignalbox/ui/web/__init__.py

@@ -0,0 +1 @@
+__doc__ = "openSignalBox webui module."

opensignalbox_ui_web-0.1.0/src/opensignalbox/ui/web/main.py

@@ -0,0 +1,72 @@
+from anyio import run
+from opensignalbox.common.modules import BaseModule, ModuleInfo, module_argparser
+
+from .routes import webui_api_router
+from .version import __version__
+
+
+class Module(BaseModule):
+    module_name = "opensignalbox-ui-web"
+    module_file = __file__
+
+    def __init__(
+        self,
+        module_info: ModuleInfo,
+    ) -> None:
+        super().__init__(
+            module_info=module_info,
+        )
+        self.fastapi_app.include_router(webui_api_router, prefix="/api")
+
+    def setup(self) -> None:
+        """
+        Module startup code goes here after the super call.
+        """
+        super().setup()
+
+    def systick_update(self, tick_json: str) -> None:
+        """
+        Module update logic goes here, executed once per clock tick.
+        """
+        # await macro_loop()
+        super().systick_update(tick_json)
+
+    async def user_task(self) -> None:
+        pass
+
+    def teardown(self) -> None:
+        """
+        Module teardown code goes here.
+        """
+        pass
+
+    def load_state(self) -> None:
+        return super().load_state()
+
+    def save_state(self) -> None:
+        return super().save_state()
+
+
+args = module_argparser()
+instance_name: str = args.name
+
+module_info = ModuleInfo(
+    instance_name=args.name,
+    module_name=Module.module_name,
+    version=__version__,
+    address=args.address,
+    port=args.port,
+    session_id=args.session_id,
+    framework_address=args.framework_address,
+    config_path=args.configdir,
+)
+module = Module(module_info=module_info)
+module.setup()
+
+
+def entry_point():
+    run(module.run, backend="trio")
+
+
+if __name__ == "__main__":
+    entry_point()

opensignalbox_ui_web-0.1.0/src/opensignalbox/ui/web/routes.py

@@ -0,0 +1,3 @@
+from fastapi.routing import APIRouter
+
+webui_api_router = APIRouter()

opensignalbox_ui_web-0.1.0/src/opensignalbox/ui/web/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

opensignalbox_ui_web-0.1.0/src/opensignalbox/ui/web/web_ui/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+#dist
+#dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

opensignalbox_ui_web-0.1.0/src/opensignalbox/ui/web/web_ui/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["Vue.volar"]
+}

opensignalbox_ui_web-0.1.0/src/opensignalbox/ui/web/web_ui/README.md

@@ -0,0 +1,9 @@
+# Vue 3 + TypeScript + Vite
+
+This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+
+## Recommended Setup
+
+- [VS Code](https://code.visualstudio.com/) + [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (previously Volar) and disable Vetur
+
+- Use [vue-tsc](https://github.com/vuejs/language-tools/tree/master/packages/tsc) for performing the same type checking from the command line, or for generating d.ts files for SFCs.

opensignalbox_ui_web-0.1.0/src/opensignalbox/ui/web/web_ui/components.json

@@ -0,0 +1,14 @@
+{
+  "style": "default",
+  "tailwind": {
+    "config": "tailwind.config.js",
+    "css": "src/app/globals.css",
+    "baseColor": "neutral",
+    "cssVariables": true
+  },
+  "typescript": true,
+  "aliases": {
+    "utils": "@/libs/utils",
+    "components": "@/components"
+  }
+}