Skip to main content

OARepo Dashboard

Signed-in user's dashboard for Invenio / InvenioRDM repositories built on the OARepo stack.

Overview

This package provides the /me dashboard area where a user manages their own content. It is mainly a wrapper around the user dashboard shipped by invenio-app-rdm, wiring its pages into an OARepo-based repository:

  • Dashboard navigation (Uploads, Communities, Requests) registered into the app menus
  • Customized dashboard header with avatar, user info, and context-aware actions
  • Result-list rendering overrides for the user's uploads, driven by oarepo-ui
  • A pluggable hook for registering per-schema result-item components
  • Support for multiple record models in the /me/uploads section
  • React search components and dashboard styling shipped as a Webpack bundle
  • Czech and English translations

The package registers itself with Invenio through entry points — no manual application wiring is required. The dashboard UI resource is served under the /me URL prefix.

Installation

pip install oarepo-dashboard

Configuration

The following application config keys affect the dashboard:

Key Default Description
REGISTER_DASHBOARD_IN_MAIN_MENU True Whether to add the My dashboard entry to the main deposit menu.
USER_DASHBOARD_MENU_OVERRIDES {} Per-submenu overrides for the dashboard tabs. Keys must be one of uploads, communities, requests; values are merged into that submenu's registration kwargs (e.g. text, order, endpoint). Overriding an unknown submenu name raises ValueError.
DASHBOARD_RECORD_CREATE_URL "" Target URL for the New upload button on the Uploads tab.

Key Features

1. Dashboard Menus

Source: oarepo_dashboard/ui/dashboard_components/__init__.py

On finalize_app, the package registers the dashboard navigation. A My dashboard entry is added to the main deposit menu (for authenticated users), and the dashboard submenu is built with three tabs pointing at the InvenioRDM user views:

  • Uploads → invenio_app_rdm_users.uploads
  • Communities → invenio_app_rdm_users.communities
  • Requests → invenio_app_rdm_users.requests

The menu is configurable (see Configuration) — you can suppress the main-menu entry and override individual submenu items.

2. Dashboard Header

Source: oarepo_dashboard/ui/dashboard_components/templates/oarepo/invenio_app_rdm/users/header.html

A template override for the user dashboard header. It renders the user's avatar, full name (falling back to username/email), and affiliations, the dashboard submenu tabs, and a context-aware primary action:

  • New upload on the Uploads tab (links to DASHBOARD_RECORD_CREATE_URL)
  • New community on the Communities tab

3. Result-List Overrides

Source: oarepo_dashboard/ui/dashboard_components/__init__.py

Using the oarepo-ui override system, the dashboard's Uploads results list is rendered with OARepo's DynamicResultsListItem component:

from oarepo_ui.overrides import UIComponent, UIComponentOverride
from oarepo_ui.overrides.components import UIComponentImportMode

dynamic_result_list_item = UIComponent(
    "DynamicResultsListItem",
    "@js/oarepo_ui/search/DynamicResultsListItem",
    UIComponentImportMode.DEFAULT,
)
override = UIComponentOverride(
    "invenio_app_rdm_users.uploads",
    "InvenioAppRdm.DashboardUploads.ResultsList.item",
    dynamic_result_list_item,
)

The blueprint also appends a callback to OAREPO_UI_RESULT_LIST_ITEM_REGISTRATION_CALLBACKS, letting other libraries register per-schema result-item components for the dashboard uploads list.

4. React Search Components

Source: oarepo_dashboard/ui/dashboard_components/semantic-ui/js/dashboard_components/

Front-end assets are shipped as a WebpackThemeBundle. Notably, FacetsButtonGroupNameToggler renders a Semantic UI button group for switching between mutually exclusive search facets (e.g. changing which facet a search is grouped by) while preserving the rest of the active query filters.

5. Translations

Source: oarepo_dashboard/i18n/

Bundled Czech (cs) and English (en) message catalogs, registered through the invenio_i18n.translations entry point.

Development

git clone https://github.com/oarepo/oarepo-dashboard.git
cd oarepo-dashboard

./run.sh venv
./run.sh test

See CONTRIBUTING.md for the full contribution workflow.

License

Copyright (c) 2025 CESNET z.s.p.o.

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

Acknowledgments

This project builds upon Invenio Framework and is developed as part of the OARepo ecosystem.

Metadata

Release files for oarepo-dashboard 9.0.0

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

Source distribution (sdist)

Source distribution for oarepo-dashboard 9.0.0
File Size Uploaded Provenance Actions
oarepo_dashboard-9.0.0.tar.gz 13.8 kB Without provenance Details for oarepo_dashboard-9.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for oarepo-dashboard 9.0.0
File Interpreter ABI Platform Actions
oarepo_dashboard-9.0.0-py3-none-any.whl Python 3 none any Details for oarepo_dashboard-9.0.0-py3-none-any.whl

Total release size: 34.1 kB

Release files / oarepo_dashboard-9.0.0.tar.gz

Download URL oarepo_dashboard-9.0.0.tar.gz
Size 13.8 kB
Tags Source
SHA-256 checksum
How to use checksums
36c9fa8c69cc5e28dc671128531ac5bb18900fb053726e900a655e4436763f14
BLAKE2b-256 checksum
How to use checksums
21b6353d31665791eca98a1577a9bbe64acfc9ba58dee48168b570604b590273
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / oarepo_dashboard-9.0.0-py3-none-any.whl

Download URL oarepo_dashboard-9.0.0-py3-none-any.whl
Size 20.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6c79dc43340c25c870679ce9f59cc6b7376fa603cfd01dbccf517b5980525897
BLAKE2b-256 checksum
How to use checksums
53b86b43d7cc196b6f4fec8c4b50285a2d7f41b2d4833ca048ebe2aa49347d38
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for oarepo-dashboard 9.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

9.0.0 This release

2 release files No provenance

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