dtsh


Namedtsh JSON
Version 0.2.1 PyPI version JSON
download
home_pagehttps://github.com/dottspina/dtsh
SummaryShell-like interface with Zephyr Devicetree
upload_time2024-03-13 03:16:19
maintainer
docs_urlNone
authorChristophe Dufaza
requires_python>=3.8
licenseApache License version 2.0
keywords devicetree zephyr dts embedded
VCS
bugtrack_url
requirements PyYAML rich gnureadline
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ====
DTSh
====

**DTSh** is a Devicetree Source (DTS) files viewer with a shell-like command line interface:

- *navigate* and *visualize* the devicetree
- *search* for devices, bindings, buses or interrupts with flexible criteria
- redirect command output to files (text, HTML, SVG) to *document* hardware configurations
  or illustrate notes
- *rich* Textual User Interface, command line auto-completion, command history, user themes

::

   $ dtsh build/zephyr/zephyr.dts
   dtsh (0.2.1): A Devicetree Shell
   How to exit: q, or quit, or exit, or press Ctrl-D

   /
   > cd &flash_controller

   /soc/flash-controller@4001e000
   > tree -l
                                 Description
                                 ─────────────────────────────────────────────────────────────────
   flash-controller@4001e000     Nordic NVMC (Non-Volatile Memory Controller)
   └── flash@0                   Flash node
       └── partitions            This binding is used to describe fixed partitions of a flash (or…
            ├── partition@0      Each child node of the fixed-partitions node represents…
            ├── partition@c000   Each child node of the fixed-partitions node represents…
            ├── partition@82000  Each child node of the fixed-partitions node represents…
            └── partition@f8000  Each child node of the fixed-partitions node represents…

You can use it with:

- all DTS files generated by **Zephyr** at build-time (aka ``build/zephyr/zephyr.dts``)
- arbitrary DTS files with bindings compatible with Zephyr's `Devicetre bindings syntax <https://docs.zephyrproject.org/latest/build/dts/bindings-syntax.html>`_

Status
******

DTSh 0.2.x mirror and package the code base that serves as a proposal to upstream DTSh
as a new Zephyr extension to West: `RFC - DTSh, shell-like interface with Devicetree <https://github.com/zephyrproject-rtos/zephyr/pull/59863>`_

This is the stable and maintained branch: if you have DTSh 0.1.x installed, please upgrade with
e.g. ``pip install -U dtsh``.

Please refer to the `DTSh project documentation <http://dottspina.github.io/dtsh>`_.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/dottspina/dtsh",
    "name": "dtsh",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "devicetree,zephyr,dts,embedded",
    "author": "Christophe Dufaza",
    "author_email": "chris@openmarl.org",
    "download_url": "https://files.pythonhosted.org/packages/04/aa/175711a260109726b739ec1fc4a4d710339b71a9d9140e95cc049fc73c46/dtsh-0.2.1.tar.gz",
    "platform": null,
    "description": "====\nDTSh\n====\n\n**DTSh** is a Devicetree Source (DTS) files viewer with a shell-like command line interface:\n\n- *navigate* and *visualize* the devicetree\n- *search* for devices, bindings, buses or interrupts with flexible criteria\n- redirect command output to files (text, HTML, SVG) to *document* hardware configurations\n  or illustrate notes\n- *rich* Textual User Interface, command line auto-completion, command history, user themes\n\n::\n\n   $ dtsh build/zephyr/zephyr.dts\n   dtsh (0.2.1): A Devicetree Shell\n   How to exit: q, or quit, or exit, or press Ctrl-D\n\n   /\n   > cd &flash_controller\n\n   /soc/flash-controller@4001e000\n   > tree -l\n                                 Description\n                                 \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n   flash-controller@4001e000     Nordic NVMC (Non-Volatile Memory Controller)\n   \u2514\u2500\u2500 flash@0                   Flash node\n       \u2514\u2500\u2500 partitions            This binding is used to describe fixed partitions of a flash (or\u2026\n            \u251c\u2500\u2500 partition@0      Each child node of the fixed-partitions node represents\u2026\n            \u251c\u2500\u2500 partition@c000   Each child node of the fixed-partitions node represents\u2026\n            \u251c\u2500\u2500 partition@82000  Each child node of the fixed-partitions node represents\u2026\n            \u2514\u2500\u2500 partition@f8000  Each child node of the fixed-partitions node represents\u2026\n\nYou can use it with:\n\n- all DTS files generated by **Zephyr** at build-time (aka ``build/zephyr/zephyr.dts``)\n- arbitrary DTS files with bindings compatible with Zephyr's `Devicetre bindings syntax <https://docs.zephyrproject.org/latest/build/dts/bindings-syntax.html>`_\n\nStatus\n******\n\nDTSh 0.2.x mirror and package the code base that serves as a proposal to upstream DTSh\nas a new Zephyr extension to West: `RFC - DTSh, shell-like interface with Devicetree <https://github.com/zephyrproject-rtos/zephyr/pull/59863>`_\n\nThis is the stable and maintained branch: if you have DTSh 0.1.x installed, please upgrade with\ne.g. ``pip install -U dtsh``.\n\nPlease refer to the `DTSh project documentation <http://dottspina.github.io/dtsh>`_.\n",
    "bugtrack_url": null,
    "license": "Apache License version 2.0",
    "summary": "Shell-like interface with Zephyr Devicetree",
    "version": "0.2.1",
    "project_urls": {
        "Homepage": "https://github.com/dottspina/dtsh"
    },
    "split_keywords": [
        "devicetree",
        "zephyr",
        "dts",
        "embedded"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ecc4d6988b2afb54d5d25e0a417f678ea56599a14759236e4386c64b29eb93b9",
                "md5": "e9cc996efb3e9331d449a6eebe5d2da1",
                "sha256": "862c25e5e8dcaf6974e7540fc4e4ab5b06a320bee9c043141863828ce6918c85"
            },
            "downloads": -1,
            "filename": "dtsh-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e9cc996efb3e9331d449a6eebe5d2da1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 181074,
            "upload_time": "2024-03-13T03:16:17",
            "upload_time_iso_8601": "2024-03-13T03:16:17.312733Z",
            "url": "https://files.pythonhosted.org/packages/ec/c4/d6988b2afb54d5d25e0a417f678ea56599a14759236e4386c64b29eb93b9/dtsh-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "04aa175711a260109726b739ec1fc4a4d710339b71a9d9140e95cc049fc73c46",
                "md5": "22c06f5de8329e86eee9d7ae787f6cc9",
                "sha256": "ed23bbc44f91f0642faa173a860234fba12171d573a15a1f923b72137f6d36c7"
            },
            "downloads": -1,
            "filename": "dtsh-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "22c06f5de8329e86eee9d7ae787f6cc9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 196122,
            "upload_time": "2024-03-13T03:16:19",
            "upload_time_iso_8601": "2024-03-13T03:16:19.545444Z",
            "url": "https://files.pythonhosted.org/packages/04/aa/175711a260109726b739ec1fc4a4d710339b71a9d9140e95cc049fc73c46/dtsh-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-13 03:16:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "dottspina",
    "github_project": "dtsh",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "PyYAML",
            "specs": []
        },
        {
            "name": "rich",
            "specs": []
        },
        {
            "name": "gnureadline",
            "specs": []
        }
    ],
    "lcname": "dtsh"
}
        
Elapsed time: 0.22954s