Skip to main content

Backend-first SPA framework in Python.

Project description

moon-spa logo

MOON-SPA

Backend-first SPA framework in Python.

This project includes:

  • Template file served by the backend
  • .lspa components (HTML + Python) with component import support
  • Client hydration at component level
  • DOM diff renderer inspired by React's virtual DOM flow
  • useState hook-style state management
  • Setup-only component contract via Component.setup(self, props)
  • Server-call bridge for callable actions and lifecycle hooks
  • Base app definitions isolated in src/moon_template/spa.config.json

Requirements

  • Python 3.10+
  • Poetry installed

How to use

Install locally (development)

poetry install

Create a new project

moon-spa create my_project
moon-spa create my_project ./apps

Create a component from template

moon-spa new component UserCard
moon-spa new component UserCard ./apps/my_project

The CLI copies ComponentTemplate, renames files/content, and prints the exact created paths.

Run the application

poetry run moon-spa serve

Enable hot reload:

poetry run moon-spa serve --reload

When reload is enabled, watcher logs use relative paths:

Live reload activated. Watching src for file changes...

Open in browser:

http://127.0.0.1:8000

Documentation

Docs are available in the docs/ directory:

Run locally:

cd docs
npx docusaurus start

Project Structure

moon-spa/
  pyproject.toml
  src/
    moon_spa/
      app.py
      codegen.py
      framework.py
      loader.py
      main.py
      renderer.py
      router.py
      scope.py
      server.py
      runtime_assets.py
    moon_template/
      index.lspa
      spa.config.json
      components/
  tests/

Tests

poetry run pytest

With coverage:

poetry run pytest --cov=src/moon_spa --cov-report=term

Component Format

Components are .lspa files composed of:

  • optional imports
  • <python> block with a Component subclass implementing setup(self, props)
  • <template> block (HTML)

setup(self, props) can return a mapping with props, state, data, actions, and lifecycle, or omit return and let the server infer these sections from local variables/functions. Callable actions and lifecycle entries are executed through the POST /__moon_spa_action bridge. When actions/lifecycle mutate data, those keys are patched back to client props automatically.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

moon_spa-2.0.1.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

moon_spa-2.0.1-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

Details for the file moon_spa-2.0.1.tar.gz.

File metadata

  • Download URL: moon_spa-2.0.1.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for moon_spa-2.0.1.tar.gz
Algorithm Hash digest
SHA256 027be103ac42264fec65f1a5324b5874ab8454d35158223ade5042b9062f49db
MD5 9749da50693fbfdd87dd522ca236afbd
BLAKE2b-256 ba646cba6bac4f339e4ba8acbaa22a910bfd174e0de2fb95748d17334a580db6

See more details on using hashes here.

Provenance

The following attestation bundles were made for moon_spa-2.0.1.tar.gz:

Publisher: release-and-deploy.yaml on roderiano/moon-spa

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file moon_spa-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: moon_spa-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for moon_spa-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4a39bc07c0e0734291e79dfd8587b5f49e12d600890b971704d68ecc8843d49c
MD5 a8ca95b76fa4f70ed3a83e65cd248f9b
BLAKE2b-256 2dcb3e03a7a35e1f85071f7172f7170de8321c14544cdcf8c0ef1dddd758a41c

See more details on using hashes here.

Provenance

The following attestation bundles were made for moon_spa-2.0.1-py3-none-any.whl:

Publisher: release-and-deploy.yaml on roderiano/moon-spa

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page