Skip to main content

KishuBoard

This is a dash-board extension of Kishu. With the interactive GUI provided by KishuBoard, you can browse, compare and search commits, checkout code/kernel variables to previous commits; branch out etc in a straightforward way.

Getting Started

pypi installation

To install the extension from pypi, execute:

pip install kishuboard

To remove the extension, execute:

pip uninstall kishuboard

starting up via kishuboard

kishuboard

And then you should be able to visit the kishuboard at localhost://4999.

Install from source code:

Note: You will need NodeJS to build the kishuboard, please make sure you have node on your computer, or install it from here.

  1. enter the directory of the current file
  2. build the NodeJS frontend
npm init # If you are building it from the source code for the first time
npm install # If you are building it from the source code for the first time
npm run build
  1. [optional] Install kishu core from source code
source ../.env/bin/activate # activate the virtual environment
pip install ../kishu # install kishu from source code
pip install -r requirements.txt #install other dependencies
  1. install kishu board
pip install .
  1. run the kishuboard
kishuboard

And then you should be able to visit the kishuboard at localhost://4999.

Development

Dev mode deployment

To run the kishuboard in dev mode, you will need to start the kishuboard server and the kishuboard frontend separately.

  1. enter the directory of this readme file
  2. start the kishuboard server(backend) in dev mode
source ../.env/bin/activate # activate the virtual environment
cd kishuboard
python server.py
  1. start the kishuboard frontend in dev mode
cd .. # go back to the directory of this readme file
npm init # If you are building it from the source code for the first time
npm install # If you are building it from the source code for the first time
npm start

And you should be able to visit the kishuboard at localhost://3000. Refresh the page in your browser to update the frontend after changing frontend code. To build a new release of kishuboard, please refer to RELEASE.md

Metadata

Release files for kishuboard 0.1.2

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

Source distribution (sdist)

Source distribution for kishuboard 0.1.2
File Size Uploaded Provenance
kishuboard-0.1.2.tar.gz 3.0 MB Without provenance Details

Built distribution (wheel)

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

Total release size: 5.3 MB

Release files / kishuboard-0.1.2.tar.gz

Download URL kishuboard-0.1.2.tar.gz
Size 3.0 MB
Tags Source
SHA-256 checksum
How to use checksums
06568d09e982475c3114960cac2305e33bce1cbafee25f4c59517482a0a30f38
BLAKE2b-256 checksum
How to use checksums
20b2545de241453c1dd8b7ceac24c6d1a2445fc91e66aafc70d2577bd92c3beb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.7

Release files / kishuboard-0.1.2-py3-none-any.whl

Download URL kishuboard-0.1.2-py3-none-any.whl
Size 2.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
54a70d8a69aa9777e8b865be58c90f7a27b281ee6284cb2df5f938a851106f03
BLAKE2b-256 checksum
How to use checksums
2a22a0b4b4c4ced892df8b391d9000ff63004e0e5c9b0a888c07ec0f2b294c1c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.7

Security for kishuboard 0.1.2

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.

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