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/uploadssection - 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.
Links
- Repository: https://github.com/oarepo/oarepo-dashboard
- PyPI: https://pypi.org/project/oarepo-dashboard/
- Issues: https://github.com/oarepo/oarepo-dashboard/issues
- OARepo Project: https://github.com/oarepo
Acknowledgments
This project builds upon Invenio Framework and is developed as part of the OARepo ecosystem.
Metadata
Release files for oarepo-dashboard 8.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| oarepo_dashboard-8.0.1.tar.gz | 13.8 kB | Without provenance | Details for oarepo_dashboard-8.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| oarepo_dashboard-8.0.1-py3-none-any.whl | Python 3 | none | any | Details for oarepo_dashboard-8.0.1-py3-none-any.whl |
Total release size: 34.1 kB
Release files / oarepo_dashboard-8.0.1.tar.gz
| Download URL | oarepo_dashboard-8.0.1.tar.gz |
|---|---|
| Size | 13.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6b82db3a95b75ec63a668514643a3c229942759b81c13c69c1a94ffdafa33cdc
|
|
BLAKE2b-256 checksum How to use checksums |
74642a22d2623424a3df0212e742f90800ad8fe6b61ee6a8f4de109829ba9c56
|
| 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-8.0.1-py3-none-any.whl
| Download URL | oarepo_dashboard-8.0.1-py3-none-any.whl |
|---|---|
| Size | 20.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3807f75a4c640b63abb867413ad2f7bdde2c1e4afcec19fb3b130ca789f7783b
|
|
BLAKE2b-256 checksum How to use checksums |
f1ce3089647510d958cf2320fea3981f31b961374a97ad33d1be9b1cd2d6bff9
|
| 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 8.0.1
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.