gramlot-examples 0.2.2__tar.gz

gramlot_examples-0.2.2/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.py[cod]
+.venv/
+node_modules/
+build/
+.env
+dist/
+*.egg-info/
+package-lock.json
+npm-shrinkwrap.json
+bun.lock
+bun.lockb

gramlot_examples-0.2.2/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

gramlot_examples-0.2.2/NOTICE

@@ -0,0 +1,8 @@
+Gramlot examples
+Copyright 2025-2026 Softwell S.r.l.
+
+This product includes software developed at Softwell S.r.l.
+(https://www.softwell.it/), originally in Genro Pages and Genro DOM JS.
+The original Genro DOM JS notice states: Copyright 2025 Softwell S.r.l.
+
+Licensed under the Apache License, Version 2.0.

gramlot_examples-0.2.2/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.5
+Name: gramlot-examples
+Version: 0.2.2
+Summary: Gramlot example pages, the gallery page and its catalogue.
+Project-URL: Homepage, https://github.com/gramlot-org/gramlot-examples
+Project-URL: Repository, https://github.com/gramlot-org/gramlot-examples
+Project-URL: Issues, https://github.com/gramlot-org/gramlot-examples/issues
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.11
+Requires-Dist: gramlot>=0.2.2
+Description-Content-Type: text/markdown
+
+# gramlot-examples
+
+The common example pages of [Gramlot](https://github.com/gramlot-org/gramlot), the
+gallery page that presents them, and its catalogue. Published as a package that
+depends only on the Gramlot core:
+
+```sh
+pip install gramlot-examples
+npm install @gramlot/gramlot-examples
+```
+
+The repositories of the family are described in
+[The Gramlot family](https://github.com/gramlot-org/gramlot/blob/main/docs/public/055-family.md)
+(GC-055).
+
+## Pages
+
+[`src/gramlot_examples/pages/`](src/gramlot_examples/pages/README.md) holds three
+families. Each example is a Python page and its JavaScript equivalent, with a
+same-name README:
+
+- `html_svg/`: thirteen HTML and SVG pages, without binding (`e01`–`e13`);
+- `binding/`: eleven pages whose DOM follows the Data (`b01`–`b11`);
+- `controllers/`: nine pages with formulas, controllers, logic companions, events and
+  remote Source (`c01`–`c09`).
+
+## Gallery
+
+The gallery page lists the families and opens each example beside its README and
+source. `build_gallery` (Python) and `buildGallery` (JavaScript) return its routes and
+static assets; each environment (`gramlot-py-server`, `gramlot-js-server`) serves the
+gallery with its own host and can add its own catalogue. Guide:
+[GE-010](docs/010-gallery.md).
+
+```sh
+npm install --no-package-lock
+npm run build
+npm test
+python -m unittest discover -s tests
+```
+
+## Applications
+
+[Hello World](apps/hello-world/README.md) stays here until its launchers move to the
+adapters as their quick-start examples. Its JavaScript launchers use
+`@gramlot/gramlot-js-server`; its Python launchers wait for `gramlot-py-server`.
+Database profiles remain placeholders.
+
+[Repository map](docs/005-repository-map.md) (GE-005).

gramlot_examples-0.2.2/README.md

@@ -0,0 +1,49 @@
+# gramlot-examples
+
+The common example pages of [Gramlot](https://github.com/gramlot-org/gramlot), the
+gallery page that presents them, and its catalogue. Published as a package that
+depends only on the Gramlot core:
+
+```sh
+pip install gramlot-examples
+npm install @gramlot/gramlot-examples
+```
+
+The repositories of the family are described in
+[The Gramlot family](https://github.com/gramlot-org/gramlot/blob/main/docs/public/055-family.md)
+(GC-055).
+
+## Pages
+
+[`src/gramlot_examples/pages/`](src/gramlot_examples/pages/README.md) holds three
+families. Each example is a Python page and its JavaScript equivalent, with a
+same-name README:
+
+- `html_svg/`: thirteen HTML and SVG pages, without binding (`e01`–`e13`);
+- `binding/`: eleven pages whose DOM follows the Data (`b01`–`b11`);
+- `controllers/`: nine pages with formulas, controllers, logic companions, events and
+  remote Source (`c01`–`c09`).
+
+## Gallery
+
+The gallery page lists the families and opens each example beside its README and
+source. `build_gallery` (Python) and `buildGallery` (JavaScript) return its routes and
+static assets; each environment (`gramlot-py-server`, `gramlot-js-server`) serves the
+gallery with its own host and can add its own catalogue. Guide:
+[GE-010](docs/010-gallery.md).
+
+```sh
+npm install --no-package-lock
+npm run build
+npm test
+python -m unittest discover -s tests
+```
+
+## Applications
+
+[Hello World](apps/hello-world/README.md) stays here until its launchers move to the
+adapters as their quick-start examples. Its JavaScript launchers use
+`@gramlot/gramlot-js-server`; its Python launchers wait for `gramlot-py-server`.
+Database profiles remain placeholders.
+
+[Repository map](docs/005-repository-map.md) (GE-005).

gramlot_examples-0.2.2/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@gramlot/gramlot-examples",
+  "version": "0.2.2",
+  "description": "Gramlot example pages, the gallery page and its catalogue.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gramlot-org/gramlot-examples.git"
+  },
+  "type": "module",
+  "scripts": {
+    "build": "node scripts/build-browser.mjs",
+    "test": "node --test tests/*.test.js",
+    "prepack": "node scripts/build-browser.mjs"
+  },
+  "dependencies": {
+    "@gramlot/gramlot": ">=0.2.2"
+  },
+  "devDependencies": {
+    "@genrojs/bag": ">=0.10.1",
+    "dompurify": "3.4.16",
+    "esbuild": "0.28.2",
+    "highlight.js": "^11.11.1",
+    "jsdom": "27.0.1",
+    "marked": "^18.0.14"
+  },
+  "exports": {
+    ".": "./src/gramlot_examples/index.js",
+    "./catalog.json": "./src/gramlot_examples/catalog.json",
+    "./pages/*": "./src/gramlot_examples/pages/*",
+    "./gallery/*": "./src/gramlot_examples/gallery/*"
+  },
+  "files": [
+    "LICENSE",
+    "NOTICE",
+    "src/gramlot_examples/index.js",
+    "src/gramlot_examples/catalog.json",
+    "src/gramlot_examples/pages/**/*.js",
+    "src/gramlot_examples/pages/**/*.md",
+    "src/gramlot_examples/pages/**/*.css",
+    "src/gramlot_examples/gallery/page.js",
+    "src/gramlot_examples/gallery/gallery-page.js",
+    "src/gramlot_examples/gallery/gallery.css",
+    "src/gramlot_examples/gallery/dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

gramlot_examples-0.2.2/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "gramlot-examples"
+version = "0.2.2"
+description = "Gramlot example pages, the gallery page and its catalogue."
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.11"
+dependencies = ["gramlot>=0.2.2"]
+
+[project.urls]
+Homepage = "https://github.com/gramlot-org/gramlot-examples"
+Repository = "https://github.com/gramlot-org/gramlot-examples"
+Issues = "https://github.com/gramlot-org/gramlot-examples/issues"
+
+[tool.hatch.build]
+# The gallery bundle is built by `npm run build` and is not tracked.
+artifacts = ["src/gramlot_examples/gallery/dist/*"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/gramlot_examples"]
+# The wheel carries the Python pages; the JavaScript pages and gallery sources stay in npm.
+exclude = [
+    "src/gramlot_examples/pages/**/*.js",
+    "!src/gramlot_examples/pages/**/*_aux.js",
+    "src/gramlot_examples/index.js",
+    "src/gramlot_examples/gallery/browser",
+    "src/gramlot_examples/gallery/page.js",
+    "src/gramlot_examples/gallery/gallery-page.js",
+]
+
+[tool.hatch.build.targets.sdist]
+include = ["/src", "/tests", "/scripts", "/README.md", "/LICENSE", "/NOTICE", "/package.json", "/pyproject.toml"]

gramlot_examples-0.2.2/scripts/build-browser.mjs

@@ -0,0 +1,38 @@
+/** Build the provisional gallery's scripts separately from Gramlot's runtime. */
+import {build} from 'esbuild';
+import {copyFile, mkdir, readFile, readdir, writeFile} from 'node:fs/promises';
+import {fileURLToPath} from 'node:url';
+import {resolve} from 'node:path';
+
+const directory = new URL('../src/gramlot_examples/gallery/', import.meta.url);
+const output = new URL('dist/', directory);
+await mkdir(output, {recursive: true});
+const result = await build({
+    entryPoints: {
+        gallery: fileURLToPath(new URL('browser/entry.js', directory)),
+        frame: fileURLToPath(new URL('browser/frame-entry.js', directory)),
+    },
+    outdir: fileURLToPath(output), bundle: true, format: 'iife',
+    platform: 'browser', target: 'es2022', legalComments: 'inline', metafile: true,
+});
+// Keep notices for every bundled dependency, including transitive Bag dependencies.
+const packages = new Set();
+for (const input of Object.keys(result.metafile.inputs)) {
+    const matches = [...input.matchAll(/(?:^|\/)node_modules\/((?:@[^/]+\/)?[^/]+)/g)];
+    if (!matches.length) continue; // Our own gallery files use the root LICENSE/NOTICE.
+    const match = matches.at(-1);
+    packages.add(resolve(input.slice(0, match.index + match[0].length)));
+}
+const notices = [];
+for (const directory of [...packages].sort()) {
+    const metadata = JSON.parse(await readFile(resolve(directory, 'package.json'), 'utf8'));
+    const files = (await readdir(directory)).filter(name => /^(licen[cs]e|notice|copying)([.-].*)?$/i.test(name));
+    if (!files.length) throw new Error(`Missing bundled license for ${metadata.name}`);
+    const text = (await Promise.all(files.sort().map(name => readFile(resolve(directory, name), 'utf8')))).join('\n\n');
+    notices.push({name: metadata.name, text});
+}
+await writeFile(new URL('notices.json', output), JSON.stringify(notices, null, 2) + '\n');
+for (const name of ['LICENSE', 'NOTICE']) {
+    await copyFile(new URL(`../${name}`, import.meta.url), new URL(name, output));
+}
+console.log('Gallery browser scripts built.');

gramlot_examples-0.2.2/src/gramlot_examples/__init__.py

@@ -0,0 +1,86 @@
+"""Gramlot example pages, the gallery page and its catalogue."""
+
+import json
+import re
+from importlib.resources import files
+from pathlib import Path
+
+PACKAGE = Path(__file__).resolve().parent
+MEDIA_TYPES = {".css": "text/css", ".svg": "image/svg+xml", ".json": "application/json"}
+SUFFIXES = (".py", ".js", ".css", ".md", "_aux.js")
+DIST = ("gallery.js", "frame.js", "notices.json", "LICENSE", "NOTICE")
+
+
+def media_type(path, script=False):
+    """Media type of a gallery asset; only the built gallery scripts are served as JavaScript."""
+    if script:
+        return "application/javascript"
+    return MEDIA_TYPES.get(path.suffix, "text/plain")
+
+
+def read_catalog(catalog, pages, common):
+    """Load one ``catalog.json`` and check its ``environment`` against the key rule."""
+    data = json.loads(Path(catalog).read_text())
+    environment = data.get("environment")
+    if common and environment is not None:
+        raise ValueError(f"The common catalogue declares an environment: {catalog}")
+    if not common and not environment:
+        raise ValueError(f"An environment catalogue has no environment: {catalog}")
+    pattern = None if common else re.compile(rf"{re.escape(environment)}-\d{{2}}")
+    families = []
+    for family in data["families"]:
+        for example in family["examples"]:
+            if pattern is not None and not pattern.fullmatch(example["key"]):
+                raise ValueError(f"Example key {example['key']!r} does not match {environment}-NN: {catalog}")
+        families.append({**family, "path": Path(pages) / family["key"]})
+    return families
+
+
+def build_gallery(catalogs=()):
+    """Return the families, routes and static assets of the common gallery plus ``catalogs``.
+
+    Each item of ``catalogs`` is a pair ``(catalog.json, pages folder)`` of one environment.
+    ``routes`` maps each key to its Python page and same-name companions; ``assets`` maps
+    each URL to its file and media type. Nothing is written or served here.
+    """
+    families = read_catalog(PACKAGE / "catalog.json", PACKAGE / "pages", common=True)
+    for catalog, pages in catalogs:
+        families.extend(read_catalog(catalog, pages, common=False))
+    keys = ["index"] + [key for family in families
+                        for key in (family["key"], *(example["key"] for example in family["examples"]))]
+    duplicates = sorted({key for key in keys if keys.count(key) > 1})
+    if duplicates:
+        raise ValueError(f"Duplicate gallery keys: {', '.join(duplicates)}")
+
+    gallery = PACKAGE / "gallery"
+    resources = Path(files("gramlot")) / "resources"
+    routes = {"index": {"page": gallery / "page.py", "stylesheet": None, "logic": None}}
+    files_by_url = [
+        ("/themes/gramlot-base/theme.css", resources / "themes" / "gramlot-base" / "theme.css"),
+        ("/assets/branding/gramlot-logo-dark.svg", resources / "assets" / "branding" / "gramlot-logo-dark.svg"),
+        ("/gallery/gallery.css", gallery / "gallery.css"),
+        *((f"/gallery/{name}", gallery / name) for name in ("page.py", "page.js") if (gallery / name).is_file()),
+    ]
+    assets = {url: {"file": path, "type": media_type(path)} for url, path in files_by_url}
+    for name in DIST:
+        path = gallery / "dist" / name
+        assets[f"/gallery/dist/{name}"] = {"file": path, "type": media_type(path, path.suffix == ".js")}
+    for family in families:
+        folder = family["path"]
+        for example in family["examples"]:
+            page = folder / f"{example['folder']}.py"
+            if not page.is_file():
+                raise FileNotFoundError(f"Missing page: {page}")
+            stylesheet = folder / f"{example['folder']}.css"
+            logic = folder / f"{example['folder']}_aux.js"
+            routes[example["key"]] = {"page": page,
+                                      "stylesheet": stylesheet if stylesheet.is_file() else None,
+                                      "logic": logic if logic.is_file() else None}
+            for suffix in SUFFIXES:
+                source = folder / f"{example['folder']}{suffix}"
+                if source.is_file():
+                    assets[f"/pages/{family['key']}/{source.name}"] = {"file": source, "type": media_type(source)}
+    return {"families": families, "routes": routes, "assets": assets}
+
+
+__all__ = ["build_gallery"]