pyobs-gui 2.0.0.dev20__tar.gz → 2.0.0.dev21__tar.gz

{pyobs_gui-2.0.0.dev20 → pyobs_gui-2.0.0.dev21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyobs-gui
-Version: 2.0.0.dev20
+Version: 2.0.0.dev21
 Summary: A remote GUI for pyobs
 Author-email: Tim-Oliver Husser <thusser@uni-goettingen.de>
 License-Expression: MIT

pyobs_gui-2.0.0.dev21/README.md

@@ -0,0 +1,28 @@
+pyobs-gui
+=========
+
+This is a [pyobs](https://www.pyobs.org) GUI for operating the whole system: one page per
+connected module (camera, telescope, roof, focuser, ...), plus Shell/Events/Status tool pages.
+
+
+Install *pyobs-gui*
+---------------------
+Clone the repository:
+
+    git clone https://github.com/pyobs/pyobs-gui.git
+    cd pyobs-gui
+
+Install it with [uv](https://docs.astral.sh/uv/):
+
+    uv sync
+
+
+Running
+-------
+Two ways to start it:
+
+- `uv run pyobs-gui` — standalone, interactive login. No YAML config needed; it prompts for XMPP
+  credentials (with an optional "store password") and connects directly.
+- `uv run pyobs <config.yaml>` — the standard `pyobs` CLI, driven by a config file whose top-level
+  class is `pyobs_gui.GUI` (see `docs/source/index.rst` for a full example, including how to wire
+  in a custom widget for a module).

pyobs_gui-2.0.0.dev21/docs/source/index.rst

@@ -0,0 +1,140 @@
+pyobs-gui
+#########
+
+This is a `pyobs <https://www.pyobs.org>`_ (`documentation <https://docs.pyobs.org>`_) module providing a GUI
+for operating the whole system.
+
+
+Example configuration
+**********************
+
+This is an example configuration for a GUI that defines one custom widget for the ``guiding`` module::
+
+    class: pyobs_gui.GUI
+
+    widgets:
+      - module: guiding
+        overwrite: True
+        widget:
+          class: mypackage.GuidingWidget
+
+    comm:
+      jid: test@example.com
+      password: ***
+
+    timezone: Europe/Berlin
+    location:
+      longitude: 9.944333
+      latitude: 51.560583
+      elevation: 201.
+
+    vfs:
+      class: pyobs.vfs.VirtualFileSystem
+      roots:
+        cache:
+          class: pyobs.vfs.HttpFile
+          download: http://localhost:37075/
+        webcam:
+          class: pyobs.vfs.HttpFile
+          download: http://localhost:37077/
+
+
+Available classes
+******************
+
+There is one single class for the GUI.
+
+GUI
+===
+.. autoclass:: pyobs_gui.GUI
+   :members:
+   :show-inheritance:
+
+
+Widgets
+*******
+
+The GUI shows one page per connected module, picking a widget by the module's interfaces
+(``DEFAULT_WIDGETS`` in ``mainwindow.py``), plus three always-present "Tools" pages. No screenshots
+yet — this section was written from source, not from a running GUI; add screenshots as a follow-up.
+
+Shell
+=====
+Always present. A command console: type shell-like commands against any connected module, with
+tab-completion driven by the module's own docstrings, and a per-module command history.
+
+Events
+======
+Always present. Live feed of events broadcast by connected modules, and lets you send one back.
+
+Status
+======
+Always present. Per-module connection/presence indicator plus a live, expandable tree of each
+connected module's published state.
+
+Camera — drives ``ICamera``
+============================
+Expose/abort control: binning, gain, image format/type, exposure time, full-frame vs. windowed
+readout, and (if the module supports it) data sequences.
+
+Telescope — drives ``ITelescope``
+====================================
+Init/park/stop and move-to-target, offsets in both RA/Dec and Alt/Az, Simbad and JPL Horizons
+target lookup, and tracking of orbital elements or solar-system bodies.
+
+Roof — drives ``IRoof``
+==========================
+Open/close/stop the roof, with live motion and pointing state.
+
+Focuser — drives ``IFocuser``
+================================
+Set an absolute focus value, apply/reset a focus offset.
+
+Auto Focus — drives ``IAutoFocus``
+=====================================
+Run or abort an autofocus sequence.
+
+Acquisition — drives ``IAcquisition``
+========================================
+Acquire a target, abort an in-progress acquisition.
+
+Auto Guiding — drives ``IAutoGuiding``
+=========================================
+Start/stop guiding and set the guide-exposure time.
+
+Weather — drives ``IWeather``
+================================
+Live sensor values plus a history plot.
+
+Video — drives ``IVideo``
+============================
+Live view (MJPEG/raw stream), grab a still, adjust exposure time/gain/image type.
+
+Spectrograph — drives ``ISpectrograph``
+==========================================
+Grab a spectrum, abort an in-progress exposure.
+
+Filter wheel — drives ``IFilters``
+=====================================
+Set the active filter.
+
+
+Keyboard shortcuts
+*******************
+
+Global, not per-widget — bound with the ``Ctrl``/``Ctrl+Alt`` modifier specifically so no
+text/numeric-entry widget can mistake one for ordinary input.
+
+===============  ==========================================================
+Shortcut          Action
+===============  ==========================================================
+``Ctrl+1``        Switch to Shell (fixed)
+``Ctrl+2``        Switch to Events (fixed)
+``Ctrl+3``        Switch to Status (fixed)
+``Ctrl+4``..``Ctrl+9``, ``Ctrl+0``
+                  Switch to whichever module page is bound to that slot
+                  (no-op if unbound or that module isn't connected)
+``Ctrl+Alt+4``..``Ctrl+Alt+9``, ``Ctrl+Alt+0``
+                  Bind the currently selected page to that slot, overwriting
+                  any previous binding
+===============  ==========================================================

{pyobs_gui-2.0.0.dev20 → pyobs_gui-2.0.0.dev21}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyobs-gui"
-version = "2.0.0.dev20"
+version = "2.0.0.dev21"
 description = "A remote GUI for pyobs"
 authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }]
 requires-python = ">=3.11"
@@ -32,8 +32,8 @@ dev = [
     "pandas-stubs>=2.3.0.250703",
     "pre-commit>=4.2.0,<5",
     "pyside6-stubs>=6.7.3.0",
-    "sphinx-rtd-theme>=3.0.2,<4",
-    "Sphinx>=8.2.3,<9",
+    "sphinx-rtd-theme>=3.0.2",
+    "Sphinx>=8.2.3",
     "types-defusedxml>=0.7.0.20250708",
     "types-python-dateutil>=2.9.0.20250708",
     "pytest>=9.1.1",

{pyobs_gui-2.0.0.dev20 → pyobs_gui-2.0.0.dev21}/uv.lock

@@ -3295,7 +3295,7 @@ wheels = [
 
 [[package]]
 name = "pyobs-gui"
-version = "2.0.0.dev20"
+version = "2.0.0.dev21"
 source = { editable = "." }
 dependencies = [
     { name = "astroplan" },
@@ -3325,7 +3325,8 @@ dev = [
     { name = "pytest-asyncio" },
     { name = "pytest-mock" },
     { name = "ruff" },
-    { name = "sphinx" },
+    { name = "sphinx", version = "9.0.4", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
+    { name = "sphinx", version = "9.1.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.12'" },
     { name = "sphinx-rtd-theme" },
     { name = "types-defusedxml" },
     { name = "types-python-dateutil" },
@@ -3359,8 +3360,8 @@ dev = [
     { name = "pytest-asyncio", specifier = ">=1.4.0" },
     { name = "pytest-mock", specifier = ">=3.15.1" },
     { name = "ruff", specifier = ">=0.11.0" },
-    { name = "sphinx", specifier = ">=8.2.3,<9" },
-    { name = "sphinx-rtd-theme", specifier = ">=3.0.2,<4" },
+    { name = "sphinx", specifier = ">=8.2.3" },
+    { name = "sphinx-rtd-theme", specifier = ">=3.0.2" },
     { name = "types-defusedxml", specifier = ">=0.7.0.20250708" },
     { name = "types-python-dateutil", specifier = ">=2.9.0.20250708" },
 ]
@@ -3778,18 +3779,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/04/54/6f679c435d28e0a568d8e8a7c0a93a09010818634c3c3907fc98d8983770/roman_numerals-4.1.0-py3-none-any.whl", hash = "sha256:647ba99caddc2cc1e55a51e4360689115551bf4476d90e8162cf8c345fe233c7", size = 7676, upload-time = "2025-12-17T18:25:33.098Z" },
 ]
 
-[[package]]
-name = "roman-numerals-py"
-version = "4.1.0"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
-    { name = "roman-numerals" },
-]
-sdist = { url = "https://files.pythonhosted.org/packages/cb/b5/de96fca640f4f656eb79bbee0e79aeec52e3e0e359f8a3e6a0d366378b64/roman_numerals_py-4.1.0.tar.gz", hash = "sha256:f5d7b2b4ca52dd855ef7ab8eb3590f428c0b1ea480736ce32b01fef2a5f8daf9", size = 4274, upload-time = "2025-12-17T18:25:41.153Z" }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/27/2c/daca29684cbe9fd4bc711f8246da3c10adca1ccc4d24436b17572eb2590e/roman_numerals_py-4.1.0-py3-none-any.whl", hash = "sha256:553114c1167141c1283a51743759723ecd05604a1b6b507225e91dc1a6df0780", size = 4547, upload-time = "2025-12-17T18:25:40.136Z" },
-]
-
 [[package]]
 name = "ruff"
 version = "0.16.2"
@@ -4132,30 +4121,74 @@ wheels = [
 
 [[package]]
 name = "sphinx"
-version = "8.2.3"
+version = "9.0.4"
 source = { registry = "https://pypi.org/simple" }
+resolution-markers = [
+    "python_full_version < '3.12' and sys_platform == 'win32'",
+    "python_full_version < '3.12' and sys_platform == 'emscripten'",
+    "python_full_version < '3.12' and sys_platform != 'emscripten' and sys_platform != 'win32'",
+]
 dependencies = [
-    { name = "alabaster" },
-    { name = "babel" },
-    { name = "colorama", marker = "sys_platform == 'win32'" },
-    { name = "docutils" },
-    { name = "imagesize" },
-    { name = "jinja2" },
-    { name = "packaging" },
-    { name = "pygments" },
-    { name = "requests" },
-    { name = "roman-numerals-py" },
-    { name = "snowballstemmer" },
-    { name = "sphinxcontrib-applehelp" },
-    { name = "sphinxcontrib-devhelp" },
-    { name = "sphinxcontrib-htmlhelp" },
-    { name = "sphinxcontrib-jsmath" },
-    { name = "sphinxcontrib-qthelp" },
-    { name = "sphinxcontrib-serializinghtml" },
+    { name = "alabaster", marker = "python_full_version < '3.12'" },
+    { name = "babel", marker = "python_full_version < '3.12'" },
+    { name = "colorama", marker = "python_full_version < '3.12' and sys_platform == 'win32'" },
+    { name = "docutils", marker = "python_full_version < '3.12'" },
+    { name = "imagesize", marker = "python_full_version < '3.12'" },
+    { name = "jinja2", marker = "python_full_version < '3.12'" },
+    { name = "packaging", marker = "python_full_version < '3.12'" },
+    { name = "pygments", marker = "python_full_version < '3.12'" },
+    { name = "requests", marker = "python_full_version < '3.12'" },
+    { name = "roman-numerals", marker = "python_full_version < '3.12'" },
+    { name = "snowballstemmer", marker = "python_full_version < '3.12'" },
+    { name = "sphinxcontrib-applehelp", marker = "python_full_version < '3.12'" },
+    { name = "sphinxcontrib-devhelp", marker = "python_full_version < '3.12'" },
+    { name = "sphinxcontrib-htmlhelp", marker = "python_full_version < '3.12'" },
+    { name = "sphinxcontrib-jsmath", marker = "python_full_version < '3.12'" },
+    { name = "sphinxcontrib-qthelp", marker = "python_full_version < '3.12'" },
+    { name = "sphinxcontrib-serializinghtml", marker = "python_full_version < '3.12'" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/42/50/a8c6ccc36d5eacdfd7913ddccd15a9cee03ecafc5ee2bc40e1f168d85022/sphinx-9.0.4.tar.gz", hash = "sha256:594ef59d042972abbc581d8baa577404abe4e6c3b04ef61bd7fc2acbd51f3fa3", size = 8710502, upload-time = "2025-12-04T07:45:27.343Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/c6/3f/4bbd76424c393caead2e1eb89777f575dee5c8653e2d4b6afd7a564f5974/sphinx-9.0.4-py3-none-any.whl", hash = "sha256:5bebc595a5e943ea248b99c13814c1c5e10b3ece718976824ffa7959ff95fffb", size = 3917713, upload-time = "2025-12-04T07:45:24.944Z" },
+]
+
+[[package]]
+name = "sphinx"
+version = "9.1.0"
+source = { registry = "https://pypi.org/simple" }
+resolution-markers = [
+    "python_full_version == '3.14.*' and sys_platform == 'win32'",
+    "python_full_version == '3.14.*' and sys_platform == 'emscripten'",
+    "python_full_version == '3.14.*' and sys_platform != 'emscripten' and sys_platform != 'win32'",
+    "python_full_version >= '3.15' and sys_platform == 'win32'",
+    "python_full_version >= '3.15' and sys_platform == 'emscripten'",
+    "python_full_version >= '3.15' and sys_platform != 'emscripten' and sys_platform != 'win32'",
+    "python_full_version >= '3.12' and python_full_version < '3.14' and sys_platform == 'win32'",
+    "python_full_version >= '3.12' and python_full_version < '3.14' and sys_platform == 'emscripten'",
+    "python_full_version >= '3.12' and python_full_version < '3.14' and sys_platform != 'emscripten' and sys_platform != 'win32'",
+]
+dependencies = [
+    { name = "alabaster", marker = "python_full_version >= '3.12'" },
+    { name = "babel", marker = "python_full_version >= '3.12'" },
+    { name = "colorama", marker = "python_full_version >= '3.12' and sys_platform == 'win32'" },
+    { name = "docutils", marker = "python_full_version >= '3.12'" },
+    { name = "imagesize", marker = "python_full_version >= '3.12'" },
+    { name = "jinja2", marker = "python_full_version >= '3.12'" },
+    { name = "packaging", marker = "python_full_version >= '3.12'" },
+    { name = "pygments", marker = "python_full_version >= '3.12'" },
+    { name = "requests", marker = "python_full_version >= '3.12'" },
+    { name = "roman-numerals", marker = "python_full_version >= '3.12'" },
+    { name = "snowballstemmer", marker = "python_full_version >= '3.12'" },
+    { name = "sphinxcontrib-applehelp", marker = "python_full_version >= '3.12'" },
+    { name = "sphinxcontrib-devhelp", marker = "python_full_version >= '3.12'" },
+    { name = "sphinxcontrib-htmlhelp", marker = "python_full_version >= '3.12'" },
+    { name = "sphinxcontrib-jsmath", marker = "python_full_version >= '3.12'" },
+    { name = "sphinxcontrib-qthelp", marker = "python_full_version >= '3.12'" },
+    { name = "sphinxcontrib-serializinghtml", marker = "python_full_version >= '3.12'" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/38/ad/4360e50ed56cb483667b8e6dadf2d3fda62359593faabbe749a27c4eaca6/sphinx-8.2.3.tar.gz", hash = "sha256:398ad29dee7f63a75888314e9424d40f52ce5a6a87ae88e7071e80af296ec348", size = 8321876, upload-time = "2025-03-02T22:31:59.658Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/cd/bd/f08eb0f4eed5c83f1ba2a3bd18f7745a2b1525fad70660a1c00224ec468a/sphinx-9.1.0.tar.gz", hash = "sha256:7741722357dd75f8190766926071fed3bdc211c74dd2d7d4df5404da95930ddb", size = 8718324, upload-time = "2025-12-31T15:09:27.646Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/31/53/136e9eca6e0b9dc0e1962e2c908fbea2e5ac000c2a2fbd9a35797958c48b/sphinx-8.2.3-py3-none-any.whl", hash = "sha256:4405915165f13521d875a8c29c8970800a0141c14cc5416a38feca4ea5d9b9c3", size = 3589741, upload-time = "2025-03-02T22:31:56.836Z" },
+    { url = "https://files.pythonhosted.org/packages/73/f7/b1884cb3188ab181fc81fa00c266699dab600f927a964df02ec3d5d1916a/sphinx-9.1.0-py3-none-any.whl", hash = "sha256:c84fdd4e782504495fe4f2c0b3413d6c2bf388589bb352d439b2a3bb99991978", size = 3921742, upload-time = "2025-12-31T15:09:25.561Z" },
 ]
 
 [[package]]
@@ -4164,7 +4197,8 @@ version = "3.1.0"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "docutils" },
-    { name = "sphinx" },
+    { name = "sphinx", version = "9.0.4", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
+    { name = "sphinx", version = "9.1.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.12'" },
     { name = "sphinxcontrib-jquery" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/84/68/a1bfbf38c0f7bccc9b10bbf76b94606f64acb1552ae394f0b8285bfaea25/sphinx_rtd_theme-3.1.0.tar.gz", hash = "sha256:b44276f2c276e909239a4f6c955aa667aaafeb78597923b1c60babc76db78e4c", size = 7620915, upload-time = "2026-01-12T16:03:31.17Z" }
@@ -4204,7 +4238,8 @@ name = "sphinxcontrib-jquery"
 version = "4.1"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
-    { name = "sphinx" },
+    { name = "sphinx", version = "9.0.4", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
+    { name = "sphinx", version = "9.1.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.12'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/de/f3/aa67467e051df70a6330fe7770894b3e4f09436dea6881ae0b4f3d87cad8/sphinxcontrib-jquery-4.1.tar.gz", hash = "sha256:1620739f04e36a2c779f1a131a2dfd49b2fd07351bf1968ced074365933abc7a", size = 122331, upload-time = "2023-03-14T15:01:01.944Z" }
 wheels = [

pyobs_gui-2.0.0.dev20/README.md

@@ -1,3 +0,0 @@
-# pyobs-gui
-
-A GUI for pyobs.

pyobs_gui-2.0.0.dev20/docs/source/index.rst

@@ -1,51 +0,0 @@
-pyobs-gui
-#########
-
-This is a `pyobs <https://www.pyobs.org>`_ (`documentation <https://docs.pyobs.org>`_) module providing a GUI
-for operating the whole system.
-
-
-Example configuration
-*********************
-
-This is an example configuration for a GUI that defines one custom widget for the ``guiding`` module::
-
-    class: pyobs_gui.GUI
-
-    widgets:
-      - module: guiding
-        overwrite: True
-        widget:
-          class: mypackage.GuidingWidget
-
-    comm:
-      jid: test@example.com
-      password: ***
-
-    timezone: Europe/Berlin
-    location:
-      longitude: 9.944333
-      latitude: 51.560583
-      elevation: 201.
-
-    vfs:
-      class: pyobs.vfs.VirtualFileSystem
-      roots:
-        cache:
-          class: pyobs.vfs.HttpFile
-          download: http://localhost:37075/
-        webcam:
-          class: pyobs.vfs.HttpFile
-          download: http://localhost:37077/
-
-
-Available classes
-*****************
-
-There is one single class for the GUI.
-
-GUI
-===
-.. autoclass:: pyobs_gui.GUI
-   :members:
-   :show-inheritance: