Install an addons¶
Guillotina differentiates applications
from addons
.
An application is a python package you install into your environment and add to your list of applications in the configuration file.
Addons on the otherhand are when you want to perform installation logic into a container.
Define addon¶
To define an addon for Guillotina, we use the @configure.addon
decorator
in the install.py
file.
For our case, we want to create a Folder with all our conversations with some default permissions.
from guillotina import configure
from guillotina.addons import Addon
from guillotina.content import create_content_in_container
from guillotina.interfaces import IRolePermissionManager
@configure.addon(
name="guillotina_chat",
title="Guillotina server application python project")
class ManageAddon(Addon):
@classmethod
async def install(cls, container, request):
if not await container.async_contains('conversations'):
conversations = await create_content_in_container(
container, 'Folder', 'conversations',
id='conversations', creators=('root',),
contributors=('root',))
roleperm = IRolePermissionManager(conversations)
roleperm.grant_permission_to_role(
'guillotina.AddContent', 'guillotina.Member')
roleperm.grant_permission_to_role(
'guillotina.AccessContent', 'guillotina.Member')
@classmethod
async def uninstall(cls, container, request):
registry = request.container_settings # noqa
# uninstall logic here...