Skip to content

Samk13/invenio-config-kth

Repository files navigation

GitHub

invenio-config-kth

Usage

After installation, you are ready to go:

  • Create new communities will be restricted to users with role "community-manager"
  • Publishing records will be restricted to community admins (Curator, Manager, Owner)
  • you can switch new creation to off if you turn CONFIG_KTH_READ_ONLY_MODE = True

Installation

From your instance active venv:

pip install invenio-config-kth

As default, you can add role name community-manager to user programmatically in invenio:

# Create a role
invenio roles create community-manager # This needed to be added once if role doesn't exists
# Add community-manager role to an user, by its emails
invenio roles add <user_email> community-manager

you can also pre-add your list of emails as controlled vocabularies:

There are possibility to change the default role name in invenio_congig_kth/config.py

CONFIG_KTH_COMMUNITY_MANAGER_ROLE = "community-manager"

Or turn the read only mode:

CONFIG_KTH_READ_ONLY_MODE = False

Maintainers

Setup dev env

after cloning the repo:

make install
make test

Run tests

make test

When running tests you will get a warning from black formatter, should bump pytest-black version when it's done

Upload to pypi

make package-create
make package-upload USER="" PASS=""
  • make package-create command will:
  1. remove old dist folder
  2. auto increment package version
  3. zip the package into dist dir
  4. check if the package pass twin checks

You can change version increment to major or minor by adding ARG:

  • make package-create ARG="-ma" increment major version

  • make package-create ARG="-mi" increment minor version

  • make package-create increment patch version

  • make package-check # verify if the package pass twine checks

  • make package-upload USER="" PASS="" # will and upload to pypi will prompt for username and pass

or manually: twine upload -u -p dist/* --verbose