==========================
eea.api.controlpanel
==========================
.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.api.controlpanel/develop
:target: https://ci.eionet.europa.eu/job/eea/job/eea.api.controlpanel/job/develop/display/redirect
:alt: Develop
.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.api.controlpanel/master
:target: https://ci.eionet.europa.eu/job/eea/job/eea.api.controlpanel/job/master/display/redirect
:alt: Master
The eea.api.controlpanel is a Plone add-on to be used together
with `volto-controlpanel <https://github.com/eea/volto-controlpanel>`_ Volto add-on
.. contents::
Main features
=============
1. Easy to install/uninstall via Site Setup > Add-ons
2. RestAPI for controlpanel versions details
Environment variables
=====================
- `BACKEND_VERSION` - Backend version to be saved to registry when Plone instance starts. You should update this environment variable every time you deploy a new version of your backend.
Install
=======
* Add eea.api.controlpanel to your eggs section in your buildout and re-run buildout::
[buildout]
eggs +=
eea.api.controlpanel
* Or via docker::
$ docker compose up plone6
* Or via pip::
$ pip install eea.api.controlpanel
* Install *eea.api.controlpanel* within Site Setup > Add-ons
Develop
=======
::
$ git clone https://github.com/eea/eea.api.controlpanel.git
$ cd eea.api.controlpanel
$ git checkout develop
$ make help
Source code
===========
- `Github <https://github.com/eea/eea.api.controlpanel>`_
Eggs repository
===============
- https://pypi.python.org/pypi/eea.api.controlpanel
- http://eggrepo.eea.europa.eu/simple
Plone versions
==============
It has been developed and tested for Plone 5 and 6. It should work on any Plone version that supports Volto.
How to contribute
=================
See the `contribution guidelines (CONTRIBUTING.md) <https://github.com/eea/eea.api.controlpanel/blob/master/CONTRIBUTING.md>`_.
Copyright and license
=====================
eea.api.controlpanel (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
=========
1.0 - (2024-03-15)
-----------------------
* Moved Version RestAPI endpoint and init logic from eea.kitkat
[avoinea - refs #264531]
Raw data
{
"_id": null,
"home_page": "https://github.com/eea/eea.api.controlpanel",
"name": "eea.api.controlpanel",
"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/24/9a/cf0d21a1971df710050299aec99a43963159156bc80717ee3eecb78fc3fc/eea.api.controlpanel-1.0.zip",
"platform": null,
"description": "==========================\neea.api.controlpanel\n==========================\n.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.api.controlpanel/develop\n :target: https://ci.eionet.europa.eu/job/eea/job/eea.api.controlpanel/job/develop/display/redirect\n :alt: Develop\n.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.api.controlpanel/master\n :target: https://ci.eionet.europa.eu/job/eea/job/eea.api.controlpanel/job/master/display/redirect\n :alt: Master\n\nThe eea.api.controlpanel is a Plone add-on to be used together\nwith `volto-controlpanel <https://github.com/eea/volto-controlpanel>`_ Volto add-on\n\n.. contents::\n\n\nMain features\n=============\n\n1. Easy to install/uninstall via Site Setup > Add-ons\n2. RestAPI for controlpanel versions details\n\n\nEnvironment variables\n=====================\n\n- `BACKEND_VERSION` - Backend version to be saved to registry when Plone instance starts. You should update this environment variable every time you deploy a new version of your backend. \n\n\nInstall\n=======\n\n* Add eea.api.controlpanel to your eggs section in your buildout and re-run buildout::\n\n [buildout]\n eggs +=\n eea.api.controlpanel\n\n* Or via docker::\n\n $ docker compose up plone6\n\n* Or via pip::\n\n $ pip install eea.api.controlpanel\n\n* Install *eea.api.controlpanel* within Site Setup > Add-ons\n\n\nDevelop\n=======\n::\n\n $ git clone https://github.com/eea/eea.api.controlpanel.git\n $ cd eea.api.controlpanel\n $ git checkout develop\n $ make help\n\n\nSource code\n===========\n\n- `Github <https://github.com/eea/eea.api.controlpanel>`_\n\n\nEggs repository\n===============\n\n- https://pypi.python.org/pypi/eea.api.controlpanel\n- http://eggrepo.eea.europa.eu/simple\n\n\nPlone versions\n==============\nIt has been developed and tested for Plone 5 and 6. It should work on any Plone version that supports Volto.\n\n\nHow to contribute\n=================\nSee the `contribution guidelines (CONTRIBUTING.md) <https://github.com/eea/eea.api.controlpanel/blob/master/CONTRIBUTING.md>`_.\n\nCopyright and license\n=====================\n\neea.api.controlpanel (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\nChangelog\n=========\n\n1.0 - (2024-03-15)\n-----------------------\n\n* Moved Version RestAPI endpoint and init logic from eea.kitkat\n [avoinea - refs #264531]\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "Controlpanel RestAPI additional endpoints to be used with Volto @eeacms/volto-controlpanel",
"version": "1.0",
"project_urls": {
"Homepage": "https://github.com/eea/eea.api.controlpanel"
},
"split_keywords": [
"eea",
"add-ons",
"plone",
"zope"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "249acf0d21a1971df710050299aec99a43963159156bc80717ee3eecb78fc3fc",
"md5": "812a16b795cbe17a93addce6976b5246",
"sha256": "1e9485c7608cec078a1c52c2ec89babad6bcf2f5b4155fd6845eb1dd7406db10"
},
"downloads": -1,
"filename": "eea.api.controlpanel-1.0.zip",
"has_sig": false,
"md5_digest": "812a16b795cbe17a93addce6976b5246",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 75372,
"upload_time": "2024-03-18T13:13:10",
"upload_time_iso_8601": "2024-03-18T13:13:10.688093Z",
"url": "https://files.pythonhosted.org/packages/24/9a/cf0d21a1971df710050299aec99a43963159156bc80717ee3eecb78fc3fc/eea.api.controlpanel-1.0.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 13:13:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eea",
"github_project": "eea.api.controlpanel",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "eea.api.controlpanel"
}
JSON
