oarepo-communities 1.1.0

OArepo module that adds support for communities

OARepo-Communities

OArepo module that adds support for communities

Installation

OARepo-Communities is on PyPI so all you need is:

$ pip install oarepo-communities

Configuration

To customize invenio roles to be created inside each community, override the following defaults:

OAREPO_COMMUNITIES_ROLES = ['member', 'curator', 'publisher']
"""Roles present in each community."""

Usage

CLI

You can find all CLI commands that are available under invenio oarepo:communities group.

To create a community, use:

Usage: invenio oarepo:communities create [OPTIONS] COMMUNITY_ID TITLE

Options:
  --description TEXT  Community description
  --policy TEXT       Curation policy
  --title TEXT        Community title
  --logo-path TEXT    Path to the community logo file
  --ctype TEXT        Type of a community
  --help              Show this message and exit.

This command will create a new community together with Invenio Roles for the community. Created community roles will be defined by default as:

dict(
    name=f'community:{community_id}:{community_role}',
    description=f'{title} - {community_role}'
)

This can be customized by using custom OAREPO_COMMUNITIES_ROLE_KWARGS factory.

Further documentation is available on https://oarepo-communities.readthedocs.io/

Copyright (C) 2021 CESNET.

OARepo-Communities is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details.

.. Copyright (C) 2021 CESNET.

OARepo-Communities is free software; you can redistribute it and/or
modify it under the terms of the MIT License; see LICENSE file for more
details.

Changes

Version 0.1.0 (released TBD)

• Initial public release.