search

pyvideo / data

Python related videos and metadata powering PyVideo.
https://pyvideo.org
Creative Commons Zero v1.0 Universal
448 stars 265 forks source link

duration field has no description of units in contributing instructions #1190

Open villares opened 4 weeks ago

villares commented 4 weeks ago

I'm reading https://github.com/pyvideo/data/blob/main/CONTRIBUTING.rst in order to understand how to add a PyCon US video.

It looks like the duration field should be filled in seconds, but I'm not sure.

In the example the JSON contains "duration": 3456 but the linked video at https://www.youtube.com/watch?v=APC5HvHZaf0 has duration of 50 minutes and 58 seconds (3058 seconds), and there is no mention in the instructions about the units for the duration value.

jonafato commented 3 weeks ago

The duration field is indeed measured in seconds. This is documented in the video JSON schema, and the contributing document would benefit from an update to include or link to this and other help text documented there. Regarding the example JSON data included in that doc, it appears to be adapted from but not actually matching this presentation. (My guess is that the duration of "3456" was intended to be a placeholder (akin to "1234") that was never meant to match up to an actual YouTube video.) I will find a more suitable and complete example of a real entry to link to instead of including the JSON inline in that doc.

Note that the duration field is optional and can be omitted. Based on a cursory search, the site does not actually use this value today, though it may become useful again in the future.

Regarding contributing an entry for a single PyCon US video: there are a number of tools that exist to bulk import data from conference websites and YouTube playlists, but I'm not aware of any that exist for creating a single talk entry. A couple of options here would be to copy an existing talk file and edit the details, or if it's a recent PyCon US I've been working on a tool that pulls data from first-party conference websites (including PyCon US's API) which may be useful here, either directly or as inspiration.