Skip to main content

migrid-ux

Documentation Status

This repository is intended as the source of truth for a series of small web applications and their supporting libraries which will form various portions of the MiGrid user-facing web interface. They are currently under extremely heavy development in branches whose content is subject to extensive change until such time as they are merged to the main branch.

Basic principles

Applications are structured around a clean separation between their state, and a rendered representation which is derived from the data contained within it. The "data" backing an application, which we refer to as their state, is bound (see binding) to a the on-screen HTML markup.

Handling of state

The state is represented as a series of observed values which signal when they are changed. Such values is commonly referred to as observables. These values are grouped into namespaces of related values, each of which can be individually serialised on demand.

Binding to observables

The HTML of the application is annotated with a series of binding attributes which are processed and e.g. any required event handlers attached. As a user interacts with the web page the values within the observables change, and any programmatic changes to observables are reflected within the browser.

Contained libraries

This repository contains a basic browser runtime enabling the construction of dynamic web applications as HTML that is bound to an observable-based state.

Heavy inspiration is taken from older solutions to this problem, in particular Knockout, but client side templating is omitted in favour favour of the use of server-side rendering of HTML fragments which are handled in a fashion similar to the more recent htmx.

Supporting modules

lib/binding.mjs

This is responsible for wiring HTML markup to observables present in the state.

lib/observable.mjs

Provides the basic observed value primitives.

lib/state.mjs

Exposes both a type and a number of construction functions which can generate and manage the observable values for a particular application based upon the delcarative definition of required values specified by a given application.

Usage

The repository is arranged to be consistent with migrid-sync and as such the main functions are exposed via a Makefile at the top level. A basic bringup involves running:

$ make local

Running the above will have the effect of installing and necessary dependencies for local development and provisioning a virtual environment to allow the use of a fake backend intended to support rapid iteration ruding development. As a final step a local web server and local backend will be started, with the application then being accessible at: http://localhost:8880

Glossary

binding

The process of attaching DOM elements to their respective observables.

namespace

A grouping of observable values which are considered to be related.

observable

An embellished value able to signal interested parties when it is changed.

state

The complete set of observed values that represent an active application.

Licensing

The source code is licensed under GPLv2 or MIT as defined by the source in question. These licenses can be found under the [here]LICENSES directory.

Metadata

Release files for migux 1.20.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for migux 1.20.0
File Size Uploaded Provenance Actions
migux-1.20.0.tar.gz 61.8 kB Without provenance Details for migux-1.20.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for migux 1.20.0
File Interpreter ABI Platform Actions
migux-1.20.0-py3-none-any.whl Python 3 none any Details for migux-1.20.0-py3-none-any.whl

Total release size: 136.9 kB

Release files / migux-1.20.0.tar.gz

Download URL migux-1.20.0.tar.gz
Size 61.8 kB
Tags Source
SHA-256 checksum
How to use checksums
33748ef63ff2d993f8fd586ec484b1a9da32111d3122fa0cc0d88be060845948
BLAKE2b-256 checksum
How to use checksums
23b06d4039f9ee8d1e3c1f847e1004d82048039ca704e7802738a8632586695d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release files / migux-1.20.0-py3-none-any.whl

Download URL migux-1.20.0-py3-none-any.whl
Size 75.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1b6dc01f1bcfb64f0717291ddd849ccb17f7fe501568745d4e93e9feb266ebd8
BLAKE2b-256 checksum
How to use checksums
52afac78ed68dd139284d5501626fe9d3f7b82c6603e3714489ed75e164219d9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Security for migux 1.20.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page