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.3.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.3-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: moon_spa-2.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 8390bbaf20062f26aee4a43201331116804c8e7cba9009ec7c23f10541ad307e
MD5 a719e47e2e6f9c71822f4442c96e8c77
BLAKE2b-256 d60ee18f9c2aa6be60c80c9d34a8bc78b19b2c664860f2ac07dabe443c4f2b6a

See more details on using hashes here.

Provenance

The following attestation bundles were made for moon_spa-2.0.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: moon_spa-2.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 292e3c99883ce8e11ff4c5a9cc950059249398444578b310406f565dafb82e8d
MD5 40bac26a23d18efc35cc8b798a0b31bc
BLAKE2b-256 eb2cb4ae5ada7bebf6a0368ef4c5c70a6aca451eec67a8d069636a82532c2e9f

See more details on using hashes here.

Provenance

The following attestation bundles were made for moon_spa-2.0.3-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