station-appkit 1.0.0__tar.gz

station_appkit-1.0.0/.gitignore

@@ -0,0 +1,62 @@
+__pycache__/
+*.pyc
+*.pyo
+.pytest_cache/
+.venv/
+venv/
+*.db
+*.db-journal
+*.db-wal
+*.db-shm
+.DS_Store
+node_modules/
+.svelte-kit/
+web/build/
+dist/
+build/
+*.egg-info/
+.env
+.env.local
+
+# User-dropped iTunes XML exports (large, not repo content)
+from_user/*
+!from_user/README.md
+
+# Generated iTunes XML exports (default disk-export destination)
+out/
+output/
+
+# Playwright
+web/test-results/
+web/playwright-report/
+test-results/
+playwright-report/
+playwright-test.*.db
+playwright-test.*.db-wal
+playwright-test.*.db-shm
+playwright-stations.*/
+
+# Coverage output (.coverage.* = per-process files before `coverage combine`)
+.coverage
+.coverage.*
+web/coverage/
+
+# Database backups (DESIGN.md §14.18). User-data; never repo content.
+backups/
+.claude/
+
+# §16.15 c1 — MkDocs build output. Source lives in docs/; the
+# rendered HTML/CSS/JS lands in site/ and is published to GH Pages
+# via the docs workflow, never committed to main.
+site/
+# §16.15 c4 — OpenAPI dump consumed by mkdocs-render-swagger-plugin.
+# Regenerated by `make docs-openapi` (chained from docs-build +
+# docs-serve); committing would risk drift between the JSON and
+# the FastAPI app's actual schema.
+docs/reference/openapi.json
+# §16.15 c5 — CLI --help dump consumed by the docs build.
+# Regenerated by `make docs-cli`; same drift logic as openapi.json.
+docs/reference/cli.md
+
+# ffmpeg fetched for the Station Server downloads (server-installers.yml)
+server/packaging/ffmpeg/

station_appkit-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-2026 Raby Whyte
+
+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.

station_appkit-1.0.0/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.5
+Name: station-appkit
+Version: 1.0.0
+Summary: Update check, self-updater and app window shared by Station Studio, Station Player and Station Server
+Project-URL: Homepage, https://github.com/raby/station-studio
+Project-URL: Repository, https://github.com/raby/station-studio
+Author-email: Raby Whyte <rabywhyte@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025-2026 Raby Whyte
+        
+        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.
+License-File: LICENSE
+Keywords: desktop,station-studio,updater
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# station-appkit
+
+What [Station Studio](https://github.com/raby/station-studio), Station
+Player and Station Server share as desktop apps, so each is written once:
+
+- **The new-version check** (`station_appkit.updates`): asks GitHub, at
+  most once a day, for the app's newest release (`studio-v*`,
+  `player-v*`, `server-v*`). Only release names are fetched.
+- **The self-updater** (`station_appkit.selfupdate`): Update now in the
+  downloaded Mac and Windows apps. The new version's installer is used
+  only when its size and SHA-256 match what GitHub publishes for that
+  file, and only from the project's own releases.
+- **The app window** (`station_appkit.window`): a Chrome, Edge or Brave
+  app window with its own profile, or a browser tab; and on the Mac
+  (`station_appkit.macwindow`, needs PyObjC) the downloaded app's own
+  WebKit window, with its menus, Dock icon and downloads.
+
+Each app describes itself once (`station_appkit.App`: its name, release
+tag, port and so on) and passes that in. Standard library only.
+
+It isn't meant for use outside these apps; it's published so they can be
+installed with pip or pipx. MIT licensed.

station_appkit-1.0.0/README.md

