# Textual DOMInfo
## Introduction
This library provides a very simple debugging aid for Textual applications;
designed as a very quick and easy "what widget is under the mouse and how is
it styled" tool.
**TO BE CLEAR:** This isn't a full-blown DOM inspection tool; it's not even
close. It's a quick and dirty but handy bit of code to quickly check what
part of the terminal display belongs to what underlying widget and to see
how it's styled.
## Installing
The package can be installed with `pip` or related tools, for example:
```sh
$ pip install textual-dominfo
```
## Using
As mentioned above, this is only ever intended to be used when trying to
debug something, and also note that it will take over [the
tooltips](https://textual.textualize.io/guide/widgets/#tooltips) of any
widgets it is attached to.
To use, import the class:
```python
from textual_dominfo import DOMInfo
```
and then in your code somewhere, probably in the `on_mount` method of your
application or main screen, attach it like this:
```python
DOMInfo.attach_to(self)
```
This will then install the information tooltip in that widget and all of its
descendants.
To see this in action right away, with the library installed into your
development environment, do this:
```sh
$ python -m textual_dominfo
```
[//]: # (README.md ends here)
Raw data
{
"_id": null,
"home_page": "https://github.com/davep/textual-dominfo",
"name": "textual-dominfo",
"maintainer": "Dave Pearson",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "davep@davep.org",
"keywords": "terminal,library,widget",
"author": "Dave Pearson",
"author_email": "davep@davep.org",
"download_url": "",
"platform": null,
"description": "# Textual DOMInfo\n\n## Introduction\n\nThis library provides a very simple debugging aid for Textual applications;\ndesigned as a very quick and easy \"what widget is under the mouse and how is\nit styled\" tool.\n\n**TO BE CLEAR:** This isn't a full-blown DOM inspection tool; it's not even\nclose. It's a quick and dirty but handy bit of code to quickly check what\npart of the terminal display belongs to what underlying widget and to see\nhow it's styled.\n\n## Installing\n\nThe package can be installed with `pip` or related tools, for example:\n\n```sh\n$ pip install textual-dominfo\n```\n\n## Using\n\nAs mentioned above, this is only ever intended to be used when trying to\ndebug something, and also note that it will take over [the\ntooltips](https://textual.textualize.io/guide/widgets/#tooltips) of any\nwidgets it is attached to.\n\nTo use, import the class:\n\n```python\nfrom textual_dominfo import DOMInfo\n```\n\nand then in your code somewhere, probably in the `on_mount` method of your\napplication or main screen, attach it like this:\n\n```python\nDOMInfo.attach_to(self)\n```\n\nThis will then install the information tooltip in that widget and all of its\ndescendants.\n\nTo see this in action right away, with the library installed into your\ndevelopment environment, do this:\n\n```sh\n$ python -m textual_dominfo\n```\n\n\n\n[//]: # (README.md ends here)\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
"summary": "A simple tool for inspecting Textual widget styles",
"version": "0.1.0",
"project_urls": {
"Discussions": "https://github.com/davep/textual-dominfo/discussions",
"Documentation": "https://github.com/davep/textual-dominfo/blob/main/README.md",
"Homepage": "https://github.com/davep/textual-dominfo",
"Issues": "https://github.com/davep/textual-dominfo/issues",
"Source": "https://github.com/davep/textual-dominfo"
},
"split_keywords": [
"terminal",
"library",
"widget"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "de25309b754b7778cc9b15cef2dcdb5e7e2a83b448b397ed997033b56410af68",
"md5": "10f64e7aec4727a4b2c4620c718c8262",
"sha256": "db60b904db0e92a73e741ecd85418fde9a0d57ac0369cf4e6640746fc602ce53"
},
"downloads": -1,
"filename": "textual_dominfo-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "10f64e7aec4727a4b2c4620c718c8262",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4344,
"upload_time": "2024-01-15T21:22:23",
"upload_time_iso_8601": "2024-01-15T21:22:23.702985Z",
"url": "https://files.pythonhosted.org/packages/de/25/309b754b7778cc9b15cef2dcdb5e7e2a83b448b397ed997033b56410af68/textual_dominfo-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-15 21:22:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davep",
"github_project": "textual-dominfo",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "textual-dominfo"
}
JSON
