grokui.admin: A basic grok admin UI
***********************************
The replacement for the former ``grok.admin`` package.
The internal name of the admin UI is:
Grok Application Interface Application or, for short GAIA.
GAIA is itself a Grok application and a subproject to the core Grok
development. Its main goal is making developing of Zope 3 and Grok
applications a faster and smarter job with more fun for everybody.
Login - what is my username/password?
=====================================
Before you can use the admin UI, you first must log in.
The username and password of the manager principal (kind of super
user) can be found in the file ``buildout.cfg`` in the root of your
subversion checkout.
In case you do not know, what 'subversion checkout' means, look for a
file ``site.zcml`` in your installation.
Users of ``grokproject``, might find this file in
``<installdir>/parts/app/site.zcml``.
Using the admin-UI
==================
After login you can visit some of the main management topics, as
described below:
On top of the admin-UI you can always find three links to the main
management activities currently possible with GAIA:
Applications
------------
* List of all instanciated applications
* You can add new instances of Grok applications
* You can rename instances of Grok applications
* You can delete your installed applications.
.. note:: starting with version 0.5 there is no introspector/class
browser included in `grokui.admin` anymore. Eventually this will be
made available in another package by someone else.
Server
------
* Set security notifications. Those are by default disabled, because
they mean home-calling functionality you may do not want. You can
enable/disable those notifications or set a URL to retrieve
information about security related problems.
* Start/Restart the server. Caution! This does not work, if the server
was started in 'foreground mode' (with 'zopectl fg').
* Pack the ZODB. This removes old data from the database, freeing up
disk space. In a production environment, you might want to pack the
ZODB automatically from `cron`. This can be done using a command
like the following::
curl -q -s -u admin:admin "http://localhost:8080/++grokui++/@@server?pack=1&days=1"
which will remove old data older than one day. If you leave out the
`days` parameter, all old data will be removed.
* Get basic information about the running Zope system.
* Enter a message to be displayed on top. You can, for example, leave
a message here for your co-admins. To delete the message, just enter
the empty string in the appropriate input box.
Maintaining grok installations with the admin UI
================================================
There are some special info views available especially for the use of
system administrators that want to automate Grok administration in
some aspects. They provide minimal information about certain topics.
Currently the following infos are available this way:
* The grok version working in background::
curl -q -s -u admin:admin "http://localhost:8080/++grokui++/@@admin/@@version"
* The security notification (if any)::
curl -q -s -u admin:admin "http://localhost:8080/++grokui++/@@admin/@@secnote"
Beside this you can pack the ZODB databases as described above.
grokui.admin changes
********************
1.0 (2023-08-28)
================
- Drop support for Python 2.7, 3.5, 3.6.
- Add support for Python 3.7, 3.8, 3.9, 3.10, 3.11.
- Caution: With this release the maintenance of this package ends.
0.13 (2020-08-20)
=================
- Python3.6+ compatibility.
0.12 (2016-02-16)
=================
- Update to follow API changes in grok.
- Update tests.
0.11 (2012-05-02)
=================
- Make sure to require the latest grok and grokcore.site.
0.10 (2011-07-14)
=================
- Nothing changed yet.
0.9 (2011-01-20)
================
- Use the correct IApplication interface definition.
0.8 (2010-10-27)
================
- In testing the security notifications, start a server instead of using
file://localhost URLs. This saves a lot of urlopen troubles across
platforms.
- Test setup cleanup.
0.7.2 (2010-10-26)
==================
- Fix tests in Windows.
0.7.1 (2010-10-07)
==================
* Fix a bug in the test setup where zope.session was not configurred.
* Fix https://bugs.launchpad.net/grok/+bug/638763
We don't hide away Duplication/KeyErrors that are raised during
application creation any more.
0.7.0 (2010-07-04)
==================
* The application creation view now uses the Grok util function
`create_application`. Therefore, the `ApplicationInitializedEvent`,
recently introduced in Grok, is now triggered while an application is
created and persisted. This is an important event, allowing to hook
handlers that need local utilities and catalog indexes that are not
yet present at the ObjectCreatedEvent stage.
0.6.2 (2010-05-19)
==================
* Modified package to comply with Zope Foundation policy.
* Removed duplicated/unused code.
Fix https://bugs.launchpad.net/grok/+bug/539940
* Reflect changes in Folder API: check also for KeyError, not only for
DuplicationError when adding new apps.
* Added extra-templatedirs and moved templates into these in order to
avoid (erraneous) templatedir-registry warnings.
0.6.1 (2010-03-07)
==================
* Added missing tests dependencies. Declarations and includes should
now be complete.
0.6 (2010-02-28)
================
* Moved the ``Index`` view to ``grokui.base``.
* The design has been slightly changed to get rid of the lazy Grok and
to match the http://grok.zope.org website design. The design belongs
now to ``grokui.base``.
* ``grokui.admin`` has been splitted into several packages. It now depends
on ``grokui.base`` that provides basic components to create and plug UI
views. ``grokui.admin`` has been altered to reflect the splitting
changes and now provides a collection of components that will allow
you to plug your own administration panels and elements.
* Dependencies have been drastically cut down. We are now using the
ZTK. The only zope.app package remaining is for the tests.
* Reflect the changes in grokcore.view 1.12 where View and CodeView
become a single View again.
0.5 (2009-09-15)
================
Feature changes
---------------
* The whole introspector stuff was removed in order to reduce number
of dependencies.
Bug fixes
---------
* Adding apps now emits IObjectCreated events.
0.4.1 (2010-02-14)
==================
Bug fixes
---------
* Backports of fixes from 0.3.3 version (see below).
0.4 (2009-08-21)
================
Feature changes
---------------
* Added a security notifier to inform users when security issues are
published on http://grok.zope.org. The notifier must be explicitly
enabled. You can also run your own site/directory to place security
notifications.
* Added info views to get important information easier with tools like
``curl``. Supported infos:
- Grok version used
- Current security notification (if any).
Bug fixes
---------
* Adapting this package to use the new version of grokcore.view
which splits View into CodeView.
* Upgraded the versions to the alpha 4 list to avoid a dependency
problem with zope.container versions.
* Include the new grok.View permissions for testing.
0.3.3 (2010-02-14)
==================
Bug fixes
---------
* Fixed bug in object browser: objects that 'booleanized' evaluated to
``False`` (empty containers for instance) were not displayed.
0.3.2 (2009-04-10)
==================
* Added dependency for zope.app.preference. This is needed by
zope.app.apidoc but not always fetched.
0.3.1 (2009-04-09)
==================
* Fixed missing dependencies in setup.py.
0.3 (2008-12-13)
================
Feature changes
---------------
* Added capability to pack ZODBs (thanks to Jasper Spaans).
0.2 (2008-12-01)
================
Feature changes
---------------
* Added capability to rename apps.
0.1.2 (2008-09-28)
==================
* Made server controls dependent from availability of
`IServerControl`. Otherwise the buttons for restarting or stopping
the server process are not rendered.
0.1.1 (2008-08-05)
==================
* Fixed wrong links in docgrok template.
* Fixed ftesting.zcml that did not work with Grok 0.13.
0.1 (2008-07-10)
================
Feature changes
---------------
Initial implementation by factoring out ``grok.admin`` from ``grok``.
Raw data
{
"_id": null,
"home_page": "https://github.com/zopefoundation/grokui.admin",
"name": "grokui.admin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "zope3 grok grokadmin",
"author": "Zope Foundation and Contributors",
"author_email": "zope-dev@zope.dev",
"download_url": "https://files.pythonhosted.org/packages/38/e7/611667aac6687cbeb8afb239e743896200090bcb5084b8d04009dd4977a3/grokui.admin-1.0.tar.gz",
"platform": null,
"description": "grokui.admin: A basic grok admin UI\n***********************************\n\nThe replacement for the former ``grok.admin`` package.\n\nThe internal name of the admin UI is:\nGrok Application Interface Application or, for short GAIA.\n\nGAIA is itself a Grok application and a subproject to the core Grok\ndevelopment. Its main goal is making developing of Zope 3 and Grok\napplications a faster and smarter job with more fun for everybody.\n\n\nLogin - what is my username/password?\n=====================================\n\nBefore you can use the admin UI, you first must log in.\n\nThe username and password of the manager principal (kind of super\nuser) can be found in the file ``buildout.cfg`` in the root of your\nsubversion checkout.\n\nIn case you do not know, what 'subversion checkout' means, look for a\nfile ``site.zcml`` in your installation.\n\nUsers of ``grokproject``, might find this file in\n``<installdir>/parts/app/site.zcml``.\n\n\nUsing the admin-UI\n==================\n\nAfter login you can visit some of the main management topics, as\ndescribed below:\n\nOn top of the admin-UI you can always find three links to the main\nmanagement activities currently possible with GAIA:\n\n\nApplications\n------------\n\n* List of all instanciated applications\n\n* You can add new instances of Grok applications\n\n* You can rename instances of Grok applications\n\n* You can delete your installed applications.\n\n.. note:: starting with version 0.5 there is no introspector/class\n browser included in `grokui.admin` anymore. Eventually this will be\n made available in another package by someone else.\n\n\nServer\n------\n\n* Set security notifications. Those are by default disabled, because\n they mean home-calling functionality you may do not want. You can\n enable/disable those notifications or set a URL to retrieve\n information about security related problems.\n\n* Start/Restart the server. Caution! This does not work, if the server\n was started in 'foreground mode' (with 'zopectl fg').\n\n* Pack the ZODB. This removes old data from the database, freeing up\n disk space. In a production environment, you might want to pack the\n ZODB automatically from `cron`. This can be done using a command\n like the following::\n\n curl -q -s -u admin:admin \"http://localhost:8080/++grokui++/@@server?pack=1&days=1\"\n\n which will remove old data older than one day. If you leave out the\n `days` parameter, all old data will be removed.\n\n* Get basic information about the running Zope system.\n\n* Enter a message to be displayed on top. You can, for example, leave\n a message here for your co-admins. To delete the message, just enter\n the empty string in the appropriate input box.\n\n\n\nMaintaining grok installations with the admin UI\n================================================\n\nThere are some special info views available especially for the use of\nsystem administrators that want to automate Grok administration in\nsome aspects. They provide minimal information about certain topics.\n\nCurrently the following infos are available this way:\n\n* The grok version working in background::\n\n curl -q -s -u admin:admin \"http://localhost:8080/++grokui++/@@admin/@@version\"\n\n* The security notification (if any)::\n\n curl -q -s -u admin:admin \"http://localhost:8080/++grokui++/@@admin/@@secnote\"\n\nBeside this you can pack the ZODB databases as described above.\n\n\ngrokui.admin changes\n********************\n\n1.0 (2023-08-28)\n================\n\n- Drop support for Python 2.7, 3.5, 3.6.\n\n- Add support for Python 3.7, 3.8, 3.9, 3.10, 3.11.\n\n- Caution: With this release the maintenance of this package ends.\n\n\n0.13 (2020-08-20)\n=================\n\n- Python3.6+ compatibility.\n\n0.12 (2016-02-16)\n=================\n\n- Update to follow API changes in grok.\n\n- Update tests.\n\n0.11 (2012-05-02)\n=================\n\n- Make sure to require the latest grok and grokcore.site.\n\n0.10 (2011-07-14)\n=================\n\n- Nothing changed yet.\n\n0.9 (2011-01-20)\n================\n\n- Use the correct IApplication interface definition.\n\n0.8 (2010-10-27)\n================\n\n- In testing the security notifications, start a server instead of using\n file://localhost URLs. This saves a lot of urlopen troubles across\n platforms.\n\n- Test setup cleanup.\n\n0.7.2 (2010-10-26)\n==================\n\n- Fix tests in Windows.\n\n0.7.1 (2010-10-07)\n==================\n\n* Fix a bug in the test setup where zope.session was not configurred.\n\n* Fix https://bugs.launchpad.net/grok/+bug/638763\n We don't hide away Duplication/KeyErrors that are raised during\n application creation any more.\n\n0.7.0 (2010-07-04)\n==================\n\n* The application creation view now uses the Grok util function\n `create_application`. Therefore, the `ApplicationInitializedEvent`,\n recently introduced in Grok, is now triggered while an application is\n created and persisted. This is an important event, allowing to hook\n handlers that need local utilities and catalog indexes that are not\n yet present at the ObjectCreatedEvent stage.\n\n0.6.2 (2010-05-19)\n==================\n\n* Modified package to comply with Zope Foundation policy.\n\n* Removed duplicated/unused code.\n Fix https://bugs.launchpad.net/grok/+bug/539940\n\n* Reflect changes in Folder API: check also for KeyError, not only for\n DuplicationError when adding new apps.\n\n* Added extra-templatedirs and moved templates into these in order to\n avoid (erraneous) templatedir-registry warnings.\n\n0.6.1 (2010-03-07)\n==================\n\n* Added missing tests dependencies. Declarations and includes should\n now be complete.\n\n\n0.6 (2010-02-28)\n================\n\n* Moved the ``Index`` view to ``grokui.base``.\n\n* The design has been slightly changed to get rid of the lazy Grok and\n to match the http://grok.zope.org website design. The design belongs\n now to ``grokui.base``.\n\n* ``grokui.admin`` has been splitted into several packages. It now depends\n on ``grokui.base`` that provides basic components to create and plug UI\n views. ``grokui.admin`` has been altered to reflect the splitting\n changes and now provides a collection of components that will allow\n you to plug your own administration panels and elements.\n\n* Dependencies have been drastically cut down. We are now using the\n ZTK. The only zope.app package remaining is for the tests.\n\n* Reflect the changes in grokcore.view 1.12 where View and CodeView\n become a single View again.\n\n\n0.5 (2009-09-15)\n================\n\nFeature changes\n---------------\n\n* The whole introspector stuff was removed in order to reduce number\n of dependencies.\n\nBug fixes\n---------\n\n* Adding apps now emits IObjectCreated events.\n\n\n0.4.1 (2010-02-14)\n==================\n\nBug fixes\n---------\n\n* Backports of fixes from 0.3.3 version (see below).\n\n\n0.4 (2009-08-21)\n================\n\nFeature changes\n---------------\n\n* Added a security notifier to inform users when security issues are\n published on http://grok.zope.org. The notifier must be explicitly\n enabled. You can also run your own site/directory to place security\n notifications.\n\n* Added info views to get important information easier with tools like\n ``curl``. Supported infos:\n\n - Grok version used\n\n - Current security notification (if any).\n\nBug fixes\n---------\n\n* Adapting this package to use the new version of grokcore.view\n which splits View into CodeView.\n\n* Upgraded the versions to the alpha 4 list to avoid a dependency\n problem with zope.container versions.\n\n* Include the new grok.View permissions for testing.\n\n0.3.3 (2010-02-14)\n==================\n\nBug fixes\n---------\n\n* Fixed bug in object browser: objects that 'booleanized' evaluated to\n ``False`` (empty containers for instance) were not displayed.\n\n0.3.2 (2009-04-10)\n==================\n\n* Added dependency for zope.app.preference. This is needed by\n zope.app.apidoc but not always fetched.\n\n0.3.1 (2009-04-09)\n==================\n\n* Fixed missing dependencies in setup.py.\n\n0.3 (2008-12-13)\n================\n\nFeature changes\n---------------\n\n* Added capability to pack ZODBs (thanks to Jasper Spaans).\n\n0.2 (2008-12-01)\n================\n\nFeature changes\n---------------\n\n* Added capability to rename apps.\n\n0.1.2 (2008-09-28)\n==================\n\n* Made server controls dependent from availability of\n `IServerControl`. Otherwise the buttons for restarting or stopping\n the server process are not rendered.\n\n\n0.1.1 (2008-08-05)\n==================\n\n* Fixed wrong links in docgrok template.\n\n* Fixed ftesting.zcml that did not work with Grok 0.13.\n\n\n0.1 (2008-07-10)\n================\n\nFeature changes\n---------------\n\nInitial implementation by factoring out ``grok.admin`` from ``grok``.\n",
"bugtrack_url": null,
"license": "ZPL 2.1",
"summary": "The Grok administration and development UI",
"version": "1.0",
"project_urls": {
"Homepage": "https://github.com/zopefoundation/grokui.admin"
},
"split_keywords": [
"zope3",
"grok",
"grokadmin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "089f7692a8f3638e1ae533fb56e908c88230331431dff5c352c11007555ee37a",
"md5": "1567d1be53149c6ee083414efabc3086",
"sha256": "279a20c3ccbc6438be7c5df4681f31c84057ba4e4a194636d04c9d8e0a9782a7"
},
"downloads": -1,
"filename": "grokui.admin-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1567d1be53149c6ee083414efabc3086",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 30907,
"upload_time": "2023-08-28T12:24:02",
"upload_time_iso_8601": "2023-08-28T12:24:02.661251Z",
"url": "https://files.pythonhosted.org/packages/08/9f/7692a8f3638e1ae533fb56e908c88230331431dff5c352c11007555ee37a/grokui.admin-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "38e7611667aac6687cbeb8afb239e743896200090bcb5084b8d04009dd4977a3",
"md5": "382e27b09f28d4352517bcf6de148f27",
"sha256": "163db3107e1b0a2a47c3bf6676fb936b800c5ee012448ac62402210929d61d30"
},
"downloads": -1,
"filename": "grokui.admin-1.0.tar.gz",
"has_sig": false,
"md5_digest": "382e27b09f28d4352517bcf6de148f27",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 28864,
"upload_time": "2023-08-28T12:24:04",
"upload_time_iso_8601": "2023-08-28T12:24:04.093702Z",
"url": "https://files.pythonhosted.org/packages/38/e7/611667aac6687cbeb8afb239e743896200090bcb5084b8d04009dd4977a3/grokui.admin-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-28 12:24:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zopefoundation",
"github_project": "grokui.admin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "grokui.admin"
}
JSON
