MacroSignage 0.2.2__tar.gz → 0.2.3__tar.gz

{macrosignage-0.2.2/src/MacroSignage.egg-info → macrosignage-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MacroSignage
-Version: 0.2.2
+Version: 0.2.3
 Summary: Web-based Digital Signage System
 Author-email: Javier Baez <baezdevs@gmail.com>
 Maintainer-email: Javier Baez <baezdevs@gmail.com>
@@ -42,12 +42,12 @@ Dynamic: license-file
 
 [![PyPI version](https://img.shields.io/pypi/v/MacroSignage)](https://pypi.org/project/MacroSignage/)
 [![Python versions](https://img.shields.io/pypi/pyversions/MacroSignage)](https://pypi.org/project/MacroSignage/)
-[![License](https://img.shields.io/github/license/BaezFJ/MacroSignage)](LICENSE)
+[![License](https://img.shields.io/github/license/BaezFJ/MacroSignage)](https://github.com/BaezFJ/MacroSignage/blob/master/LICENSE)
 [![CI](https://github.com/BaezFJ/MacroSignage/actions/workflows/ci.yml/badge.svg)](https://github.com/BaezFJ/MacroSignage/actions/workflows/ci.yml)
 
 MacroSignage is a Flask-based digital signage manager with an admin console, token-secured display players, scheduling, media playback, REST API access, and a standalone pywebview display client.
 
-> **Status:** Pre-alpha v0.2.2. Data models and API contracts can change before v1.0.
+> **Status:** Pre-alpha v0.2.3. Data models and API contracts can change before v1.0.
 
 ## Features
 
@@ -98,7 +98,7 @@ MACROSIGNAGE_SESSION_COOKIE_SECURE=true \
 macrosignage-prod --host 127.0.0.1 --port 8080 --threads 4
 ```
 
-See [Deployment](docs/deployment.md) for systemd, Docker, HTTPS, health checks, backups, restore, and rollback.
+See [Deployment](https://github.com/BaezFJ/MacroSignage/blob/master/docs/deployment.md) for systemd, Docker, HTTPS, health checks, backups, restore, and rollback.
 
 ## Client Executables
 
@@ -108,26 +108,26 @@ Prebuilt standalone display client executables are available on the GitHub Relea
 https://github.com/BaezFJ/MacroSignage/releases
 ```
 
-The client source package lives in `client/`. See [Standalone Client](docs/client.md).
+The client source package lives in `client/`. See [Standalone Client](https://github.com/BaezFJ/MacroSignage/blob/master/docs/client.md).
 
 ## Documentation
 
-Start with [docs/index.md](docs/index.md).
+Start with [docs/index.md](https://github.com/BaezFJ/MacroSignage/blob/master/docs/index.md).
 
 Core guides:
 
-- [Installation](docs/installation.md)
-- [Configuration](docs/configuration.md)
-- [Auth and RBAC](docs/auth-rbac.md)
-- [Display Management and Player Pairing](docs/displays.md)
-- [Media Library](docs/media.md)
-- [Scheduling and Playback](docs/scheduling.md)
-- [REST API](docs/rest-api.md)
-- [API Tokens](docs/api-tokens.md)
-- [Deployment](docs/deployment.md)
-- [Troubleshooting](docs/troubleshooting.md)
-- [Development](docs/development.md)
-- [Architecture](docs/architecture.md)
+- [Installation](https://github.com/BaezFJ/MacroSignage/blob/master/docs/installation.md)
+- [Configuration](https://github.com/BaezFJ/MacroSignage/blob/master/docs/configuration.md)
+- [Auth and RBAC](https://github.com/BaezFJ/MacroSignage/blob/master/docs/auth-rbac.md)
+- [Display Management and Player Pairing](https://github.com/BaezFJ/MacroSignage/blob/master/docs/displays.md)
+- [Media Library](https://github.com/BaezFJ/MacroSignage/blob/master/docs/media.md)
+- [Scheduling and Playback](https://github.com/BaezFJ/MacroSignage/blob/master/docs/scheduling.md)
+- [REST API](https://github.com/BaezFJ/MacroSignage/blob/master/docs/rest-api.md)
+- [API Tokens](https://github.com/BaezFJ/MacroSignage/blob/master/docs/api-tokens.md)
+- [Deployment](https://github.com/BaezFJ/MacroSignage/blob/master/docs/deployment.md)
+- [Troubleshooting](https://github.com/BaezFJ/MacroSignage/blob/master/docs/troubleshooting.md)
+- [Development](https://github.com/BaezFJ/MacroSignage/blob/master/docs/development.md)
+- [Architecture](https://github.com/BaezFJ/MacroSignage/blob/master/docs/architecture.md)
 
 ## Development Commands
 
@@ -145,17 +145,17 @@ uv run twine check dist/*
 - CI runs on pull requests and pushes to `main`.
 - PyPI publishing runs when a `v*` tag is pushed.
 - Client executable build and release workflows produce Windows, macOS, and Linux assets.
-- Release documentation review is tracked in [the checklist](docs/release-documentation-checklist.md).
+- Release documentation review is tracked in [the checklist](https://github.com/BaezFJ/MacroSignage/blob/master/docs/release-documentation-checklist.md).
 
 ## v1.0 Remaining Work
 
-- [ ] Production-hardened and fully tested ([roadmap](docs/production-hardening-roadmap.md))
-- [x] Complete documentation ([roadmap](docs/documentation-roadmap.md))
+- [ ] Production-hardened and fully tested ([roadmap](https://github.com/BaezFJ/MacroSignage/blob/master/docs/production-hardening-roadmap.md))
+- [x] Complete documentation ([roadmap](https://github.com/BaezFJ/MacroSignage/blob/master/docs/documentation-roadmap.md))
 - [x] Deployment guides for Docker, systemd, health checks, backups, and rollback
 
 ## License
 
-MacroSignage is licensed under the MIT License. See [LICENSE](LICENSE).
+MacroSignage is licensed under the MIT License. See [LICENSE](https://github.com/BaezFJ/MacroSignage/blob/master/LICENSE).
 
 Copyright (c) 2022 Javier Baez
 

{macrosignage-0.2.2 → macrosignage-0.2.3}/README.md

@@ -2,12 +2,12 @@
 
 [![PyPI version](https://img.shields.io/pypi/v/MacroSignage)](https://pypi.org/project/MacroSignage/)
 [![Python versions](https://img.shields.io/pypi/pyversions/MacroSignage)](https://pypi.org/project/MacroSignage/)
-[![License](https://img.shields.io/github/license/BaezFJ/MacroSignage)](LICENSE)
+[![License](https://img.shields.io/github/license/BaezFJ/MacroSignage)](https://github.com/BaezFJ/MacroSignage/blob/master/LICENSE)
 [![CI](https://github.com/BaezFJ/MacroSignage/actions/workflows/ci.yml/badge.svg)](https://github.com/BaezFJ/MacroSignage/actions/workflows/ci.yml)
 
 MacroSignage is a Flask-based digital signage manager with an admin console, token-secured display players, scheduling, media playback, REST API access, and a standalone pywebview display client.
 
-> **Status:** Pre-alpha v0.2.2. Data models and API contracts can change before v1.0.
+> **Status:** Pre-alpha v0.2.3. Data models and API contracts can change before v1.0.
 
 ## Features
 
@@ -58,7 +58,7 @@ MACROSIGNAGE_SESSION_COOKIE_SECURE=true \
 macrosignage-prod --host 127.0.0.1 --port 8080 --threads 4
 ```
 
-See [Deployment](docs/deployment.md) for systemd, Docker, HTTPS, health checks, backups, restore, and rollback.
+See [Deployment](https://github.com/BaezFJ/MacroSignage/blob/master/docs/deployment.md) for systemd, Docker, HTTPS, health checks, backups, restore, and rollback.
 
 ## Client Executables
 
@@ -68,26 +68,26 @@ Prebuilt standalone display client executables are available on the GitHub Relea
 https://github.com/BaezFJ/MacroSignage/releases
 ```
 
-The client source package lives in `client/`. See [Standalone Client](docs/client.md).
+The client source package lives in `client/`. See [Standalone Client](https://github.com/BaezFJ/MacroSignage/blob/master/docs/client.md).
 
 ## Documentation
 
-Start with [docs/index.md](docs/index.md).
+Start with [docs/index.md](https://github.com/BaezFJ/MacroSignage/blob/master/docs/index.md).
 
 Core guides:
 
-- [Installation](docs/installation.md)
-- [Configuration](docs/configuration.md)
-- [Auth and RBAC](docs/auth-rbac.md)
-- [Display Management and Player Pairing](docs/displays.md)
-- [Media Library](docs/media.md)
-- [Scheduling and Playback](docs/scheduling.md)
-- [REST API](docs/rest-api.md)
-- [API Tokens](docs/api-tokens.md)
-- [Deployment](docs/deployment.md)
-- [Troubleshooting](docs/troubleshooting.md)
-- [Development](docs/development.md)
-- [Architecture](docs/architecture.md)
+- [Installation](https://github.com/BaezFJ/MacroSignage/blob/master/docs/installation.md)
+- [Configuration](https://github.com/BaezFJ/MacroSignage/blob/master/docs/configuration.md)
+- [Auth and RBAC](https://github.com/BaezFJ/MacroSignage/blob/master/docs/auth-rbac.md)
+- [Display Management and Player Pairing](https://github.com/BaezFJ/MacroSignage/blob/master/docs/displays.md)
+- [Media Library](https://github.com/BaezFJ/MacroSignage/blob/master/docs/media.md)
+- [Scheduling and Playback](https://github.com/BaezFJ/MacroSignage/blob/master/docs/scheduling.md)
+- [REST API](https://github.com/BaezFJ/MacroSignage/blob/master/docs/rest-api.md)
+- [API Tokens](https://github.com/BaezFJ/MacroSignage/blob/master/docs/api-tokens.md)
+- [Deployment](https://github.com/BaezFJ/MacroSignage/blob/master/docs/deployment.md)
+- [Troubleshooting](https://github.com/BaezFJ/MacroSignage/blob/master/docs/troubleshooting.md)
+- [Development](https://github.com/BaezFJ/MacroSignage/blob/master/docs/development.md)
+- [Architecture](https://github.com/BaezFJ/MacroSignage/blob/master/docs/architecture.md)
 
 ## Development Commands
 
@@ -105,17 +105,17 @@ uv run twine check dist/*
 - CI runs on pull requests and pushes to `main`.
 - PyPI publishing runs when a `v*` tag is pushed.
 - Client executable build and release workflows produce Windows, macOS, and Linux assets.
-- Release documentation review is tracked in [the checklist](docs/release-documentation-checklist.md).
+- Release documentation review is tracked in [the checklist](https://github.com/BaezFJ/MacroSignage/blob/master/docs/release-documentation-checklist.md).
 
 ## v1.0 Remaining Work
 
-- [ ] Production-hardened and fully tested ([roadmap](docs/production-hardening-roadmap.md))
-- [x] Complete documentation ([roadmap](docs/documentation-roadmap.md))
+- [ ] Production-hardened and fully tested ([roadmap](https://github.com/BaezFJ/MacroSignage/blob/master/docs/production-hardening-roadmap.md))
+- [x] Complete documentation ([roadmap](https://github.com/BaezFJ/MacroSignage/blob/master/docs/documentation-roadmap.md))
 - [x] Deployment guides for Docker, systemd, health checks, backups, and rollback
 
 ## License
 
-MacroSignage is licensed under the MIT License. See [LICENSE](LICENSE).
+MacroSignage is licensed under the MIT License. See [LICENSE](https://github.com/BaezFJ/MacroSignage/blob/master/LICENSE).
 
 Copyright (c) 2022 Javier Baez
 

{macrosignage-0.2.2 → macrosignage-0.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "MacroSignage"
-version = "0.2.2"
+version = "0.2.3"
 description = "Web-based Digital Signage System"
 readme = "README.md"
 license = "MIT"

{macrosignage-0.2.2 → macrosignage-0.2.3/src/MacroSignage.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MacroSignage
-Version: 0.2.2
+Version: 0.2.3
 Summary: Web-based Digital Signage System
 Author-email: Javier Baez <baezdevs@gmail.com>
 Maintainer-email: Javier Baez <baezdevs@gmail.com>
@@ -42,12 +42,12 @@ Dynamic: license-file
 
 [![PyPI version](https://img.shields.io/pypi/v/MacroSignage)](https://pypi.org/project/MacroSignage/)
 [![Python versions](https://img.shields.io/pypi/pyversions/MacroSignage)](https://pypi.org/project/MacroSignage/)
-[![License](https://img.shields.io/github/license/BaezFJ/MacroSignage)](LICENSE)
+[![License](https://img.shields.io/github/license/BaezFJ/MacroSignage)](https://github.com/BaezFJ/MacroSignage/blob/master/LICENSE)
 [![CI](https://github.com/BaezFJ/MacroSignage/actions/workflows/ci.yml/badge.svg)](https://github.com/BaezFJ/MacroSignage/actions/workflows/ci.yml)
 
 MacroSignage is a Flask-based digital signage manager with an admin console, token-secured display players, scheduling, media playback, REST API access, and a standalone pywebview display client.
 
-> **Status:** Pre-alpha v0.2.2. Data models and API contracts can change before v1.0.
+> **Status:** Pre-alpha v0.2.3. Data models and API contracts can change before v1.0.
 
 ## Features
 
@@ -98,7 +98,7 @@ MACROSIGNAGE_SESSION_COOKIE_SECURE=true \
 macrosignage-prod --host 127.0.0.1 --port 8080 --threads 4
 ```
 
-See [Deployment](docs/deployment.md) for systemd, Docker, HTTPS, health checks, backups, restore, and rollback.
+See [Deployment](https://github.com/BaezFJ/MacroSignage/blob/master/docs/deployment.md) for systemd, Docker, HTTPS, health checks, backups, restore, and rollback.
 
 ## Client Executables
 
@@ -108,26 +108,26 @@ Prebuilt standalone display client executables are available on the GitHub Relea
 https://github.com/BaezFJ/MacroSignage/releases
 ```
 
-The client source package lives in `client/`. See [Standalone Client](docs/client.md).
+The client source package lives in `client/`. See [Standalone Client](https://github.com/BaezFJ/MacroSignage/blob/master/docs/client.md).
 
 ## Documentation
 
-Start with [docs/index.md](docs/index.md).
+Start with [docs/index.md](https://github.com/BaezFJ/MacroSignage/blob/master/docs/index.md).
 
 Core guides:
 
-- [Installation](docs/installation.md)
-- [Configuration](docs/configuration.md)
-- [Auth and RBAC](docs/auth-rbac.md)
-- [Display Management and Player Pairing](docs/displays.md)
-- [Media Library](docs/media.md)
-- [Scheduling and Playback](docs/scheduling.md)
-- [REST API](docs/rest-api.md)
-- [API Tokens](docs/api-tokens.md)
-- [Deployment](docs/deployment.md)
-- [Troubleshooting](docs/troubleshooting.md)
-- [Development](docs/development.md)
-- [Architecture](docs/architecture.md)
+- [Installation](https://github.com/BaezFJ/MacroSignage/blob/master/docs/installation.md)
+- [Configuration](https://github.com/BaezFJ/MacroSignage/blob/master/docs/configuration.md)
+- [Auth and RBAC](https://github.com/BaezFJ/MacroSignage/blob/master/docs/auth-rbac.md)
+- [Display Management and Player Pairing](https://github.com/BaezFJ/MacroSignage/blob/master/docs/displays.md)
+- [Media Library](https://github.com/BaezFJ/MacroSignage/blob/master/docs/media.md)
+- [Scheduling and Playback](https://github.com/BaezFJ/MacroSignage/blob/master/docs/scheduling.md)
+- [REST API](https://github.com/BaezFJ/MacroSignage/blob/master/docs/rest-api.md)
+- [API Tokens](https://github.com/BaezFJ/MacroSignage/blob/master/docs/api-tokens.md)
+- [Deployment](https://github.com/BaezFJ/MacroSignage/blob/master/docs/deployment.md)
+- [Troubleshooting](https://github.com/BaezFJ/MacroSignage/blob/master/docs/troubleshooting.md)
+- [Development](https://github.com/BaezFJ/MacroSignage/blob/master/docs/development.md)
+- [Architecture](https://github.com/BaezFJ/MacroSignage/blob/master/docs/architecture.md)
 
 ## Development Commands
 
@@ -145,17 +145,17 @@ uv run twine check dist/*
 - CI runs on pull requests and pushes to `main`.
 - PyPI publishing runs when a `v*` tag is pushed.
 - Client executable build and release workflows produce Windows, macOS, and Linux assets.
-- Release documentation review is tracked in [the checklist](docs/release-documentation-checklist.md).
+- Release documentation review is tracked in [the checklist](https://github.com/BaezFJ/MacroSignage/blob/master/docs/release-documentation-checklist.md).
 
 ## v1.0 Remaining Work
 
-- [ ] Production-hardened and fully tested ([roadmap](docs/production-hardening-roadmap.md))
-- [x] Complete documentation ([roadmap](docs/documentation-roadmap.md))
+- [ ] Production-hardened and fully tested ([roadmap](https://github.com/BaezFJ/MacroSignage/blob/master/docs/production-hardening-roadmap.md))
+- [x] Complete documentation ([roadmap](https://github.com/BaezFJ/MacroSignage/blob/master/docs/documentation-roadmap.md))
 - [x] Deployment guides for Docker, systemd, health checks, backups, and rollback
 
 ## License
 
-MacroSignage is licensed under the MIT License. See [LICENSE](LICENSE).
+MacroSignage is licensed under the MIT License. See [LICENSE](https://github.com/BaezFJ/MacroSignage/blob/master/LICENSE).
 
 Copyright (c) 2022 Javier Baez
 

{macrosignage-0.2.2 → macrosignage-0.2.3}/src/macrosignage/__init__.py

@@ -1,4 +1,4 @@
 from .app import create_app
 
-__version__ = "0.2.2"
+__version__ = "0.2.3"
 __all__ = ["create_app", "__version__"]

{macrosignage-0.2.2 → macrosignage-0.2.3}/src/macrosignage/app.py

@@ -1,4 +1,4 @@
-__version__ = "0.2.2"
+__version__ = "0.2.3"
 
 import os
 from os import PathLike

{macrosignage-0.2.2 → macrosignage-0.2.3}/src/macrosignage/web/templates/web/index.html

@@ -348,7 +348,7 @@ macrosignage dev</code></pre>
                 <p class="eyebrow">Roadmap</p>
                 <h2 class="display-6 fw-semibold">Where MacroSignage is heading.</h2>
                 <p class="section-lead">
-                    Pre-Alpha today (v0.2.2). Tracking toward a stable v1.0.
+                    Pre-Alpha today (v0.2.3). Tracking toward a stable v1.0.
                 </p>
             </header>
 

{macrosignage-0.2.2 → macrosignage-0.2.3}/tests/test_docs.py

@@ -7,6 +7,7 @@ from pathlib import Path
 ROOT = Path(__file__).resolve().parents[1]
 MARKDOWN_FILES = [ROOT / "README.md", ROOT / "client" / "README.md", *sorted((ROOT / "docs").rglob("*.md"))]
 LINK_PATTERN = re.compile(r"(?<!!)\[[^\]]+\]\((?!https?://|mailto:)([^)]+)\)")
+GITHUB_BLOB_PREFIX = "https://github.com/BaezFJ/MacroSignage/blob/master/"
 HEADING_PATTERN = re.compile(r"^(#{1,6})\s+(.+?)\s*$", re.MULTILINE)
 
 
@@ -44,6 +45,20 @@ def split_link(raw_link: str) -> tuple[str, str]:
     return target, ""
 
 
+def assert_link_resolves(source: Path, raw_link: str, failures: list[str], anchor_cache: dict[Path, set[str]]) -> None:
+    target_path, fragment = split_link(raw_link)
+    if not target_path and not fragment:
+        return
+    resolved = (source.parent / target_path).resolve() if target_path else source.resolve()
+    if not resolved.exists():
+        failures.append(f"{source.relative_to(ROOT)} -> {raw_link} missing file")
+        return
+    if fragment and resolved.suffix == ".md":
+        anchors = anchor_cache.setdefault(resolved, anchors_for(resolved))
+        if fragment not in anchors:
+            failures.append(f"{source.relative_to(ROOT)} -> {raw_link} missing anchor")
+
+
 def test_markdown_local_links_resolve_to_files_and_anchors():
     failures = []
     anchor_cache: dict[Path, set[str]] = {}
@@ -51,21 +66,32 @@ def test_markdown_local_links_resolve_to_files_and_anchors():
     for source in MARKDOWN_FILES:
         text = source.read_text(encoding="utf-8")
         for raw_link in LINK_PATTERN.findall(text):
-            target_path, fragment = split_link(raw_link)
-            if not target_path and not fragment:
-                continue
-            resolved = (source.parent / target_path).resolve() if target_path else source.resolve()
-            if not resolved.exists():
-                failures.append(f"{source.relative_to(ROOT)} -> {raw_link} missing file")
-                continue
-            if fragment and resolved.suffix == ".md":
-                anchors = anchor_cache.setdefault(resolved, anchors_for(resolved))
-                if fragment not in anchors:
-                    failures.append(f"{source.relative_to(ROOT)} -> {raw_link} missing anchor")
+            assert_link_resolves(source, raw_link, failures, anchor_cache)
 
     assert failures == []
 
 
+def test_readme_github_documentation_links_resolve_to_repo_files():
+    readme = ROOT / "README.md"
+    text = readme.read_text(encoding="utf-8")
+    failures = []
+    anchor_cache: dict[Path, set[str]] = {}
+
+    for raw_url in re.findall(rf"{re.escape(GITHUB_BLOB_PREFIX)}[^)\s]+", text):
+        repo_path = raw_url.removeprefix(GITHUB_BLOB_PREFIX)
+        assert_link_resolves(readme, repo_path, failures, anchor_cache)
+
+    assert failures == []
+
+
+def test_readme_uses_pypi_safe_documentation_links():
+    readme = (ROOT / "README.md").read_text(encoding="utf-8")
+
+    assert "](docs/" not in readme
+    assert "](LICENSE)" not in readme
+    assert GITHUB_BLOB_PREFIX in readme
+
+
 def test_docs_index_and_readme_reference_core_documentation():
     docs_index = (ROOT / "docs" / "index.md").read_text(encoding="utf-8")
     readme = (ROOT / "README.md").read_text(encoding="utf-8")