/irdm-queue-portal

A basic view of content currently in an InvenioRDM community queue

Primary LanguagePythonOtherNOASSERTION

InvenioRDM Queue View

This repository consists the automation to build a table of content currently in an InvenioRDM community queue. It extracts @tags and presents them in a browsable interface. It runs entirely using GitHub actions and GitHub pages.

License Latest release DOI

Table of contents

Introduction

This project provides a more navicable queue view for users. While it could have been developed inside of InvenioRDM, this approach was easier and more flexible.

Installation

This portal has only been tested with the CaltechAUTHORS repository and is designed for use at Caltech. Please let us know if you're interested in using it elsewhere and we can make it more flexible. For Caltech users, you need to have a CaltechAUTHORS access token set in the CTATOK environment variable or as a GitHub repo secret.

Usage

The GitHub action will run every 30 minutes (should be ready at the top of the hour and half-hour).

You can also manually harvest and render the table by going here and clicking the "Run Workflow" button.

Known issues and limitations

This tool is designed for use at Caltech and has some hardcoded URLs. Let us know if you're interested in using it elsewhere.

We assume a queue will have under 100 entries and the queue view will be updated at most every 15 minutes. Because getting the publisher field makes a call to each record, the current approach will be slow on very large queues and will not work for fast update times.

Getting help

Please open an issue on GitHub.

Contributing

Pull requests are highly encouraged.

License

Software produced by the Caltech Library is Copyright © 2024 California Institute of Technology. This software is freely distributed under a BSD-style license. Please see the LICENSE file for more information.

Authors and history

Tom Morrell created this project.

Acknowledgments

This work was funded by the California Institute of Technology Library.