| Name | explainable JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | None |
| Summary | Visualise complex data structures in real time |
| upload_time | 2024-07-20 18:28:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License
Copyright (c) 2024 Numan
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 |
data structures
debug
debugger
debugging
explainable
visualisation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Explainable
[](https://pypi.org/project/explainable/)
Explainable is a project for visualising complex data structures in real time with minimal effort.
This project was created by [Numan Team](https://numan.ai/).
## Installation
```sh
pip install -U explainable
```
## Usage
1. Install using `pip`
2. Import the library in your code
3. Add `explainable.init()` in your code to start the server
4. Select data to observe with `data = explainable.observe("my_view", data)`
5. Go to https://explainable.numan.ai/
```python
import time
import explainable
# start the server
explainable.init()
# create your data
lst = [0, 1, 2]
# start observing
lst = explainable.observe("view1", lst)
# change your data
while True:
lst[0] += 1
lst[1] -= 1
time.sleep(1)
```
Currently supported data structures:
- dataclass
- list
- dict
- enums
## Requirements
Python 3.7 or higher.
Raw data
{
"_id": null,
"home_page": null,
"name": "explainable",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Numan Team <kostya@numan.ai>",
"keywords": "data structures, debug, debugger, debugging, explainable, visualisation",
"author": null,
"author_email": "Numan Team <kostya@numan.ai>",
"download_url": "https://files.pythonhosted.org/packages/9a/32/fdc40ee9050d3e48dc4a4bc0125d06ce39f12f2fd4fde2aefafcf2b62cf0/explainable-0.5.1.tar.gz",
"platform": null,
"description": "# Explainable\n\n[](https://pypi.org/project/explainable/)\n\nExplainable is a project for visualising complex data structures in real time with minimal effort. \nThis project was created by [Numan Team](https://numan.ai/).\n\n\n\n## Installation\n\n```sh\npip install -U explainable\n```\n\n## Usage\n\n1. Install using `pip`\n2. Import the library in your code\n3. Add `explainable.init()` in your code to start the server\n4. Select data to observe with `data = explainable.observe(\"my_view\", data)`\n5. Go to https://explainable.numan.ai/\n\n```python\nimport time\n\nimport explainable\n\n# start the server\nexplainable.init()\n\n# create your data\nlst = [0, 1, 2]\n\n# start observing\nlst = explainable.observe(\"view1\", lst)\n\n# change your data\nwhile True:\n lst[0] += 1\n lst[1] -= 1\n\n time.sleep(1)\n```\n\n\n\nCurrently supported data structures:\n- dataclass\n- list\n- dict\n- enums\n\n## Requirements\n\nPython 3.7 or higher.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2024 Numan\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Visualise complex data structures in real time",
"version": "0.5.1",
"project_urls": {
"Changelog": "https://github.com/numan-ai/explainable/blob/master/CHANGELOG.md",
"Documentation": "https://example.com",
"Homepage": "https://github.com/numan-ai/explainable",
"Issues": "https://github.com/numan-ai/explainable/issues",
"Repository": "https://github.com/numan-ai/explainable.git"
},
"split_keywords": [
"data structures",
" debug",
" debugger",
" debugging",
" explainable",
" visualisation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3faff372ea266d04f5af787b2aeacab728e8fc379b15199c45196ca50c3417bb",
"md5": "8734bb50bb8e9bf82d6526ecdee877e1",
"sha256": "581b9fc03bc4fa60ee8edcf3cbd5064034707da4feb2e0ccf45b8a90e6b8a58d"
},
"downloads": -1,
"filename": "explainable-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8734bb50bb8e9bf82d6526ecdee877e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10730,
"upload_time": "2024-07-20T18:28:14",
"upload_time_iso_8601": "2024-07-20T18:28:14.025205Z",
"url": "https://files.pythonhosted.org/packages/3f/af/f372ea266d04f5af787b2aeacab728e8fc379b15199c45196ca50c3417bb/explainable-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9a32fdc40ee9050d3e48dc4a4bc0125d06ce39f12f2fd4fde2aefafcf2b62cf0",
"md5": "7709063bcc15c69ad941e1e38a24a1e7",
"sha256": "a91edcb3a1d0e5f0dd07a9c9d11deff6b4e1ac0e2fe93a0bc999b46a0111c2e2"
},
"downloads": -1,
"filename": "explainable-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "7709063bcc15c69ad941e1e38a24a1e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9709958,
"upload_time": "2024-07-20T18:28:20",
"upload_time_iso_8601": "2024-07-20T18:28:20.915854Z",
"url": "https://files.pythonhosted.org/packages/9a/32/fdc40ee9050d3e48dc4a4bc0125d06ce39f12f2fd4fde2aefafcf2b62cf0/explainable-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-20 18:28:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "numan-ai",
"github_project": "explainable",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "explainable"
}
