==========================
eea.progress.editing
==========================
.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.progress.editing/develop
:target: https://ci.eionet.europa.eu/job/eea/job/eea.progress.editing/job/develop/display/redirect
:alt: Develop
.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.progress.editing/master
:target: https://ci.eionet.europa.eu/job/eea/job/eea.progress.editing/job/master/display/redirect
:alt: Master
A Plone add-on that expose editing progress via RestAPI
.. contents::
Main features
=============
1. RestAPI editing progress::
$ curl -H 'Accept: application/json' --user admin:admin -i http://localhost:8080/Plone/a-page/@editing.progress
or
$ curl -H 'Accept: application/json' --user admin:admin -i http://localhost:8080/Plone/a-page?expand=editing.progress
Install
=======
* Add **eea.progress.editing** to your requirements.txt and **constraints.txt** and run::
pip install -r requirements.txt -c constraints.txt
* Or, if using buildout, add **eea.progress.editing** to your eggs section in your buildout and
re-run buildout::
[buildout]
eggs +=
eea.progress.editing
* Or via docker::
$ docker run --rm -p 8080:8080 -e ADDONS="eea.progress.editing" plone/plone-backend
* Restart Plone
* Install **eea.progress.editing** within **Site Setup > Add-ons**
* Configure editing progress via **Control Panel > Editing Progress Settings**
* If you already have **Plone 4** definitions for your Content Types Editing Progress, you can
export them to XML at **/portal_progress/document/view.export** and then use
`xml2dict.py <https://github.com/eea/eea.progress.editing/blob/develop/xml2dict.py>`_ script to
convert them to **Plone 6** registry. The output should look like::
{
"Document": [
{
'condition': 'python:value',
'hideReady': 'False',
'iconEmpty': 'eea-icon eea-icon-edit',
'iconReady': 'eea-icon eea-icon-check',
'labelEmpty': 'Please set the {label} of this {context.portal_type}',
'labelReady': 'You added the {label}',
'link': 'edit#fieldsetlegend-default',
'linkLabel': 'Add {label}',
'prefix': 'title',
'states': ['all']
},
{
'condition': 'python:value',
'hideReady': 'False',
'iconEmpty': 'eea-icon eea-icon-edit',
'iconReady': 'eea-icon eea-icon-check',
'labelEmpty': 'Please set the {label} of this {context.portal_type}',
'labelReady': 'You added the {label}',
'link': 'edit#fieldsetlegend-default',
'linkLabel': 'Add {label}',
'prefix': 'description',
'states': ['all']
},
...
]
}
Source code
===========
- `github.com/eea/eea.progress.editing <https://github.com/eea/eea.progress.editing>`_
Eggs repository
===============
- `pypi.python.org/pypi/eea.progress.editing <https://pypi.python.org/pypi/eea.progress.editing>`_
- `eggrepo.eea.europa.eu/d/eea.progress.editing <https://eggrepo.eea.europa.eu/d/eea.progress.editing>`_
Plone versions
==============
It has been developed and tested for Plone 4, 5 and 6.
How to contribute
=================
See the `contribution guidelines (CONTRIBUTING.md) <https://github.com/eea/eea.progress.editing/blob/master/CONTRIBUTING.md>`_.
Copyright and license
=====================
eea.progress.editing (the Original Code) is free software; you can
redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc., 59
Temple Place, Suite 330, Boston, MA 02111-1307 USA.
The Initial Owner of the Original Code is European Environment Agency (EEA).
Portions created by Eau de Web are Copyright (C) 2009 by
European Environment Agency. All Rights Reserved.
Funding
=======
EEA_ - European Environment Agency (EU)
.. _EEA: https://www.eea.europa.eu/
.. _`EEA Web Systems Training`: http://www.youtube.com/user/eeacms/videos?view=1
Changelog
=========
2.0 - (2024-06-01)
---------------------------
* Breaking: Drop Plone 4 GenericSetup profile
[avoinea - refs #151690]
* Breaking: Rename Editing Progress ControlPanel and registry
[avoinea - refs #151690]
1.5 - (2023-06-01)
---------------------------
* Feature: Plone 6 added editing progress controlpanel
[Petchesi-Iulian - refs #151690]
1.4 - (2021-12-16)
---------------------------
* Change: Fix package classifiers and python_requires
[avoinea]
1.3 - (2021-06-21)
---------------------------
* Feature: Introduced @@editing.progress.status browser view used to check if
every field is entered for current state, useful for workflow guards
[ichim-david refs #124587]
1.2 - (2021-06-10)
---------------------------
* Change: add also workflow states info to rest api, this
way we know for which state the field should be required
[ichim-david refs #124587]
1.1 - (2021-05-04)
------------------
* Change: return field info as dict
[ichim-david refs #124588]
* Change: We now export a list of dicts for each field instead of
a list of lists, making it easier to read and understand what is exported
[ichim-david refs #124588]
* Provide done information for editing progress of fields
[ichim-david refs #124588]
1.0 - (2021-05-04)
------------------
* Initial Release
Raw data
{
"_id": null,
"home_page": "https://github.com/eea/eea.progress.editing",
"name": "eea.progress.editing",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "EEA Add-ons Plone Zope",
"author": "European Environment Agency: IDM2 A-Team",
"author_email": "eea-edw-a-team-alerts@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/9a/14/e8c229947b3e25c90253a9f8d07a30c800938e8647aeca330d7fd3e92eb6/eea.progress.editing-2.0.zip",
"platform": null,
"description": "==========================\neea.progress.editing\n==========================\n.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.progress.editing/develop\n :target: https://ci.eionet.europa.eu/job/eea/job/eea.progress.editing/job/develop/display/redirect\n :alt: Develop\n.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.progress.editing/master\n :target: https://ci.eionet.europa.eu/job/eea/job/eea.progress.editing/job/master/display/redirect\n :alt: Master\n\nA Plone add-on that expose editing progress via RestAPI\n\n.. contents::\n\n\nMain features\n=============\n\n1. RestAPI editing progress::\n\n $ curl -H 'Accept: application/json' --user admin:admin -i http://localhost:8080/Plone/a-page/@editing.progress\n\n or\n\n $ curl -H 'Accept: application/json' --user admin:admin -i http://localhost:8080/Plone/a-page?expand=editing.progress\n\n\nInstall\n=======\n\n* Add **eea.progress.editing** to your requirements.txt and **constraints.txt** and run::\n\n pip install -r requirements.txt -c constraints.txt\n\n* Or, if using buildout, add **eea.progress.editing** to your eggs section in your buildout and\n re-run buildout::\n\n [buildout]\n eggs +=\n eea.progress.editing\n\n* Or via docker::\n\n $ docker run --rm -p 8080:8080 -e ADDONS=\"eea.progress.editing\" plone/plone-backend\n\n* Restart Plone\n\n* Install **eea.progress.editing** within **Site Setup > Add-ons**\n\n* Configure editing progress via **Control Panel > Editing Progress Settings**\n\n* If you already have **Plone 4** definitions for your Content Types Editing Progress, you can\n export them to XML at **/portal_progress/document/view.export** and then use\n `xml2dict.py <https://github.com/eea/eea.progress.editing/blob/develop/xml2dict.py>`_ script to\n convert them to **Plone 6** registry. The output should look like::\n\n {\n \"Document\": [\n {\n 'condition': 'python:value',\n 'hideReady': 'False',\n 'iconEmpty': 'eea-icon eea-icon-edit',\n 'iconReady': 'eea-icon eea-icon-check',\n 'labelEmpty': 'Please set the {label} of this {context.portal_type}',\n 'labelReady': 'You added the {label}',\n 'link': 'edit#fieldsetlegend-default',\n 'linkLabel': 'Add {label}',\n 'prefix': 'title',\n 'states': ['all']\n },\n {\n 'condition': 'python:value',\n 'hideReady': 'False',\n 'iconEmpty': 'eea-icon eea-icon-edit',\n 'iconReady': 'eea-icon eea-icon-check',\n 'labelEmpty': 'Please set the {label} of this {context.portal_type}',\n 'labelReady': 'You added the {label}',\n 'link': 'edit#fieldsetlegend-default',\n 'linkLabel': 'Add {label}',\n 'prefix': 'description',\n 'states': ['all']\n },\n ...\n ]\n }\n\nSource code\n===========\n\n- `github.com/eea/eea.progress.editing <https://github.com/eea/eea.progress.editing>`_\n\nEggs repository\n===============\n\n- `pypi.python.org/pypi/eea.progress.editing <https://pypi.python.org/pypi/eea.progress.editing>`_\n- `eggrepo.eea.europa.eu/d/eea.progress.editing <https://eggrepo.eea.europa.eu/d/eea.progress.editing>`_\n\n\nPlone versions\n==============\nIt has been developed and tested for Plone 4, 5 and 6.\n\n\nHow to contribute\n=================\nSee the `contribution guidelines (CONTRIBUTING.md) <https://github.com/eea/eea.progress.editing/blob/master/CONTRIBUTING.md>`_.\n\nCopyright and license\n=====================\n\neea.progress.editing (the Original Code) is free software; you can\nredistribute it and/or modify it under the terms of the\nGNU General Public License as published by the Free Software Foundation;\neither version 2 of the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but\nWITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\nor FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\nfor more details.\n\nYou should have received a copy of the GNU General Public License along\nwith this program; if not, write to the Free Software Foundation, Inc., 59\nTemple Place, Suite 330, Boston, MA 02111-1307 USA.\n\nThe Initial Owner of the Original Code is European Environment Agency (EEA).\nPortions created by Eau de Web are Copyright (C) 2009 by\nEuropean Environment Agency. All Rights Reserved.\n\n\nFunding\n=======\n\nEEA_ - European Environment Agency (EU)\n\n.. _EEA: https://www.eea.europa.eu/\n.. _`EEA Web Systems Training`: http://www.youtube.com/user/eeacms/videos?view=1\n\n\nChangelog\n=========\n\n2.0 - (2024-06-01)\n---------------------------\n* Breaking: Drop Plone 4 GenericSetup profile\n [avoinea - refs #151690]\n* Breaking: Rename Editing Progress ControlPanel and registry\n [avoinea - refs #151690]\n\n1.5 - (2023-06-01)\n---------------------------\n* Feature: Plone 6 added editing progress controlpanel \n [Petchesi-Iulian - refs #151690]\n\n1.4 - (2021-12-16)\n---------------------------\n* Change: Fix package classifiers and python_requires\n [avoinea]\n\n1.3 - (2021-06-21)\n---------------------------\n* Feature: Introduced @@editing.progress.status browser view used to check if\n every field is entered for current state, useful for workflow guards\n [ichim-david refs #124587]\n \n1.2 - (2021-06-10)\n---------------------------\n* Change: add also workflow states info to rest api, this\n way we know for which state the field should be required\n [ichim-david refs #124587]\n\n1.1 - (2021-05-04)\n------------------\n* Change: return field info as dict\n [ichim-david refs #124588]\n* Change: We now export a list of dicts for each field instead of\n a list of lists, making it easier to read and understand what is exported\n [ichim-david refs #124588]\n* Provide done information for editing progress of fields\n [ichim-david refs #124588]\n\n1.0 - (2021-05-04)\n------------------\n* Initial Release\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "Editing progress RestAPI",
"version": "2.0",
"project_urls": {
"Homepage": "https://github.com/eea/eea.progress.editing"
},
"split_keywords": [
"eea",
"add-ons",
"plone",
"zope"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9a14e8c229947b3e25c90253a9f8d07a30c800938e8647aeca330d7fd3e92eb6",
"md5": "d13d3f738564d2692deddb870f8ede18",
"sha256": "ee929677ad95a6a8039221062a6219af058de79e4ca607443d0291064696c913"
},
"downloads": -1,
"filename": "eea.progress.editing-2.0.zip",
"has_sig": false,
"md5_digest": "d13d3f738564d2692deddb870f8ede18",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 80172,
"upload_time": "2023-06-29T12:26:16",
"upload_time_iso_8601": "2023-06-29T12:26:16.717698Z",
"url": "https://files.pythonhosted.org/packages/9a/14/e8c229947b3e25c90253a9f8d07a30c800938e8647aeca330d7fd3e92eb6/eea.progress.editing-2.0.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-29 12:26:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eea",
"github_project": "eea.progress.editing",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "eea.progress.editing"
}
JSON
