Introduction
============
``plone.app.debugtoolbar`` provides a wealth of debug information about a
running Plone site at your fingertips.
Translations
============
This product has been translated into
- Italian (thanks, Giacomo Spettoli)
- Spanish (thanks, Leonardo J. Caballero G.)
Installation
============
Simply install it in your build (e.g. by adding it to the ``eggs`` list in your Buildout):
::
[buildout]
...
eggs =
plone.app.debugtoolbar
and re-running the ``bin/buildout`` command and install it into your Plone site.
You should now see a ``Debug`` link at the top of your site. Click it to open
the debug drawer. Click on a panel to view relevant information.
Panels include:
* Context, showing information about the current content object
* Interactive, providing an interactive Python prompt through which you can
interact with the current context (only available to users with the
``Manage portal`` permission)
* Request, showing information about the request that produced the current page
* Response, showing information about the response that produced the current
page
* Published, showing information about the page template or view that was
published
* Theme, showing information about the current theme and browser layers
* User, showing information about the current user
* Workflow, showing information about workflow and security
* Zope, showing information about how the Zope server is configured
* Versions, listing the versions of every package known to the Zope process
Safety
======
The debug toolbar provides a lot of information about your Plone site that you
may not want the world to know. It could also have a noticeable performance
impact, and for users with the ``Manage portal`` permission it provides access
to an interactive interpreter where arbitrary Python statements can be executed,
allowing a user to bypass Zope security.
In other words: **Do not install this package on your production server**.
Integration
===========
Each panels is included as a viewlet. You can register new panels using a
viewlet registration like this:
::
<browser:viewlet
name="plone.app.debugtoolbar.somepanel"
manager="plone.app.debugtoolbar.browser.interfaces.IDebugToolbarViewletManager"
class=".somepanel.SomePanelViewlet"
template="somepanel.pt"
permission="zope2.View"
layer="plone.app.debugtoolbar.browser.interfaces.IDebugToolbarLayer"
/>
See ``plone.app.debugtoolbar.browser`` for plenty of examples of panels.
Contribute
----------
- Issue Tracker: https://github.com/plone/plone.app.debugtoolbar/issues
- Source Code: https://github.com/plone/plone.app.debugtoolbar
- Documentation: https://github.com/plone/plone.app.debugtoolbar/blob/master/README.rst
License
-------
The project is licensed under the GPLv2.
Contributors
============
- Martin Aspeli, Author
- Giacomo Spettoli, i18n
- Leonardo Caballero, Spanish Translation, Uninstall GenericSetup profile
All the list of contributors is available at the following link: https://github.com/plone/plone.app.debugtoolbar/graphs/contributors
Changelog
=========
.. You should *NOT* be adding new change log entries to this file.
You should create a file in the news directory instead.
For helpful instructions, please see:
https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
.. towncrier release notes start
1.4.0 (2024-03-19)
------------------
New features:
- Added more improvements about i18n support [macagua]
Updated Spanish translation [macagua]
Updated the documentation [macagua]
Upgraded the buildout configuration to Plone 6.0 version [macagua] (#31)
1.3.0 (2022-12-02)
------------------
Bug fixes:
- Add support for Python 3.11 [pbauer] (#30)
1.2.3 (2021-12-29)
------------------
Bug fixes:
- Fix missing zcml directive when `plone.app.standardtiles` is installed.
[petschki] (#18)
- Fix brackets in toolbar-help
[djowett] (#25)
- Fix a compatibility issue with Python 3.8 (#27)
1.2.2 (2020-04-20)
------------------
Bug fixes:
- Minor packaging updates. (#1)
1.2.0 (2019-01-09)
------------------
New features:
- Prepare for Python 2 / 3 compatibility [jmevissen]
1.1.4 (2018-03-07)
------------------
Bug fixes:
- Remove unittest2 dependency
[kakshay21]
- Make it work in chrome, as '<script />' no longer works.
[jaroel]
1.1.3 (2017-07-03)
------------------
Bug fixes:
- Fix problem with debugtoolbar panel opening on click but immediately closing again.
[sunew]
1.1.2 (2017-03-31)
------------------
Bug fixes:
- Fix imports from Globals that was removed in Zope4
[pbauer]
- Add coding headers on python files.
[gforcada]
1.1.1 (2016-08-17)
------------------
Bug fixes:
- Use zope.interface decorator.
[gforcada]
1.1.0 (2016-06-07)
------------------
New:
- Add a ``plone.app.debugtoolbar.toolbar`` tile for displaying in plone.app.blocks layouts.
[thet]
- Plone 5 compatibility: Don't register JS and CSS but include them inline.
Includes upgrade step.
[thet]
- Added panel with catalog info: indexed values and metadata of the current
object.
[sunew]
1.0 (2014-08-13)
----------------
- Fix ``scrollHeight`` for the interactive prompt for jQuery 1.7+. Now,
executing code jumps again to the latest prompt message.
[thet]
- Removed 'xxx__roles__' methods from Context / Methods viewlet and added
roles + permission for each method when available.
[glenfant]
- Emphasize marker interfaces in context view
[glenfant]
- Provide same variables as in portal_actions in TAL tests
[glenfant]
- Fix themelayer. Use IBrowserSkinType instead of generic
Interface which can return an real utility instead of an
iface and broke the page rendering. Skin Layer must inherits
from IBrowserSkinType
[toutpt]
1.0a3 (2013-02-06)
------------------
- completed i18n support and added it translation
- add reload panel
[vangheem]
- added Spanish translation and Uninstall GenericSetup profile
[macagua]
- completed i18n support and added it translation
[giacomos]
- replace checkboxes with mark symbols in permission matrix
[gaudenz]
- permission matrix display improvements
[gaudenz]
1.0a2 (13/11/2011)
------------------
- Add interactive code debugging
[optilude]
- Add TALES tester
[optilude]
- Add details of context methods and attributes
[optilude]
1.0a1 (13/11/2011)
------------------
- Initial release
[optilude]
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/plone.app.debugtoolbar/",
"name": "plone.app.debugtoolbar",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*",
"maintainer_email": "",
"keywords": "plone debug toolbar",
"author": "Martin Aspeli",
"author_email": "optilude@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ec/98/79cb00e698f350980909ad806bff13b58fd91a429133079e41536b5cf5ec/plone.app.debugtoolbar-1.4.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n``plone.app.debugtoolbar`` provides a wealth of debug information about a\nrunning Plone site at your fingertips.\n\n\nTranslations\n============\n\nThis product has been translated into\n\n- Italian (thanks, Giacomo Spettoli)\n\n- Spanish (thanks, Leonardo J. Caballero G.)\n\n\nInstallation\n============\n\nSimply install it in your build (e.g. by adding it to the ``eggs`` list in your Buildout):\n\n::\n\n [buildout]\n\n ...\n\n eggs =\n plone.app.debugtoolbar\n\n\nand re-running the ``bin/buildout`` command and install it into your Plone site.\n\nYou should now see a ``Debug`` link at the top of your site. Click it to open\nthe debug drawer. Click on a panel to view relevant information.\n\nPanels include:\n\n* Context, showing information about the current content object\n* Interactive, providing an interactive Python prompt through which you can\n interact with the current context (only available to users with the\n ``Manage portal`` permission)\n* Request, showing information about the request that produced the current page\n* Response, showing information about the response that produced the current\n page\n* Published, showing information about the page template or view that was\n published\n* Theme, showing information about the current theme and browser layers\n* User, showing information about the current user\n* Workflow, showing information about workflow and security\n* Zope, showing information about how the Zope server is configured\n* Versions, listing the versions of every package known to the Zope process\n\nSafety\n======\n\nThe debug toolbar provides a lot of information about your Plone site that you\nmay not want the world to know. It could also have a noticeable performance\nimpact, and for users with the ``Manage portal`` permission it provides access\nto an interactive interpreter where arbitrary Python statements can be executed,\nallowing a user to bypass Zope security.\n\nIn other words: **Do not install this package on your production server**.\n\nIntegration\n===========\n\nEach panels is included as a viewlet. You can register new panels using a\nviewlet registration like this:\n\n::\n\n <browser:viewlet\n name=\"plone.app.debugtoolbar.somepanel\"\n manager=\"plone.app.debugtoolbar.browser.interfaces.IDebugToolbarViewletManager\"\n class=\".somepanel.SomePanelViewlet\"\n template=\"somepanel.pt\"\n permission=\"zope2.View\"\n layer=\"plone.app.debugtoolbar.browser.interfaces.IDebugToolbarLayer\"\n />\n\nSee ``plone.app.debugtoolbar.browser`` for plenty of examples of panels.\n\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/plone/plone.app.debugtoolbar/issues\n- Source Code: https://github.com/plone/plone.app.debugtoolbar\n- Documentation: https://github.com/plone/plone.app.debugtoolbar/blob/master/README.rst\n\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\nContributors\n============\n\n- Martin Aspeli, Author\n- Giacomo Spettoli, i18n\n- Leonardo Caballero, Spanish Translation, Uninstall GenericSetup profile\n\nAll the list of contributors is available at the following link: https://github.com/plone/plone.app.debugtoolbar/graphs/contributors\n\nChangelog\n=========\n\n.. You should *NOT* be adding new change log entries to this file.\n You should create a file in the news directory instead.\n For helpful instructions, please see:\n https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst\n\n.. towncrier release notes start\n\n1.4.0 (2024-03-19)\n------------------\n\nNew features:\n\n\n- Added more improvements about i18n support [macagua]\n\n Updated Spanish translation [macagua]\n\n Updated the documentation [macagua]\n\n Upgraded the buildout configuration to Plone 6.0 version [macagua] (#31)\n\n\n1.3.0 (2022-12-02)\n------------------\n\nBug fixes:\n\n\n- Add support for Python 3.11 [pbauer] (#30)\n\n\n1.2.3 (2021-12-29)\n------------------\n\nBug fixes:\n\n\n- Fix missing zcml directive when `plone.app.standardtiles` is installed.\n [petschki] (#18)\n- Fix brackets in toolbar-help\n [djowett] (#25)\n- Fix a compatibility issue with Python 3.8 (#27)\n\n\n1.2.2 (2020-04-20)\n------------------\n\nBug fixes:\n\n\n- Minor packaging updates. (#1)\n\n\n1.2.0 (2019-01-09)\n------------------\n\nNew features:\n\n- Prepare for Python 2 / 3 compatibility [jmevissen]\n\n\n1.1.4 (2018-03-07)\n------------------\n\nBug fixes:\n\n- Remove unittest2 dependency\n [kakshay21]\n\n- Make it work in chrome, as '<script />' no longer works.\n [jaroel]\n\n\n1.1.3 (2017-07-03)\n------------------\n\nBug fixes:\n\n- Fix problem with debugtoolbar panel opening on click but immediately closing again.\n [sunew]\n\n\n1.1.2 (2017-03-31)\n------------------\n\nBug fixes:\n\n- Fix imports from Globals that was removed in Zope4\n [pbauer]\n\n- Add coding headers on python files.\n [gforcada]\n\n1.1.1 (2016-08-17)\n------------------\n\nBug fixes:\n\n- Use zope.interface decorator.\n [gforcada]\n\n\n1.1.0 (2016-06-07)\n------------------\n\nNew:\n\n- Add a ``plone.app.debugtoolbar.toolbar`` tile for displaying in plone.app.blocks layouts.\n [thet]\n\n- Plone 5 compatibility: Don't register JS and CSS but include them inline.\n Includes upgrade step.\n [thet]\n\n- Added panel with catalog info: indexed values and metadata of the current\n object.\n [sunew]\n\n\n1.0 (2014-08-13)\n----------------\n\n- Fix ``scrollHeight`` for the interactive prompt for jQuery 1.7+. Now,\n executing code jumps again to the latest prompt message.\n [thet]\n\n- Removed 'xxx__roles__' methods from Context / Methods viewlet and added\n roles + permission for each method when available.\n [glenfant]\n\n- Emphasize marker interfaces in context view\n [glenfant]\n\n- Provide same variables as in portal_actions in TAL tests\n [glenfant]\n\n- Fix themelayer. Use IBrowserSkinType instead of generic\n Interface which can return an real utility instead of an\n iface and broke the page rendering. Skin Layer must inherits\n from IBrowserSkinType\n [toutpt]\n\n\n1.0a3 (2013-02-06)\n------------------\n\n- completed i18n support and added it translation\n\n- add reload panel\n [vangheem]\n\n- added Spanish translation and Uninstall GenericSetup profile\n [macagua]\n\n- completed i18n support and added it translation\n [giacomos]\n\n- replace checkboxes with mark symbols in permission matrix\n [gaudenz]\n\n- permission matrix display improvements\n [gaudenz]\n\n1.0a2 (13/11/2011)\n------------------\n\n- Add interactive code debugging\n [optilude]\n\n- Add TALES tester\n [optilude]\n\n- Add details of context methods and attributes\n [optilude]\n\n1.0a1 (13/11/2011)\n------------------\n\n- Initial release\n [optilude]\n\n\n\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Debug toolbar for Plone",
"version": "1.4.0",
"project_urls": {
"Homepage": "https://pypi.org/project/plone.app.debugtoolbar/"
},
"split_keywords": [
"plone",
"debug",
"toolbar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aed142f016ec4787195f6bf95865d386dcdeeffc0a2d43344e7cd69875f4a86a",
"md5": "6a873ecb5022f13204cb749ef3919b9b",
"sha256": "67bee13cea5047798ad793768fdadcd953c4028778bedef51dc1dd26c4796ec4"
},
"downloads": -1,
"filename": "plone.app.debugtoolbar-1.4.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a873ecb5022f13204cb749ef3919b9b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*",
"size": 62343,
"upload_time": "2024-03-19T21:53:22",
"upload_time_iso_8601": "2024-03-19T21:53:22.933522Z",
"url": "https://files.pythonhosted.org/packages/ae/d1/42f016ec4787195f6bf95865d386dcdeeffc0a2d43344e7cd69875f4a86a/plone.app.debugtoolbar-1.4.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec9879cb00e698f350980909ad806bff13b58fd91a429133079e41536b5cf5ec",
"md5": "deba027ad77d2e384fd4b33037106563",
"sha256": "6f42e8123bd5b5471833b4ad650067bbc913a09a2b14a895202138af9fa58561"
},
"downloads": -1,
"filename": "plone.app.debugtoolbar-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "deba027ad77d2e384fd4b33037106563",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*",
"size": 46276,
"upload_time": "2024-03-19T21:53:24",
"upload_time_iso_8601": "2024-03-19T21:53:24.577353Z",
"url": "https://files.pythonhosted.org/packages/ec/98/79cb00e698f350980909ad806bff13b58fd91a429133079e41536b5cf5ec/plone.app.debugtoolbar-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 21:53:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "plone.app.debugtoolbar"
}
JSON