This release is a pre-release and may not be stable for production use.
Overview
plone.portlets contains the complete portlet implementation of Plone:
- plone.portlets
A generic infrastructure for managing portlets. Portlets are a bit like viewlets, except they can be manipulated at runtime, using local components.
- plone.app.portlets
The Plone-specific user interface for plone.portlets, as well as the standard set of portlets that ship with Plone.
- plone.portlet.collection
A portlet that fetches results from a collection.
- plone.portlet.static
A portlet providing a rich-text field for more or less static text.
Until version 4.x these were four separate distributions. Since version 5.0.0 (Plone 6.3) they are shipped together in this distribution, see PLIP 4137. The import paths did not change. The distributions plone.app.portlets, plone.portlet.collection and plone.portlet.static are kept on PyPI as empty packages that depend on plone.portlets, so existing dependencies keep working. The code for Plone 6.2 and earlier stays in the former repositories.
Call one portlet by URL
To call a portlet by its URL, for example, to update it via an AJAX call, use the @@render-portlet view in your portlet renderer with portlethash as a query parameter.
The following example shows how to construct a reload URL for a portlet:
from plone.app.portlets.portlets.base import Renderer
from Products.CMFPlone.utils import safe_unicode
class BasePortletRenderer(Renderer):
@property
def hash(self):
portlethash = self.request.form.get(
"portlethash", getattr(self, "__portlet_metadata__", {}).get("hash", "")
)
return portlethash
@property
def reload_url(self):
base_url = self.context.absolute_url()
hash = safe_unicode(self.hash)
return f"{base_url}/@@render-portlet?portlethash={hash}"
Git history
All four former repositories were merged with their complete history. The code was moved into src/ shortly before the merge, so to see the history of a package before that move, pass the old path as well, for example:
git log -- src/plone/app/portlets plone/app/portlets
git log --follow (for single files) and git blame cross the move on their own.
Compatibility
plone.portlets 5.x is for Plone 6.3.
Plone 6.2 uses plone.portlets 4.x, plone.app.portlets 7.x, plone.portlet.collection 5.x and plone.portlet.static 5.x.
Changelog
5.0.0a1 (2026-10-19)
Breaking changes:
Merge plone.app.portlets, plone.portlet.collection and plone.portlet.static into this distribution, with their complete git history. Import paths do not change. The three former distributions are continued as empty packages that depend on plone.portlets. See PLIP 4137. @jensens (#4137)
Internal:
Move package metadata from setup.py to pyproject.toml. [plone devs]
The changelog starts fresh with version 5.0.0, when plone.app.portlets, plone.portlet.collection and plone.portlet.static were merged into this distribution. The changelogs of the four former distributions are kept in docs/archive/.
8 maintainers
Metadata
8 maintainers
Release files for plone.portlets 5.0.0a1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| plone_portlets-5.0.0a1.tar.gz | 154.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| plone_portlets-5.0.0a1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 336.2 kB
Release files / plone_portlets-5.0.0a1.tar.gz
| Download URL | plone_portlets-5.0.0a1.tar.gz |
|---|---|
| Size | 154.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e2b7578cf6a4d64ef4fb04c6c3d404dfc1e8bfaee0ec70a573a27223f08e8d46
|
|
BLAKE2b-256 checksum How to use checksums |
86881ddd2ac94cc1489bd2d57a6c58a394ee57ee5cfd505776540d3d3c17eece
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / plone_portlets-5.0.0a1-py3-none-any.whl
| Download URL | plone_portlets-5.0.0a1-py3-none-any.whl |
|---|---|
| Size | 181.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d69138e792832baed6cda8bb6815ef161811600205ef04d3dd3dbffb4d0b1dd4
|
|
BLAKE2b-256 checksum How to use checksums |
1f0d85a83c63a458349185e859a7ccd9cb365c2608e31b47466f53d00d9584eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Security for plone.portlets 5.0.0a1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
