panel-jstree


Namepanel-jstree JSON
Version 0.3.4 PyPI version JSON
download
home_page
Summarypanel-jstree is a wrapper python wrapper around the javascript library jstree for use in panel. This allows for JSON-like representations of tree data. One very useful implementation provided is a server-side file browser.
upload_time2024-02-12 22:22:24
maintainer
docs_urlNone
authormadeline-scyphers
requires_python>=3.8
licenseMIT License Copyright (c) 2023 Madeline Scyphers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords python holoviz panel dataviz dataapp dashboard datascience analytics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ✨ panel-jstree

panel-jstree is a wrapper python wrapper around the javascript library [jstree](https://www.jstree.com) for use in [panel](https://panel.holoviz.org/). This allows for JSON-like representations of tree data. One very useful implementation provided is a server-side file browser.

You can install and use the package as simple as.

```bash
conda install -c conda-forge panel-jstree
```

or with pip

```bash
pip install panel-jstree
```

Add this into a python file to play with the FileTree

```python
from panel_jstree import FileTree

FileTree().servable()
```

run it with `panel serve name_of_app.py`

It should run exploring the directory of the file.

![Project Intro](https://raw.githubusercontent.com/madeline-scyphers/panel-jstree/main/assets/videos/project-intro.gif)

## 🚀 Get started in under a minute

```bash
pip install  panel-jstree
```

Run the examples

```bash
panel serve tests/*tree.py --show
```

Here are some of the examples. You can see a small FileTree app with a text field and controls to directly input a file path, and turn off and on some of the controls.

![FileTree App Example](https://raw.githubusercontent.com/madeline-scyphers/panel-jstree/main/assets/videos/file-tree.gif)

You can make a simple tree where you swap out the data.

![Simple Tree App Example](https://raw.githubusercontent.com/madeline-scyphers/panel-jstree/main/assets/videos/simple_tree.gif)

You can also see a generic Tree app with a custom callback to generate random nodes.

![Random Tree App Example](https://raw.githubusercontent.com/madeline-scyphers/panel-jstree/main/assets/videos/random-tree.gif)


## ⭐ Support

Please support [Panel](https://panel.holoviz.org) and
[panel-jstree](https://github.com/madeline-scyphers/panel-jstree) by giving the projects a star on Github.

Thanks

## ❤️ Contribute

If you are looking to contribute to this project you can find ideas in the [issue tracker](https://github.com/madeline-scyphers/panel-jstree/issues). To get started check out the [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md).

I would love to support and receive your contributions. Thanks.

## Monitor

|                 |                                                                                                                                                                         |
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Conda Install   | [![Conda Version](https://anaconda.org/conda-forge/panel-jstree/badges/version.svg)](https://anaconda.org/conda-forge/panel-jstree)                                     |
| PyPI Install    | [![PyPI version](https://badge.fury.io/py/panel-jstree.svg)](https://pypi.org/project/panel-jstree)                                                                     |
| Github release  | [![Github tag](https://img.shields.io/github/v/tag/madeline-scyphers/panel-jstree.svg?label=tag&colorB=11ccbb)](https://github.com/madeline-scyphers/panel-jstree/tags) |
| Python Versions | ![Python Versions](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue)                                                                               |
| License         | [![License](https://img.shields.io/badge/License-MIT%202.0-blue.svg)](https://opensource.org/licenses/MIT)                                                              |

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "panel-jstree",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "python,holoviz,panel,dataviz,dataapp,dashboard,datascience,analytics",
    "author": "madeline-scyphers",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/e6/0f/a7f260e5554f8a3271a44c0dc7ff6b2b73d1adaf8d546f71b2138b7c1d45/panel-jstree-0.3.4.tar.gz",
    "platform": null,
    "description": "# \u2728 panel-jstree\n\npanel-jstree is a wrapper python wrapper around the javascript library [jstree](https://www.jstree.com) for use in [panel](https://panel.holoviz.org/). This allows for JSON-like representations of tree data. One very useful implementation provided is a server-side file browser.\n\nYou can install and use the package as simple as.\n\n```bash\nconda install -c conda-forge panel-jstree\n```\n\nor with pip\n\n```bash\npip install panel-jstree\n```\n\nAdd this into a python file to play with the FileTree\n\n```python\nfrom panel_jstree import FileTree\n\nFileTree().servable()\n```\n\nrun it with `panel serve name_of_app.py`\n\nIt should run exploring the directory of the file.\n\n![Project Intro](https://raw.githubusercontent.com/madeline-scyphers/panel-jstree/main/assets/videos/project-intro.gif)\n\n## \ud83d\ude80 Get started in under a minute\n\n```bash\npip install  panel-jstree\n```\n\nRun the examples\n\n```bash\npanel serve tests/*tree.py --show\n```\n\nHere are some of the examples. You can see a small FileTree app with a text field and controls to directly input a file path, and turn off and on some of the controls.\n\n![FileTree App Example](https://raw.githubusercontent.com/madeline-scyphers/panel-jstree/main/assets/videos/file-tree.gif)\n\nYou can make a simple tree where you swap out the data.\n\n![Simple Tree App Example](https://raw.githubusercontent.com/madeline-scyphers/panel-jstree/main/assets/videos/simple_tree.gif)\n\nYou can also see a generic Tree app with a custom callback to generate random nodes.\n\n![Random Tree App Example](https://raw.githubusercontent.com/madeline-scyphers/panel-jstree/main/assets/videos/random-tree.gif)\n\n\n## \u2b50 Support\n\nPlease support [Panel](https://panel.holoviz.org) and\n[panel-jstree](https://github.com/madeline-scyphers/panel-jstree) by giving the projects a star on Github.\n\nThanks\n\n## \u2764\ufe0f Contribute\n\nIf you are looking to contribute to this project you can find ideas in the [issue tracker](https://github.com/madeline-scyphers/panel-jstree/issues). To get started check out the [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md).\n\nI would love to support and receive your contributions. Thanks.\n\n## Monitor\n\n|                 |                                                                                                                                                                         |\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Conda Install   | [![Conda Version](https://anaconda.org/conda-forge/panel-jstree/badges/version.svg)](https://anaconda.org/conda-forge/panel-jstree)                                     |\n| PyPI Install    | [![PyPI version](https://badge.fury.io/py/panel-jstree.svg)](https://pypi.org/project/panel-jstree)                                                                     |\n| Github release  | [![Github tag](https://img.shields.io/github/v/tag/madeline-scyphers/panel-jstree.svg?label=tag&colorB=11ccbb)](https://github.com/madeline-scyphers/panel-jstree/tags) |\n| Python Versions | ![Python Versions](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue)                                                                               |\n| License         | [![License](https://img.shields.io/badge/License-MIT%202.0-blue.svg)](https://opensource.org/licenses/MIT)                                                              |\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Madeline Scyphers  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "panel-jstree is a wrapper python wrapper around the javascript library jstree for use in panel. This allows for JSON-like representations of tree data. One very useful implementation provided is a server-side file browser.",
    "version": "0.3.4",
    "project_urls": {
        "repository": "https://github.com/madeline-scyphers/panel-jstree"
    },
    "split_keywords": [
        "python",
        "holoviz",
        "panel",
        "dataviz",
        "dataapp",
        "dashboard",
        "datascience",
        "analytics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7bc97dbe9e9b11bba1aee8bf0cbff92694e6daa878084b00ddd5bcd51e6ed95b",
                "md5": "ae66e5903f1fa7410c583fcc228c7838",
                "sha256": "babc9dc205b5716776b04ff3359610369e8a407a00e59bf05945bac091dd0355"
            },
            "downloads": -1,
            "filename": "panel_jstree-0.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ae66e5903f1fa7410c583fcc228c7838",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 50908,
            "upload_time": "2024-02-12T22:22:22",
            "upload_time_iso_8601": "2024-02-12T22:22:22.749332Z",
            "url": "https://files.pythonhosted.org/packages/7b/c9/7dbe9e9b11bba1aee8bf0cbff92694e6daa878084b00ddd5bcd51e6ed95b/panel_jstree-0.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e60fa7f260e5554f8a3271a44c0dc7ff6b2b73d1adaf8d546f71b2138b7c1d45",
                "md5": "7ac9c220b5aee8ca259a7bd77db8c67e",
                "sha256": "53ee8e03e850fef2b883a4a432a37c67e98bb3bfecf24dee7fc1e477435403b3"
            },
            "downloads": -1,
            "filename": "panel-jstree-0.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "7ac9c220b5aee8ca259a7bd77db8c67e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 42232,
            "upload_time": "2024-02-12T22:22:24",
            "upload_time_iso_8601": "2024-02-12T22:22:24.178731Z",
            "url": "https://files.pythonhosted.org/packages/e6/0f/a7f260e5554f8a3271a44c0dc7ff6b2b73d1adaf8d546f71b2138b7c1d45/panel-jstree-0.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-12 22:22:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "madeline-scyphers",
    "github_project": "panel-jstree",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "panel-jstree"
}
        
Elapsed time: 0.17824s