@@ -0,0 +1,22 @@
+# station-appkit
+
+What [Station Studio](https://github.com/raby/station-studio), Station
+Player and Station Server share as desktop apps, so each is written once:
+
+- **The new-version check** (`station_appkit.updates`): asks GitHub, at
+  most once a day, for the app's newest release (`studio-v*`,
+  `player-v*`, `server-v*`). Only release names are fetched.
+- **The self-updater** (`station_appkit.selfupdate`): Update now in the
+  downloaded Mac and Windows apps. The new version's installer is used
+  only when its size and SHA-256 match what GitHub publishes for that
+  file, and only from the project's own releases.
+- **The app window** (`station_appkit.window`): a Chrome, Edge or Brave
+  app window with its own profile, or a browser tab; and on the Mac
+  (`station_appkit.macwindow`, needs PyObjC) the downloaded app's own
+  WebKit window, with its menus, Dock icon and downloads.
+
+Each app describes itself once (`station_appkit.App`: its name, release
+tag, port and so on) and passes that in. Standard library only.
+
+It isn't meant for use outside these apps; it's published so they can be
+installed with pip or pipx. MIT licensed.

station_appkit-1.0.0/pyproject.toml

@@ -0,0 +1,44 @@
+# station-appkit: what Station Studio, Station Player and Station Server
+# share as desktop apps. The new-version check, the self-updater (download,
+# SHA-256 check, install) and the app window: a Chrome or Edge app window,
+# or on the Mac the app's own WebKit window. Standard library only (the
+# Mac window needs PyObjC, which only the downloaded Mac apps carry).
+#
+# In this repo the three apps use it from appkit/ (a uv workspace member);
+# the Mac and Windows downloads bundle it from here. Each app's Publish
+# workflow puts this version on PyPI first if it isn't there yet, so a
+# `pipx install station-player` (say) finds it.
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "station-appkit"
+version = "1.0.0"
+description = "Update check, self-updater and app window shared by Station Studio, Station Player and Station Server"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.11"
+authors = [
+    { name = "Raby Whyte", email = "rabywhyte@gmail.com" },
+]
+keywords = ["station-studio", "updater", "desktop"]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/raby/station-studio"
+Repository = "https://github.com/raby/station-studio"
+
+# For working on it, not installed with it.
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-github-actions-annotate-failures>=0.4.2",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["station_appkit"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

station_appkit-1.0.0/station_appkit/__init__.py

@@ -0,0 +1,65 @@
+"""What Station Studio, Station Player and Station Server share as desktop
+apps: the new-version check (updates), the self-updater (selfupdate) and
+the app window (window, and on the Mac macwindow).
+
+Each app describes itself once, as an `App`, and hands that in.
+"""
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+__version__ = "1.0.0"
+
+REPO = "raby/station-studio"
+
+
+@dataclass(frozen=True)
+class App:
+    """One of the three apps, as the shared code needs to know it."""
+
+    name: str
+    """In words: "Station Studio"."""
+    slug: str
+    """Without the space: "StationStudio". Names the downloads
+    (StationStudio-1.2.0-windows-setup.exe), the user agent and the
+    Mac window's user agent (StationStudioApp/1.2.0)."""
+    tag_prefix: str
+    """Its releases' tags: "studio-v"."""
+    version: str
+    """The version running."""
+    port: int
+    """The port it serves on unless told otherwise."""
+    mac_helper: str = ""
+    """The Mac app's helper (Contents/MacOS/<this>), which runs the server;
+    the app the Finder opens is its window."""
+    env_prefix: str = ""
+    """"STATION_STUDIO": STATION_STUDIO_INSPECT, STATION_STUDIO_SELFTEST."""
+    window_size: tuple[int, int] = (1280, 860)
+    """The app window's first size."""
+    browser_args: tuple[str, ...] = field(default=())
+    """More flags for the Chrome or Edge app window."""
+    repo: str = REPO
+
+    @property
+    def default_url(self) -> str:
+        return f"http://127.0.0.1:{self.port}/"
+
+    @property
+    def releases_api(self) -> str:
+        return f"https://api.github.com/repos/{self.repo}/releases?per_page=100"
+
+    def release_api(self, version: str) -> str:
+        return f"https://api.github.com/repos/{self.repo}/releases/tags/{self.tag_prefix}{version}"
+
+    def release_page(self, version: str) -> str:
+        return f"https://github.com/{self.repo}/releases/tag/{self.tag_prefix}{version}"
+
+    @property
+    def download_prefix(self) -> str:
+        """Only files from the project's own releases are used."""
+        return f"https://github.com/{self.repo}/releases/download/"
+
+    @property
+    def temp_prefix(self) -> str:
+        """"station-studio": for temporary folders."""
+        return self.name.lower().replace(" ", "-")