Skip to main content

Indico Phonebook Plugin

This Indico plugin automatically syncs categories, user access rights, and local groups with an external Phonebook service, such as ePIC, STAR, or sPHENIX collaboration directories.

Features

  • Health check endpoint (/phonebook/ping)
  • Manual sync per experiment (/phonebook/<experiment>/sync)
  • JSON-configurable experiment settings
  • Two sync strategies: by email or ORCID
  • Synchronizes:
    • Category membership (with access control)
    • Local Indico groups:
      • All members group
      • Managers group
    • Subcategories based on Phonebook groups

Configuration

Update the plugin’s settings via Indico’s admin panel using a JSON configuration:

{
  "epic": {
    "url": "https://phonebook.sdcc.bnl.gov/ePIC/",
    "parent_category_title": "ePIC",
    "member_group": "epic-members",
    "manager_group": "epic-managers",
    "sync_strategy": "orcid"
  }
}

Explanation:

  • member_group: name of a LocalGroup to sync with all Phonebook members
  • manager_group: name of a LocalGroup to sync with members with manager roles
  • sync_strategy: either "email" or "orcid"

Installation

Clone this repository into your Indico plugins directory:

cd ~/indico/plugins
git clone https://git.racf.bnl.gov/gitea/CDS/indico-plugin-phonebook.git
cd  indico-plugin-phonebook
git checkout tags/v1.0.0 -b v1.0.0 # to get a specific tag version
pip install -e .

Add in indico.conf:

PLUGINS = {'phonebook'}

Restart indico.

Metadata

Release files for indico-plugin-phonebook 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for indico-plugin-phonebook 1.0.1
File Size Uploaded
indico_plugin_phonebook-1.0.1.tar.gz 7.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for indico-plugin-phonebook 1.0.1
File Interpreter ABI Platform
indico_plugin_phonebook-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 14.7 kB

Release files / indico_plugin_phonebook-1.0.1.tar.gz

Download URL indico_plugin_phonebook-1.0.1.tar.gz
Size 7.1 kB
Tags Source
SHA-256 checksum
How to use checksums
61fa62acf3b0b3d2d0238e4ef6c71bfc2d916223cd0ac42fe4119120deef9b8c
BLAKE2b-256 checksum
How to use checksums
1dd678a6914a7c1ddfef7edb43d35db4e7581cc4677221a488131adceabc5b4e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release files / indico_plugin_phonebook-1.0.1-py3-none-any.whl

Download URL indico_plugin_phonebook-1.0.1-py3-none-any.whl
Size 7.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f3e89aeb244580d4f0748af5099e03d61ad769c03e40847d640e89f43adcb8e7
BLAKE2b-256 checksum
How to use checksums
5369135afb91637f41599453a378350d4e4118eed980c23e24269962989f06b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page