# MrBenn Toolbar Plugin
<p align="center">
<img alt="MrBenn explainer animation" src="https://github.com/andytwoods/mrbenn/blob/main/.github/images/mrbenn.gif?raw=true">
</p>
<p align="center">
Saving you 10 seconds, 100 times a day.
</p>
<p align="center">
<a href="https://mrbenn.readthedocs.io/en/latest/index.html">Docs</a> |
<a href="https://pypi.org/project/mrbenn-toolbar-plugin/">Install</a> |
<a href="https://github.com/andytwoods/mrbenn/projects/1">Contribute</a>
</p>
The MrBenn Toolbar Plugin is an addon for the Django Debug Toolbar which allows you to quickly open template files and
views in your IDE.
<p align="center">
<img alt="MrBenn demo" src="https://github.com/andytwoods/mrbenn/blob/main/.github/images/panel.jpg?raw=true">
</p>
## Installation
To install the MrBenn, you can use `pip`! Simply follow the command below:
```pip install mrbenn-toolbar-plugin```
After the package has been installed, head over to your settings.py. You need to add the following:
- in ``INSTALLED_APPS`` add ``mrbenn_panel``
- under ``DEBUG_TOOLBARS`` add ``mrbenn_panel.panel.MrBennPanel``. We recommend you remove
`debug_toolbar.panels.staticfiles.StaticFilesPanel`.
- finally, in your `env` file, you need to add the location of the IDE you would like to use to open files with an
option called ``DJANGO_WINDOWS_IDE``. For example, the setting for the PyCharm Interpreter would
be `DJANGO_WINDOWS_IDE=C:\Program Files\JetBrains\PyCharm 2021.1.3\bin\pycharm64.exe`.
## Limitations and next steps
Do not use this package in production. Do not use Django-Debug-Toolbar in production either! In this package, Template
file-system location information is sent to the backend via a url-parameter. As it stands, any files on your file system
could be opened by manipulating this parameter. An easy pull-request would be to check that a file to be opened exists
within the current project, before opening it.
Django-debug-toolbar cleverly uses keys instead of raw file system information (
see [here](https://github.com/jazzband/django-debug-toolbar/blob/5665d6808ce0780d2594157684dd6869d1e048a5/debug_toolbar/panels/templates/views.py#L19))
. This would also be good next step for this package to implement.
## Requirements
On top of Django, MrBenn requires the Django Debug Toolbar package found
[here](https://github.com/jazzband/django-debug-toolbar).
## How to contribute?
All contributions are appreciated! To contribute, simply create a new branch with your contribution and raise a PR! You
can ping @andywoods should any issues arize!
Should you get stuck on something, we also have a contributing section in our wiki! LINK TBD
## What's with the name?
Mr Benn was a kids UK TV show from the 70s ([wikipedia](https://en.wikipedia.org/wiki/Mr_Benn)). The main character, Mr
Benn, on each episode walked through a magical door which took him on different adventures. Perhaps I was thinking that
this package in a similar fashion performs a little IDE magic, transporting you to the right file, each time you click
the link to your current view or template. #ModernKidsTVshowsSuck #CBEEBIESthoughRocks
Raw data
{
"_id": null,
"home_page": "https://github.com/andytwoods/mrbenn",
"name": "mrbenn-toolbar-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Andy Woods",
"author_email": "Andy Woods <andytwoods@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0c/3c/7097f48526cac88a642c661a32ca7548783e632b9a3f3a02f51e7045fd0e/mrbenn-toolbar-plugin-0.0.2.tar.gz",
"platform": null,
"description": "# MrBenn Toolbar Plugin\r\n\r\n<p align=\"center\">\r\n <img alt=\"MrBenn explainer animation\" src=\"https://github.com/andytwoods/mrbenn/blob/main/.github/images/mrbenn.gif?raw=true\">\r\n</p>\r\n\r\n<p align=\"center\">\r\nSaving you 10 seconds, 100 times a day.\r\n</p>\r\n\r\n<p align=\"center\">\r\n <a href=\"https://mrbenn.readthedocs.io/en/latest/index.html\">Docs</a> |\r\n <a href=\"https://pypi.org/project/mrbenn-toolbar-plugin/\">Install</a> |\r\n <a href=\"https://github.com/andytwoods/mrbenn/projects/1\">Contribute</a> \r\n</p>\r\n\r\nThe MrBenn Toolbar Plugin is an addon for the Django Debug Toolbar which allows you to quickly open template files and\r\nviews in your IDE.\r\n\r\n<p align=\"center\">\r\n<img alt=\"MrBenn demo\" src=\"https://github.com/andytwoods/mrbenn/blob/main/.github/images/panel.jpg?raw=true\">\r\n</p>\r\n\r\n## Installation\r\n\r\nTo install the MrBenn, you can use `pip`! Simply follow the command below:\r\n\r\n```pip install mrbenn-toolbar-plugin```\r\n\r\nAfter the package has been installed, head over to your settings.py. You need to add the following:\r\n\r\n- in ``INSTALLED_APPS`` add ``mrbenn_panel``\r\n- under ``DEBUG_TOOLBARS`` add ``mrbenn_panel.panel.MrBennPanel``. We recommend you remove\r\n `debug_toolbar.panels.staticfiles.StaticFilesPanel`.\r\n- finally, in your `env` file, you need to add the location of the IDE you would like to use to open files with an\r\n option called ``DJANGO_WINDOWS_IDE``. For example, the setting for the PyCharm Interpreter would\r\n be `DJANGO_WINDOWS_IDE=C:\\Program Files\\JetBrains\\PyCharm 2021.1.3\\bin\\pycharm64.exe`.\r\n\r\n## Limitations and next steps\r\n\r\nDo not use this package in production. Do not use Django-Debug-Toolbar in production either! In this package, Template\r\nfile-system location information is sent to the backend via a url-parameter. As it stands, any files on your file system\r\ncould be opened by manipulating this parameter. An easy pull-request would be to check that a file to be opened exists\r\nwithin the current project, before opening it.\r\n\r\nDjango-debug-toolbar cleverly uses keys instead of raw file system information (\r\nsee [here](https://github.com/jazzband/django-debug-toolbar/blob/5665d6808ce0780d2594157684dd6869d1e048a5/debug_toolbar/panels/templates/views.py#L19))\r\n. This would also be good next step for this package to implement.\r\n\r\n## Requirements\r\n\r\nOn top of Django, MrBenn requires the Django Debug Toolbar package found\r\n[here](https://github.com/jazzband/django-debug-toolbar).\r\n\r\n## How to contribute?\r\n\r\nAll contributions are appreciated! To contribute, simply create a new branch with your contribution and raise a PR! You\r\ncan ping @andywoods should any issues arize!\r\n\r\nShould you get stuck on something, we also have a contributing section in our wiki! LINK TBD\r\n\r\n## What's with the name?\r\n\r\nMr Benn was a kids UK TV show from the 70s ([wikipedia](https://en.wikipedia.org/wiki/Mr_Benn)). The main character, Mr\r\nBenn, on each episode walked through a magical door which took him on different adventures. Perhaps I was thinking that\r\nthis package in a similar fashion performs a little IDE magic, transporting you to the right file, each time you click\r\nthe link to your current view or template. #ModernKidsTVshowsSuck #CBEEBIESthoughRocks\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An addon for Django Debug Toolbar that allows for directly opening static files and views",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/andytwoods/mrbenn"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ddaa83a5bcc9f7dc68c8884f0ae067ed4896541b03a877923f2883d56d4bf2f6",
"md5": "dc72ff51576d387d0f7ae6b403f1d4a9",
"sha256": "20edea949e7b6c60893d0e4f35df3c77153774758117fe3e3a0467a3bfd30cf3"
},
"downloads": -1,
"filename": "mrbenn_toolbar_plugin-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc72ff51576d387d0f7ae6b403f1d4a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9289,
"upload_time": "2023-09-13T08:38:43",
"upload_time_iso_8601": "2023-09-13T08:38:43.055955Z",
"url": "https://files.pythonhosted.org/packages/dd/aa/83a5bcc9f7dc68c8884f0ae067ed4896541b03a877923f2883d56d4bf2f6/mrbenn_toolbar_plugin-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c3c7097f48526cac88a642c661a32ca7548783e632b9a3f3a02f51e7045fd0e",
"md5": "c18ed2592bdcc0f71df9284e487b8af9",
"sha256": "90392aedcdc0b7cc99333273c1e8ff06da02a60e667b513ef5ad1a2ce1a8cc9d"
},
"downloads": -1,
"filename": "mrbenn-toolbar-plugin-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "c18ed2592bdcc0f71df9284e487b8af9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 12068,
"upload_time": "2023-09-13T08:38:45",
"upload_time_iso_8601": "2023-09-13T08:38:45.687498Z",
"url": "https://files.pythonhosted.org/packages/0c/3c/7097f48526cac88a642c661a32ca7548783e632b9a3f3a02f51e7045fd0e/mrbenn-toolbar-plugin-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-13 08:38:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "andytwoods",
"github_project": "mrbenn",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "mrbenn-toolbar-plugin"
}
JSON
