trame-tweakpane


Nametrame-tweakpane JSON
Version 0.1.3 PyPI version JSON
download
home_pageNone
SummaryTweakPane widgets for trame
upload_time2024-04-26 22:25:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseMIT License Copyright (c) 2024, Kitware Inc. 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 components trame tweakpane web
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ===============
trame-tweakpane
===============

TweakPane widgets for trame made easy.

License
------------------------

trame-tweakpane is made available under the MIT License. For more details, see `LICENSE <https://raw.githubusercontent.com/Kitware/trame-tweakpane/master/LICENSE>`_. This license has been chosen to match the one used by `tweakpane <https://tweakpane.github.io/docs/>`_ which that project expose to trame.


Installation
------------------------

.. code-block:: console

    pip install trame-tweakpane


Usage
------------------------

.. code-block:: python

    from trame.widgets import tweakpane

    with layout:
        with tweakpane.Pane(title="Welcome", expanded=True, style="width: 200px;"):
            tweakpane.Binding(name="a", default=1, options="{ min: -6, max: 10, step: 0.2 }")
            with tweakpane.Folder(title="Sub-section"):
                tweakpane.Binding(name="b", default="Hello")
                tweakpane.BladeSeparator()
                tweakpane.Binding(name="c", default=0.465, options="{ label: 'Another number' }")
            with tweakpane.Tabs(pages="['First', 'Second', 'Third']"):
                with tweakpane.Tab(index=0):
                    tweakpane.Binding(name="d", default="something")
                with tweakpane.Tab(index=1):
                    tweakpane.Button(label="Click =>", title="Me", click=(print, "['clicked']"))
                with tweakpane.Tab(index=2):
                    tweakpane.Binding(name="f", default="something")

.. image:: https://raw.githubusercontent.com/Kitware/trame-tweakpane/master/examples/readme_example.png
  :width: 400
  :alt: Visual output of the code above

Development
------------------------

Build and install the Vue components

.. code-block:: console

    cd vue-components
    npm i
    npm run build
    cd -

Install the application

.. code-block:: console

    pip install -e .



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "trame-tweakpane",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "Sebastien Jourdain <sebastien.jourdain@kitware.com>",
    "keywords": "components, trame, tweakpane, web",
    "author": null,
    "author_email": "Sebastien Jourdain <sebastien.jourdain@kitware.com>",
    "download_url": "https://files.pythonhosted.org/packages/ec/e0/323d4b72ac51b85aa45aa7cafbd99d3d6d7b807d4f91d7b12ba628b617a9/trame_tweakpane-0.1.3.tar.gz",
    "platform": null,
    "description": "===============\ntrame-tweakpane\n===============\n\nTweakPane widgets for trame made easy.\n\nLicense\n------------------------\n\ntrame-tweakpane is made available under the MIT License. For more details, see `LICENSE <https://raw.githubusercontent.com/Kitware/trame-tweakpane/master/LICENSE>`_. This license has been chosen to match the one used by `tweakpane <https://tweakpane.github.io/docs/>`_ which that project expose to trame.\n\n\nInstallation\n------------------------\n\n.. code-block:: console\n\n    pip install trame-tweakpane\n\n\nUsage\n------------------------\n\n.. code-block:: python\n\n    from trame.widgets import tweakpane\n\n    with layout:\n        with tweakpane.Pane(title=\"Welcome\", expanded=True, style=\"width: 200px;\"):\n            tweakpane.Binding(name=\"a\", default=1, options=\"{ min: -6, max: 10, step: 0.2 }\")\n            with tweakpane.Folder(title=\"Sub-section\"):\n                tweakpane.Binding(name=\"b\", default=\"Hello\")\n                tweakpane.BladeSeparator()\n                tweakpane.Binding(name=\"c\", default=0.465, options=\"{ label: 'Another number' }\")\n            with tweakpane.Tabs(pages=\"['First', 'Second', 'Third']\"):\n                with tweakpane.Tab(index=0):\n                    tweakpane.Binding(name=\"d\", default=\"something\")\n                with tweakpane.Tab(index=1):\n                    tweakpane.Button(label=\"Click =>\", title=\"Me\", click=(print, \"['clicked']\"))\n                with tweakpane.Tab(index=2):\n                    tweakpane.Binding(name=\"f\", default=\"something\")\n\n.. image:: https://raw.githubusercontent.com/Kitware/trame-tweakpane/master/examples/readme_example.png\n  :width: 400\n  :alt: Visual output of the code above\n\nDevelopment\n------------------------\n\nBuild and install the Vue components\n\n.. code-block:: console\n\n    cd vue-components\n    npm i\n    npm run build\n    cd -\n\nInstall the application\n\n.. code-block:: console\n\n    pip install -e .\n\n\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024, Kitware Inc.  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": "TweakPane widgets for trame",
    "version": "0.1.3",
    "project_urls": null,
    "split_keywords": [
        "components",
        " trame",
        " tweakpane",
        " web"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d1eecb5c33cc87b8f1d6b411d356651738f738bbc5820a8ca8ad126302d01449",
                "md5": "1de03def7e238ee25f4201d7af9d41c8",
                "sha256": "eb7c45c03a2ebeff8edea862237df23c78546bc6662ce768715a3161b2339db8"
            },
            "downloads": -1,
            "filename": "trame_tweakpane-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1de03def7e238ee25f4201d7af9d41c8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 40792,
            "upload_time": "2024-04-26T22:25:38",
            "upload_time_iso_8601": "2024-04-26T22:25:38.572132Z",
            "url": "https://files.pythonhosted.org/packages/d1/ee/cb5c33cc87b8f1d6b411d356651738f738bbc5820a8ca8ad126302d01449/trame_tweakpane-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ece0323d4b72ac51b85aa45aa7cafbd99d3d6d7b807d4f91d7b12ba628b617a9",
                "md5": "689d55d3e9a28cf7dde9a8ba38a973bf",
                "sha256": "8c79a02a0b2d6ec49951ade62dc6976522cd76e8ff607dc7384b96aebf6f8ae0"
            },
            "downloads": -1,
            "filename": "trame_tweakpane-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "689d55d3e9a28cf7dde9a8ba38a973bf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 38595,
            "upload_time": "2024-04-26T22:25:39",
            "upload_time_iso_8601": "2024-04-26T22:25:39.684702Z",
            "url": "https://files.pythonhosted.org/packages/ec/e0/323d4b72ac51b85aa45aa7cafbd99d3d6d7b807d4f91d7b12ba628b617a9/trame_tweakpane-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-26 22:25:39",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "trame-tweakpane"
}
        
Elapsed time: 0.27058s