| Name | kishuboard JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-03-25 18:37:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2023, Yongjoo Park All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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:
```bash
pip install kishuboard
```
To remove the extension, execute:
```bash
pip uninstall kishuboard
```
### starting up via kishuboard
```bash
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](https://nodejs.org/en/download/).
1. enter the directory of the current file
2. build the NodeJS frontend
```bash
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
```
3. [optional] Install kishu core from source code
```bash
source ../.env/bin/activate # activate the virtual environment
pip install ../kishu # install kishu from source code
pip install -r requirements.txt #install other dependencies
```
4. install kishu board
```bash
pip install .
```
5. run the kishuboard
```bash
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
```bash
source ../.env/bin/activate # activate the virtual environment
cd kishuboard
python server.py
```
3. start the kishuboard frontend in dev mode
```bash
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**.
### Release
To build a new release of kishuboard, please refer to [RELEASE.md](./RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "kishuboard",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5f/6b/d53816ef1cf91246e3fec22b4ad20345d33c0075e88cea5961a1974d425f/kishuboard-0.1.1.tar.gz",
"platform": null,
"description": "# KishuBoard\nThis 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.\n## Getting Started\n### pypi installation\nTo install the extension from pypi, execute:\n\n```bash\npip install kishuboard\n```\nTo remove the extension, execute:\n\n```bash\npip uninstall kishuboard\n```\n### starting up via kishuboard\n```bash\nkishuboard\n```\nAnd then you should be able to visit the kishuboard at localhost://4999.\n\n### Install from source code:\nNote: You will need NodeJS to build the kishuboard, please make sure you have node on your computer, or install it from [here](https://nodejs.org/en/download/).\n1. enter the directory of the current file\n2. build the NodeJS frontend\n```bash\nnpm init # If you are building it from the source code for the first time\nnpm install # If you are building it from the source code for the first time\nnpm run build\n```\n3. [optional] Install kishu core from source code\n```bash\nsource ../.env/bin/activate # activate the virtual environment\npip install ../kishu # install kishu from source code\npip install -r requirements.txt #install other dependencies\n```\n4. install kishu board\n```bash\npip install .\n```\n5. run the kishuboard\n```bash\nkishuboard\n```\nAnd then you should be able to visit the kishuboard at localhost://4999.\n\n## Development\n### Dev mode deployment\nTo run the kishuboard in dev mode, you will need to start the kishuboard server and the kishuboard frontend separately.\n1. enter the directory of this readme file\n2. start the kishuboard server(backend) in dev mode\n```bash\nsource ../.env/bin/activate # activate the virtual environment\ncd kishuboard\npython server.py\n```\n3. start the kishuboard frontend in dev mode\n```bash\ncd .. # go back to the directory of this readme file\nnpm init # If you are building it from the source code for the first time\nnpm install # If you are building it from the source code for the first time\nnpm start\n```\nAnd you should be able to visit the kishuboard at **localhost://3000**.\n### Release\nTo build a new release of kishuboard, please refer to [RELEASE.md](./RELEASE.md)",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023, Yongjoo Park All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": null,
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ed17115d8167825f3c7cd9a66c08395a7a24af857ba953050089c352d227a25",
"md5": "1994da40d467dbc317a922a5fa115c16",
"sha256": "71fe62edcf8cab43c9fbfb2be419757b6f8087a9106cf0bd93f0a5d2c9010d2d"
},
"downloads": -1,
"filename": "kishuboard-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1994da40d467dbc317a922a5fa115c16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2361234,
"upload_time": "2024-03-25T18:37:23",
"upload_time_iso_8601": "2024-03-25T18:37:23.639568Z",
"url": "https://files.pythonhosted.org/packages/5e/d1/7115d8167825f3c7cd9a66c08395a7a24af857ba953050089c352d227a25/kishuboard-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5f6bd53816ef1cf91246e3fec22b4ad20345d33c0075e88cea5961a1974d425f",
"md5": "51bc49e32442d03efe27a0b969bfd1ad",
"sha256": "9b7f74bcbbb7c0b825cc52aaffe08577fb207a3714f6c9d38ae6987031c0a5e8"
},
"downloads": -1,
"filename": "kishuboard-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "51bc49e32442d03efe27a0b969bfd1ad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4196634,
"upload_time": "2024-03-25T18:37:25",
"upload_time_iso_8601": "2024-03-25T18:37:25.215473Z",
"url": "https://files.pythonhosted.org/packages/5f/6b/d53816ef1cf91246e3fec22b4ad20345d33c0075e88cea5961a1974d425f/kishuboard-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 18:37:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "kishuboard"
}
