pretalx-youtube 3.0.0

Reading data

The Plugin supplies an API at /api/events/<event>/p/youtube/ that returns all configured Youtube URLs:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "submission": "DPC6RT",
            "youtube_link": "https://youtube.com/watch?v=AAAAAB",
            "video_id": "AAAAAB"
        },
    ]
}

A detail view for specific submissions is available at /api/events/<event>/p/youtube/<code>/:

{
    "submission": "DPC6RT",
    "youtube_link": "https://youtube.com/watch?v=AAAAAB",
    "video_id": "AAAAAB"
}

Writing data

You can use POST requests against the list endpoint and PATCH or PUT requests against the detail endpoint to create or update Youtube links. The video_id field is required, as is the submission field unless you are using PATCH. The submission field must be the code of an existing submission, and the API will take care of updating existing links if you use POST, so it’s safe to just always POST to the list endpoint.

You can also bulk import data in either JSON or CSV format. The JSON format is the same as the one used by the API, and the CSV format is a simple CSV file with a header row containing the fields submission and video_id. You can upload the file to /api/events/<event>/p/youtube/import/ using a POST request with the file as the body. (For JSON, you can also instead put the data in the request body.)

Development commands

This plugin uses just as a task runner and uv for dependency management. Run just with no arguments to list every available command. The most useful ones are:

just fmt

Auto-format and lint the code.

just test

Run the full test suite with pytest.

Installing pretalx

The tests need pretalx installed in the environment. just test handles this for you: if pretalx cannot be imported, it installs the latest version from git before running the test suite.

If you already have a development version of pretalx around (for example if you want to test your changes against a specific commit or branch of pretalx), you can also install pretalx up front yourself:

just install-pretalx-local /path/to/pretalx

Install pretalx from a local checkout as an editable install.

just install-pretalx

Install the latest pretalx from git (runs before tests if no pretalx is installed).