PROJECT: Opencast CLI Tool and Go API client library

[mtneug]

1. Aim/description

We have a random collection of Opencast helper scripts to automate stuff and interact with the Opencast APIs. This is untested and can be cumbersome to adapt for a particular use case. We think it's finally time for an Opencast CLI tool that works in a predictable manner and simplifies automated interactions with Opencast. The target audiences are Opencast administrators and potentially Opencast video uploaders.

We plan to implement the Opencast CLI tool in the programming language Go. Thus, simultaneously we implement a Go API client library that can be used independently of the CLI tool. The target audiences of the Go library are developers.

2. After the issue has been created, please use project fields to the right to categorise your project:

• Funding: internally
• Scope: M
• Area: terminal user interface
• Begin/End: first release planned for the end of 2025

3. Additional information

• Responsible Person: @mtneug (shio solutions GmbH)
• Additional Stakeholders: -
• Related Feature Requests and Issues: -

[oas777]

The one I never understood - can we get an update for this at the roadmap meeting next week, @mtneug?

[mtneug]

The one I never understood - can we get an update for this at the roadmap meeting next week, @mtneug?

Sure.

This is a project to develop a tool for interacting with Opencast through the terminal. I guess the normal Opencast user won't switch from the graphical Admin UI to a terminal. However, having such a tool also simplifies scripting/automation, but I think some Opencast admins would also use this to quickly get a view of the system state. At the very least, we at shio will get a use out of it :)

[mtneug]

Update: Initial work happened over the summer. The project is currently paused, but work will pick up again with a first release still planned for (the very) end of the year. I also plan to showcase this project at the next Opencast summit.

[mtneug]

Update

I just made the code available publicly:

• Opencast Go client library
• Opencast CLI

The structure of the Go client library should now be fairly stable. It includes a full and type-safe implementation of the Opencast External API. Furthermore, two service mappers are implemented. The first one (static) uses a static mapping of services to URL, while the second one (dynamic) uses the service registry to determine the correct URL to talk to. Currently, documentation and tests are still missing.

The Opencast CLI is still in development but working. It already includes read-only commands for all resources and write commands for some. Again, documentation and tests are still pending.

A showcase of this project is scheduled for the Opencast summit in Manchester.