Skip to main content

Kanbaroo phase 2 web UI: React SPA plus static asset bundle served by kanbaroo-api.

Project description

kanbaroo-web

Static web UI for Kanbaroo, served by kanbaroo-api at /ui when you install the optional kanbaroo-api[web] extra. See docs/spec.md section 9.2 for design intent.

This package ships a single function:

from kanbaroo_web import web_assets_path

assets_dir = web_assets_path()  # absolute Path to the bundled dist/

kanbaroo-api uses it to mount a /ui catch-all with an SPA fallback.

Building the bundle

The dist/ directory under src/kanbaroo_web/ is produced by a Vite + React build. The sources live in the sibling frontend/ directory and are not shipped in the wheel; only the built output is.

Node 20+ is a build-time requirement. From the repo root:

make web-build   # installs npm deps and runs vite build
make web-dev     # runs the Vite dev server for iterative work
make web-test    # runs the frontend test suite (vitest, single-shot)

make web-build writes into packages/kanbaroo-web/src/kanbaroo_web/dist/, overwriting whatever was there. The committed dist/ is what pip install kanbaroo-web delivers.

Install

pip install 'kanbaroo-api[web]'

License: MIT.

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

kanbaroo_web-0.2.2.tar.gz (414.2 kB view details)

Uploaded Source

Built Distribution

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

kanbaroo_web-0.2.2-py3-none-any.whl (146.4 kB view details)

Uploaded Python 3

File details

Details for the file kanbaroo_web-0.2.2.tar.gz.

File metadata

  • Download URL: kanbaroo_web-0.2.2.tar.gz
  • Upload date:
  • Size: 414.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for kanbaroo_web-0.2.2.tar.gz
Algorithm Hash digest
SHA256 ee59869e3829734812ba0601ecc642c7581cb7131f6f572a543a44dff92c9468
MD5 f256d078d1e5d57bfcc616b27688bbe2
BLAKE2b-256 0e076a054fc30b320433dce32174a531814021640e30bde3532b1630f6d8531b

See more details on using hashes here.

File details

Details for the file kanbaroo_web-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: kanbaroo_web-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 146.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for kanbaroo_web-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e1ec3b5dbfc45fc9b4817dabef984a16ffa0102ca29e4e7f438c196372b8be83
MD5 d20876adcd3745283c396c3460957992
BLAKE2b-256 3ef4e512ee18ccd4fe132c0092b2ef445bf95d0d25a941313a052f8f98bf741d

See more details on using hashes here.

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