1
0
Fork 0
mirror of https://github.com/Kunsi/pretalx-plugin-broadcast-tools synced 2024-05-17 09:42:34 +00:00

Compare commits

...

43 commits

Author SHA1 Message Date
Franzi 3917fa65cf
some more code style 2024-03-16 11:37:26 +01:00
Franzi 81494bed54
update github actions some more 2024-03-16 11:36:41 +01:00
Franzi 819e8ea2aa
update github actions to use python 3.12 2024-03-16 11:29:10 +01:00
Franziska Kunsmann 77148e41f7 release 2.2.0 2023-10-23 08:34:53 +02:00
Franzi cb60e02671
github workflows: remove apparently broken packaging check 2023-10-10 16:28:38 +02:00
Franzi 25d8be0397
apparently, you need a boilerplate setup.py to publish to pypi 2023-10-10 16:16:15 +02:00
Franzi af4e3408db
improve placeholder explainations 2023-10-10 16:05:20 +02:00
Franzi dabc8e5443
add TRACK_NAME and TRACK_NAME_COLOURED placeholders 2023-10-10 16:00:47 +02:00
Franzi 341a9c072c
Merge pull request #16 from rixx/category
Add plugin category
2023-10-03 13:08:54 +02:00
Tobias Kunze 98f8374b66 Add pluginc category 2023-10-03 11:22:40 +02:00
Franzi 2b22f6a155
release 2.1.0 2023-09-30 13:38:31 +02:00
Franzi 5335e911b7
Merge pull request #15 from rixx/pyproject-toml
Fix pyproject.toml install
2023-09-30 13:21:38 +02:00
Tobias Kunze 210a18f6b3 Fix pyproject.toml install 2023-09-30 13:15:24 +02:00
Franzi 3063adcc73
move views into dedicated files 2023-09-30 12:41:47 +02:00
Franzi 8f8f8a90e2
add more information to the json outputs 2023-09-30 12:35:37 +02:00
Franziska Kunsmann 433f316719 release 2.0.1 2023-08-23 08:13:46 +02:00
Franziska Kunsmann ca8a2e3c65 make the linter happy 2023-08-23 08:11:19 +02:00
Franziska Kunsmann 85893d9c9c migrate to pyproject.toml 2023-08-23 08:08:38 +02:00
fkusei c6ceedf041
Merge pull request #13 from rixx/timezone
Safe timezone handling
2023-06-19 10:35:01 +02:00
fkusei 1ad4c73ed4
Merge pull request #14 from rixx/ugett
Use non-deprecated gettext call
2023-06-19 10:34:10 +02:00
Tobias Kunze 57351a4e1a Use non-deprecated gettext call 2023-06-03 23:07:34 +02:00
Tobias Kunze 190ce8f222 Safe timezone handling 2023-06-03 22:07:13 +02:00
Franzi 3bd74850a5
Release 2.0.0 2023-03-29 11:15:59 +02:00
Franzi 0d3d96e96d
fix screenshot descriptions 2023-03-29 11:14:02 +02:00
Franzi d858f8d039
add some screenshots to the README 2023-03-29 11:10:31 +02:00
Franzi ab42dade2b
lower thirds: change css selectors to be similar to the others 2023-03-29 10:33:07 +02:00
Franzi 6c058cca1f
add changes to CHANGELOG 2023-03-29 10:23:04 +02:00
Franzi 4c114d6cee
fix license info in README 2023-03-29 10:16:52 +02:00
Franzi de73a288b8
clean up urls and unused views 2023-03-29 09:52:44 +02:00
Franziska Kunsmann 8b7acb10fb use dedicated function to get pretty-printed time from pretalx 2023-03-01 14:07:54 +01:00
Franziska Kunsmann aa91af001c orga: ChoiceField cannot be required if '' is a valid choice 2023-03-01 13:58:00 +01:00
Franziska Kunsmann 788273e870 room info: add option to show next talk if no talk is running 2023-03-01 13:55:54 +01:00
Franziska Kunsmann 0486cd44da orga view: fix deleted fiel 2023-03-01 11:49:14 +01:00
Franziska Kunsmann 46be2a02b5 make the linter happy
Und täglich grüßt das Murmeltier ...
2023-03-01 11:34:34 +01:00
Franziska Kunsmann 3f7649b09a remove githubs "release on tag" action 2023-03-01 11:33:46 +01:00
Franziska Kunsmann 12864749f9 room info: add option to hide qr code or show the submission image 2023-03-01 11:29:56 +01:00
Franzi fa31e72db1
make the linter happy
once again we have a release which contains formatting errors, wheeee!
2023-02-28 19:21:16 +01:00
Franzi 498782a962
release 1.1.0 2023-02-28 19:20:43 +01:00
Franzi c5cb67d969
update README 2023-02-28 19:19:47 +01:00
Franzi 737a72f296
add room name to room info page 2023-02-28 19:11:10 +01:00
Franzi bb55df2723
add option to switch between feedback and public qr code 2023-02-28 19:10:18 +01:00
Franzi e0f47458cd
add endpoint to get qr code linking to talk detail page 2023-02-28 18:49:29 +01:00
Franzi 08998e7535
re-add colorizing of lower thirds box 2023-02-28 15:55:32 +01:00
28 changed files with 608 additions and 381 deletions

View file

@ -1,19 +0,0 @@
name: Create release when creating a tag
on:
create:
tags:
- '[0-9].[0-9].[0-9]'
jobs:
build-and-release:
runs-on: ubuntu-latest
steps:
- name: create release
id: create_release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref }}
release_name: Release ${{ github.ref }}
draft: false
prerelease: false

View file

@ -18,14 +18,14 @@ jobs:
name: isort
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: install gettext
run: sudo apt install gettext
- name: Set up Python 3.8
uses: actions/setup-python@v1
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: 3.8
- uses: actions/cache@v1
python-version: 3.12
- uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
@ -41,14 +41,14 @@ jobs:
name: flake8
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: install gettext
run: sudo apt install gettext
- name: Set up Python 3.8
uses: actions/setup-python@v1
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: 3.8
- uses: actions/cache@v1
python-version: 3.12
- uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
@ -65,14 +65,14 @@ jobs:
name: black
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: install gettext
run: sudo apt install gettext
- name: Set up Python 3.8
uses: actions/setup-python@v1
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: 3.8
- uses: actions/cache@v1
python-version: 3.12
- uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
@ -89,14 +89,14 @@ jobs:
name: docformatter
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: install gettext
run: sudo apt install gettext
- name: Set up Python 3.8
uses: actions/setup-python@v1
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: 3.8
- uses: actions/cache@v1
python-version: 3.12
- uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
@ -113,14 +113,14 @@ jobs:
name: djhtml
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: install gettext
run: sudo apt install gettext
- name: Set up Python 3.8
uses: actions/setup-python@v1
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: 3.8
- uses: actions/cache@v1
python-version: 3.12
- uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
@ -133,34 +133,34 @@ jobs:
- name: Run docformatter
run: find -name "*.html" | xargs djhtml -c
working-directory: .
packaging:
name: packaging
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: install gettext
run: sudo apt install gettext
- name: Set up Python 3.8
uses: actions/setup-python@v1
with:
python-version: 3.8
- uses: actions/cache@v1
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install pretalx
run: pip3 install pretalx
- name: Install Dependencies
run: pip3 install twine check-manifest -Ue .
- name: Run check-manifest
run: check-manifest .
working-directory: .
- name: Build package
run: python setup.py sdist
working-directory: .
- name: Check package
run: twine check dist/*
working-directory: .
# packaging:
# name: packaging
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v4
# - name: install gettext
# run: sudo apt install gettext
# - name: Set up Python 3.12
# uses: actions/setup-python@v5
# with:
# python-version: 3.12
# - uses: actions/cache@v4
# with:
# path: ~/.cache/pip
# key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
# restore-keys: |
# ${{ runner.os }}-pip-
# - name: Install pretalx
# run: pip3 install pretalx
# - name: Install Dependencies
# run: pip3 install twine check-manifest -Ue .
# - name: Run check-manifest
# run: check-manifest .
# working-directory: .
# - name: Build package
# run: python setup.py sdist
# working-directory: .
# - name: Check package
# run: twine check dist/*
# working-directory: .
#

View file

@ -1,3 +1,45 @@
# 2.2.0
* add plugin category (#16)
* add placeholders `{TRACK_NAME}` and `{TRACK_NAME_COLOURED}`
# 2.1.0
* fixed installation procedure
* add some more information to the json outputs to be able to be compatible
with [scheduled-plugin-pretalx-broadcast-tools](https://github.com/Kunsi/scheduled-plugin-pretalx-broadcast-tools)
(a plugin for [info-beamer hosted](https://info-beamer.com/))
# 2.0.1 (no longer available due to bugs during installation)
* fixes to support pretalx 2023.1.0
* use non-deprecated gettext call
* safe timezone handling
* usage of pyproject.toml
# 2.0.0
* room info page can now show more content on the lower half of the view
* **BREAKING:** The option to select which content should be shown
is now a ChoiceField, the old setting will be ignored.
* **BREAKING:** lower thirds now use css selectors using the same rules
as the other css selectors
* `#l3box` is now `#broadcast_tools_lower_thirds_box`
* `#l3info_line` is now `#broadcast_tools_lower_thirds_infoline`
* `#l3speaker` is now `#broadcast_tools_lower_thirds_speaker`
* `#l3title` is now `#broadcast_tools_lower_thirds_title`
* `.lower3rd` is now `broadcast_tools_lower_thirds`
# 1.1.0
* add a "room info" page to show conference attendees the currently running talk
* fix more compatibility issues with pretalx 2.3.x
# 1.0.4
* fix compatibility with pretalx 2.3.x
* always localize text using the selected default event locale
# 1.0.3
* fix a bug where questions could not be sorted

View file

@ -1,30 +1,54 @@
Lower Thirds
==========================
Pretalx: Broadcast Tools (and more)
===================================
This is a plugin for `pretalx`_.
This plugin allows you to add configurable lower thirds ("Bauchbinden"
in German) to your pretalx instance. Most likely this will be used in
(for example) a Browser Source inside `OBS Studio`_.
This adds the following features to your pretalx instance:
* Lower Thirds ("Bauchbinden") for using with something like OBS
* a "room info" screen, if you want to show information about the
currently running talk outside the room
* a pdf export containing information about a talk, so video helpers
can have easy access to the needed information
Screenshots
-----------
The first two screenshots show the talk "Compatible static software" by
"Stephanie Fisher", which was generated by the `create_test_event` command.
The event color is `#EA652D`, a bright orange. The track color is `#857EB0`,
a light purple. The last screenshot shows "Multi-layered encompassing
paradigm" by "Michael Rodriguez".
.. image:: img/lower_thirds.png
:width: 400
:alt: Screenshot of the lower third output. There's currently a talk running.
:width: 400
:alt: Screenshot of "lower thirds" view. The box is located in the
bottom quarter of the screen, taking about half the screen width.
The box is mostly colored in the event color, with a small strip
showing the track color at the bottom. Inside the box the talk
title is shown in large text on top, the speaker name below that.
On the bottom right of the box the configured info line is shown.
The colours will be automatically determined from the event and track
colours set inside pretalx.
.. image:: img/room_info.png
:width: 400
:alt: Screenshot of the "room info" view. The whole screen is coloured
in the track color. On top of the screen you see the room name
in small font, below that the talk title in large letters. Below
that there's the speaker name listed. On the remainder of the
screen you see a large QR code linking to the talk detail page
in the schedule. The URL is also shown in plain-text below the
QR code.
You can also add a configurable third line to the lower thirds, for
example to hint your audience to vote for the talks. To make this easier,
the plugin will automatically replace some placeholders inside the text,
so you can have individual text for all talks.
.. image:: img/orga_view.png
:width: 400
:alt: Screenshot of the orga view
Inside the orga view, you can also configure the text snippet that's
shown if there's no talk running currently.
.. image:: img/pdf_export.png
:width: 400
:alt: Screenshot of the first half of a pdf page. On the top you see
a large text "DO NOT RECORD - DO NOT STREAM", because the speaker
selected "Do not record" in the CfP. Below that you find
information like event- and room-name, date and time, talk title,
checkboxes for each speaker, length of the talk, talk abstract.
Also you can find answers to select questions and notes entered
inside pretalx on the pdf export. In this screenshot most info
has been extended by adding lots of "lorem ipsum" text.
Development setup
-----------------
@ -48,7 +72,7 @@ Development setup
License
-------
Copyright 2021 Franziska 'kunsi' Kunsmann
Copyright 2021-2023 Franziska 'kunsi' Kunsmann
Released under the terms of the Apache License 2.0

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 87 KiB

BIN
img/pdf_export.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 275 KiB

BIN
img/room_info.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

View file

@ -15,7 +15,8 @@ class PluginApp(AppConfig):
"embedded into your broadcasting software"
)
visible = True
version = "1.1.0-beta1"
version = "2.2.0"
category = "FEATURE"
def ready(self):
from . import signals # NOQA

View file

@ -1,4 +1,4 @@
from django.forms import BooleanField, CharField, Textarea
from django.forms import BooleanField, CharField, ChoiceField, Textarea
from django.utils.translation import gettext_lazy as _
from hierarkey.forms import HierarkeyForm
from i18nfield.forms import I18nFormField, I18nFormMixin, I18nTextInput
@ -22,6 +22,34 @@ class BroadcastToolsSettingsForm(I18nFormMixin, HierarkeyForm):
required=False,
widget=I18nTextInput,
)
broadcast_tools_room_info_lower_content = ChoiceField(
choices=(
("", "No lower content"),
("public_qr", "QR code linking to the 'talk detail' page"),
(
"feedback_qr",
"QR code linking to the feedback page of the currently running talk",
),
("talk_image", "session image uploaded by the speaker(s)"),
),
help_text=_(
"If a talk is running, the room info page will always show "
"the talk title and the list of speakers. The content below "
"is configurable here."
),
label=_("lower content"),
required=False,
)
broadcast_tools_room_info_show_next_talk = BooleanField(
help_text=_(
"If no talk is running in the room, show the time and title "
"of the next talk in the room."
),
label=_("Show next talk"),
required=False,
)
broadcast_tools_pdf_show_internal_notes = BooleanField(
help_text=_(
"If checked, the value of the 'internal notes' field in a "

View file

@ -1,7 +1,7 @@
from django.dispatch import receiver
from django.urls import resolve, reverse
from django.utils.translation import gettext_lazy as _
from django.utils.translation import gettext_noop
from django.utils.translation import ugettext_lazy as _
from i18nfield.strings import LazyI18nString
from pretalx.common.models.settings import hierarkey
from pretalx.common.signals import register_data_exporters

View file

@ -22,6 +22,12 @@ body {
text-align: center;
}
#broadcast_tools_room_info_roomname {
font-size: 2em;
margin-bottom: 0.5em;
font-weight: bold;
}
#broadcast_tools_room_info_title {
font-size: 6em;
margin-bottom: 0.2em;
@ -46,7 +52,7 @@ body {
margin-top: 1em;
}
#l3box {
#broadcast_tools_lower_thirds_box {
width: 1020px;
position: absolute;
@ -59,17 +65,17 @@ body {
background-color: #3aa57c;
}
#l3title {
#broadcast_tools_lower_thirds_title {
font-size: 30px;
font-weight: 500;
margin-bottom: 15px;
}
#l3speaker {
#broadcast_tools_lower_thirds_speaker {
font-size: 20px;
}
#l3info_line {
#broadcast_tools_lower_thirds_infoline {
font-size: 16px;
text-align: right;
}

View file

@ -8,8 +8,6 @@ function get_current_talk(max_offset) {
return null;
}
current_talk = null;
for (let offset = 0; offset <= max_offset; offset++) {
time_start = new Date(Date.now() + offset*60000).getTime();
time_end = new Date(Date.now() - offset*60000).getTime();
@ -26,17 +24,39 @@ function get_current_talk(max_offset) {
talk_end = new Date(talk['end']).getTime();
if (talk_start < time_start && talk_end > time_end) {
current_talk = talk;
break;
return talk;
}
}
if (current_talk) {
break;
}
}
return current_talk;
return null;
}
function get_next_talk() {
room_name = get_room_name();
if (!room_name) {
return null;
}
time_start = new Date(Date.now()).getTime();
for (talk_i in schedule['talks']) {
talk = schedule['talks'][talk_i]
if (schedule['rooms'].length > 1 && talk['room'] != room_name) {
// not in this room
continue;
}
talk_start = new Date(talk['start']).getTime();
if (talk_start > time_start) {
return talk;
}
}
return null;
}
function get_room_name() {
@ -50,6 +70,23 @@ function get_room_name() {
return room_name;
}
function format_time_from_pretalx(from_pretalx) {
d = new Date(from_pretalx);
h = d.getHours();
m = d.getMinutes();
if (h < 10) {
h = '0' + h;
}
if (m < 10) {
m = '0' + m;
}
return h + ':' + m;
}
function update_schedule() {
$.getJSON('../event.json', function(data) {
event_info = data;

View file

@ -6,40 +6,42 @@ function update_lower_third() {
return
}
$('#broadcast_tools_lower_thirds_box').css('background-color', event_info['color']);
if (!schedule) {
$('#l3title').text('Waiting for schedule ...')
$('#broadcast_tools_lower_thirds_title').text('Waiting for schedule ...')
return
}
if ('error' in schedule) {
$('#l3title').text('Error')
$('#l3speaker').html(schedule['error'].join('<br>'));
$('#l3info_line').text('');
$('#broadcast_tools_lower_thirds_title').text('Error')
$('#broadcast_tools_lower_thirds_speaker').html(schedule['error'].join('<br>'));
$('#broadcast_tools_lower_thirds_infoline').text('');
return
}
if (schedule['rooms'].length > 1 && !schedule['rooms'].includes(room_name)) {
$('#l3title').text('Error')
$('#l3speaker').text('Invalid room_name. Valid names: ' + schedule['rooms'].join(', '));
$('#l3info_line').text('');
$('#broadcast_tools_lower_thirds_title').text('Error')
$('#broadcast_tools_lower_thirds_speaker').text('Invalid room_name. Valid names: ' + schedule['rooms'].join(', '));
$('#broadcast_tools_lower_thirds_infoline').text('');
return
}
current_talk = get_current_talk(5);
if (current_talk) {
$('#l3title').text(current_talk['title']);
$('#l3speaker').text(current_talk['persons'].join(', '));
$('#l3info_line').text(current_talk['infoline']);
$('#broadcast_tools_lower_thirds_title').text(current_talk['title']);
$('#broadcast_tools_lower_thirds_speaker').text(current_talk['persons'].join(', '));
$('#broadcast_tools_lower_thirds_infoline').text(current_talk['infoline']);
} else {
$('#l3title').text(event_info['no_talk']);
$('#l3speaker').text('');
$('#l3info_line').text('');
$('#broadcast_tools_lower_thirds_title').text(event_info['no_talk']);
$('#broadcast_tools_lower_thirds_speaker').text('');
$('#broadcast_tools_lower_thirds_infoline').text('');
}
if (current_talk && current_talk['track']) {
$('#l3box').css('border-bottom', '10px solid ' + current_talk['track']['color']);
$('#broadcast_tools_lower_thirds_box').css('border-bottom', '10px solid ' + current_talk['track']['color']);
} else {
$('#l3box').css('border-bottom', 'none');
$('#broadcast_tools_lower_thirds_box').css('border-bottom', 'none');
}
}
window.setInterval(update_lower_third, 1000);

View file

@ -13,8 +13,9 @@ function update_room_info() {
}
if (!room_name) {
$('#broadcast_tools_room_info_title').text(event_info['name']);
$('#broadcast_tools_room_info_speaker').text('Backstage');
$('#broadcast_tools_room_info_roomname').text(event_info['name']);
$('#broadcast_tools_room_info_title').text('Backstage');
$('#broadcast_tools_room_info_speaker').text('');
$('#broadcast_tools_room_info_qr').text('');
$('#broadcast_tools_room_info').css('background-color', event_info['color']);
return
@ -40,14 +41,33 @@ function update_room_info() {
}
current_talk = get_current_talk(15);
next_talk = get_next_talk();
if (current_talk) {
if (event_info['room-info']['lower_info'] == 'feedback_qr') {
qr_info = '<img src="' + current_talk['urls']['feedback_qr'] + '" alt="Feedback QR Code"><p>Leave Feedback by scanning the code or visiting ' + current_talk['urls']['feedback'] + '</p>';
} else if (event_info['room-info']['lower_info'] == 'public_qr') {
qr_info = '<img src="' + current_talk['urls']['public_qr'] + '" alt="QR Code linking to URL below"><p>' + current_talk['urls']['public'] + '</p>';
} else if (event_info['room-info']['lower_info'] == 'talk_image' && current_talk['image_url']) {
qr_info = '<img src="' + current_talk['image_url'] + '" alt="Talk image">';
} else {
qr_info = '';
}
$('#broadcast_tools_room_info_roomname').text(room_name);
$('#broadcast_tools_room_info_title').text(current_talk['title']);
$('#broadcast_tools_room_info_speaker').text(current_talk['persons'].join(', '));
$('#broadcast_tools_room_info_qr').html('<img src="' + current_talk['urls']['feedback_qr'] + '" alt="Feedback QR Code"><p>Leave Feedback by scanning the code or visiting ' + current_talk['urls']['feedback'] + '</p>');
$('#broadcast_tools_room_info_qr').html(qr_info);
} else {
$('#broadcast_tools_room_info_title').text(event_info['name']);
$('#broadcast_tools_room_info_speaker').text(room_name);
$('#broadcast_tools_room_info_roomname').text(event_info['name']);
$('#broadcast_tools_room_info_title').text(room_name);
$('#broadcast_tools_room_info_qr').text('');
if (next_talk && event_info['room-info']['show_next_talk']) {
$('#broadcast_tools_room_info_speaker').text(format_time_from_pretalx(next_talk['start']) + ' ' + next_talk['title']);
} else {
$('#broadcast_tools_room_info_speaker').text('');
}
}
if (current_talk && current_talk['track']) {

View file

@ -16,11 +16,11 @@
<link rel="stylesheet" type="text/css" href="{{ request.event.custom_css.url }}"/>
{% endif %}
</head>
<body class="lower3rd">
<div id="l3box">
<p id="l3title">Loading ...</p>
<p id="l3speaker">Content should appear soon. If not, please verify you have Javascript enabled.</p>
<p id="l3info_line"></p>
<body id="broadcast_tools_lower_thirds">
<div id="broadcast_tools_lower_thirds_box">
<p id="broadcast_tools_lower_thirds_title">Loading ...</p>
<p id="broadcast_tools_lower_thirds_speaker">Content should appear soon. If not, please verify you have Javascript enabled.</p>
<p id="broadcast_tools_lower_thirds_infoline"></p>
</div>
</body>
</html>

View file

@ -32,19 +32,22 @@
</p>
<dl>
<dt><code>{CODE}</code></dt>
<dd>Use to embed the talk code (<code>MUX9U3</code> for example).</dd>
<dd>talk code (<code>MUX9U3</code> for example) - most useful in combination with pretalx-proposal-redirects or something like that</dd>
<dt><code>{EVENT_SLUG}</code></dt>
<dd>Use to embed the event slug.</dd>
<dd>The event slug (<code>{{ request.event.slug }}</code>)</dd>
<dt><code>{FEEDBACK_URL}</code></dt>
<dd>URL to the talk feedback page.</dd>
<dt><code>{TALK_SLUG}</code></dt>
<dd>Use to embed the talk slug.</dd>
<dd>The talk slug (<code>{{ request.event.slug }}-1-my-super-great-talk</code>)</dd>
<dt><code>{TALK_URL}</code></dt>
<dd>URL to the talk detail page.</dd>
<dt><code>{TRACK_NAME}</code> or <code>{TRACK_NAME_COLOURED}</code></dt>
<dd>Track name in plain text or coloured using the track colour.</dd>
</dl>
<fieldset>
@ -59,6 +62,13 @@
hide itself.
</p>
</fieldset>
<fieldset>
<legend>
{% translate "Room info" %}
</legend>
{% bootstrap_field form.broadcast_tools_room_info_lower_content layout='event' %}
{% bootstrap_field form.broadcast_tools_room_info_show_next_talk layout='event' %}
</fieldset>
<fieldset>
<legend>
{% translate "PDF export" %}

View file

@ -18,8 +18,9 @@
</head>
<body id="broadcast_tools_room_info">
<div id="broadcast_tools_room_info_header">
<h1 id="broadcast_tools_room_info_title">Loading ...</p>
<h2 id="broadcast_tools_room_info_speaker">Content should appear soon. If not, please verify you have Javascript enabled.</h2>
<h1 id="broadcast_tools_room_info_roomname"></h1>
<h2 id="broadcast_tools_room_info_title">Loading ...</h2>
<h3 id="broadcast_tools_room_info_speaker">Content should appear soon. If not, please verify you have Javascript enabled.</h3>
</div>
<div id="broadcast_tools_room_info_qr"></div>
</body>

View file

@ -1,37 +1,46 @@
from django.urls import re_path
from pretalx.event.models.event import SLUG_CHARS
from . import views
from .views.event_info import BroadcastToolsEventInfoView
from .views.orga import BroadcastToolsOrgaView
from .views.qr import BroadcastToolsFeedbackQrCodeSvg, BroadcastToolsPublicQrCodeSvg
from .views.schedule import BroadcastToolsScheduleView
from .views.static_html import BroadcastToolsLowerThirdsView, BroadcastToolsRoomInfoView
urlpatterns = [
re_path(
f"^(?P<event>[{SLUG_CHARS}]+)/p/broadcast-tools/lower-thirds/$",
views.BroadcastToolsLowerThirdsView.as_view(),
name="lowerthirds",
),
re_path(
f"^(?P<event>[{SLUG_CHARS}]+)/p/broadcast-tools/event.json$",
views.BroadcastToolsEventInfoView.as_view(),
BroadcastToolsEventInfoView.as_view(),
name="event_info",
),
re_path(
f"^(?P<event>[{SLUG_CHARS}]+)/p/broadcast-tools/feedback-qr/(?P<talk>[0-9]+).svg$",
views.BroadcastToolsFeedbackQrCodeSvg.as_view(),
name="feedback_qr_id",
),
re_path(
f"^(?P<event>[{SLUG_CHARS}]+)/p/broadcast-tools/room-info/$",
views.BroadcastToolsRoomInfoView.as_view(),
name="room_info",
),
re_path(
f"^(?P<event>[{SLUG_CHARS}]+)/p/broadcast-tools/schedule.json$",
views.BroadcastToolsScheduleView.as_view(),
BroadcastToolsScheduleView.as_view(),
name="schedule",
),
re_path(
f"^(?P<event>[{SLUG_CHARS}]+)/p/broadcast-tools/lower-thirds/$",
BroadcastToolsLowerThirdsView.as_view(),
name="lowerthirds",
),
re_path(
f"^(?P<event>[{SLUG_CHARS}]+)/p/broadcast-tools/feedback-qr/(?P<talk>[0-9]+).svg$",
BroadcastToolsFeedbackQrCodeSvg.as_view(),
name="feedback_qr_id",
),
re_path(
f"^(?P<event>[{SLUG_CHARS}]+)/p/broadcast-tools/public-qr/(?P<talk>[0-9]+).svg$",
BroadcastToolsPublicQrCodeSvg.as_view(),
name="public_qr_id",
),
re_path(
f"^(?P<event>[{SLUG_CHARS}]+)/p/broadcast-tools/room-info/$",
BroadcastToolsRoomInfoView.as_view(),
name="room_info",
),
re_path(
f"^orga/event/(?P<event>[{SLUG_CHARS}]+)/settings/p/broadcast-tools/$",
views.BroadcastToolsOrgaView.as_view(),
BroadcastToolsOrgaView.as_view(),
name="orga",
),
]

View file

@ -1,8 +1,10 @@
from django.conf import settings
def placeholders(schedule, talk):
return {
def placeholders(schedule, talk, supports_html_colour=False):
track_name = str(talk.submission.track.name) if talk.submission.track else ""
result = {
"CODE": talk.submission.code,
"EVENT_SLUG": str(schedule.event.slug),
"FEEDBACK_URL": "{}{}".format(
@ -14,4 +16,17 @@ def placeholders(schedule, talk):
schedule.event.custom_domain or settings.SITE_URL,
talk.submission.urls.public,
),
"TRACK_NAME": track_name,
}
if talk.submission.track and supports_html_colour:
result["TRACK_NAME_COLOURED"] = '<span style="color: {}">{}</span>'.format(
talk.submission.track.color, track_name
)
else:
result["TRACK_NAME_COLOURED"] = track_name
# for the americans
result["TRACK_NAME_COLORED"] = result["TRACK_NAME_COLOURED"]
return result

View file

@ -1,173 +0,0 @@
import datetime as dt
from xml.etree import ElementTree as ET
import pytz
import qrcode
import qrcode.image.svg
from django.conf import settings
from django.http import HttpResponse, JsonResponse
from django.urls import reverse
from django.utils.safestring import mark_safe
from django.views import View
from django.views.generic import FormView
from django.views.generic.base import TemplateView
from pretalx.agenda.views.schedule import ScheduleMixin
from pretalx.common.mixins.views import EventPermissionRequired, PermissionRequired
from pretalx.schedule.exporters import ScheduleData
from .forms import BroadcastToolsSettingsForm
from .utils.placeholders import placeholders
class BroadcastToolsLowerThirdsView(TemplateView):
template_name = "pretalx_broadcast_tools/lower_thirds.html"
class BroadcastToolsRoomInfoView(TemplateView):
template_name = "pretalx_broadcast_tools/room_info.html"
class BroadcastToolsFeedbackQrCode(TemplateView):
template_name = "pretalx_broadcast_tools/feedback_qr.html"
class BroadcastToolsOrgaView(PermissionRequired, FormView):
form_class = BroadcastToolsSettingsForm
permission_required = "orga.change_settings"
template_name = "pretalx_broadcast_tools/orga.html"
def get_success_url(self):
return self.request.path
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context["localized_rooms"] = [
room.name.localize(self.request.event.locale)
for room in self.request.event.rooms.all()
]
return context
def form_valid(self, form):
form.save()
return super().form_valid(form)
def get_object(self):
return self.request.event
def get_form_kwargs(self):
kwargs = super().get_form_kwargs()
return {
"obj": self.request.event,
"attribute_name": "settings",
"locales": self.request.event.locales,
**kwargs,
}
class BroadcastToolsEventInfoView(View):
def get(self, request, *args, **kwargs):
color = self.request.event.primary_color or "#3aa57c"
return JsonResponse(
{
"slug": self.request.event.slug,
"name": str(self.request.event.name),
"no_talk": str(
self.request.event.settings.broadcast_tools_lower_thirds_no_talk_info
),
"color": color,
},
)
class BroadcastToolsFeedbackQrCodeSvg(View):
def get(self, request, *args, **kwargs):
talk = self.request.event.submissions.filter(id=kwargs["talk"]).first()
domain = request.event.custom_domain or settings.SITE_URL
image = qrcode.make(
f"{domain}{talk.urls.feedback}", image_factory=qrcode.image.svg.SvgImage
)
svg_data = mark_safe(ET.tostring(image.get_image()).decode())
return HttpResponse(svg_data, content_type="image/svg+xml")
class BroadcastToolsScheduleView(EventPermissionRequired, ScheduleMixin, View):
permission_required = "agenda.view_schedule"
def get(self, request, *args, **kwargs):
schedule = ScheduleData(
event=self.request.event,
schedule=self.schedule,
)
tz = pytz.timezone(schedule.event.timezone)
infoline = str(
schedule.event.settings.broadcast_tools_lower_thirds_info_string or ""
)
try:
return JsonResponse(
{
"rooms": sorted(
{
room["name"].localize(schedule.event.locale)
for day in schedule.data
for room in day["rooms"]
}
),
"talks": [
{
"id": talk.submission.id,
"start": talk.start.astimezone(tz).isoformat(),
"end": (talk.start + dt.timedelta(minutes=talk.duration))
.astimezone(tz)
.isoformat(),
"slug": talk.frab_slug,
"title": talk.submission.title,
"persons": [
person.get_display_name()
for person in talk.submission.speakers.all()
],
"track": {
"color": talk.submission.track.color,
"name": str(talk.submission.track.name),
}
if talk.submission.track
else None,
"room": room["name"].localize(schedule.event.locale),
"infoline": infoline.format(**placeholders(schedule, talk)),
"urls": {
"feedback": "{}{}".format(
schedule.event.custom_domain or settings.SITE_URL,
talk.submission.urls.feedback,
),
"feedback_qr": reverse(
"plugins:pretalx_broadcast_tools:feedback_qr_id",
kwargs={
"event": schedule.event.slug,
"talk": talk.submission.id,
},
),
},
}
for day in schedule.data
for room in day["rooms"]
for talk in room["talks"]
],
},
)
except KeyError as e:
key = str(e)[1:-1]
return JsonResponse(
{
"error": [
f"Could not find value for placeholder {{{key}}} in info line.",
f"If you want to use {{{key}}} without evaluating it, please use as follows: {{{{{key}}}}}",
],
}
)
except Exception as e:
return JsonResponse(
{
"error": [
repr(e),
],
}
)

View file

@ -0,0 +1,30 @@
from django.http import JsonResponse
from django.views import View
class BroadcastToolsEventInfoView(View):
def get(self, request, *args, **kwargs):
color = self.request.event.primary_color or "#3aa57c"
return JsonResponse(
{
"color": color,
"name": self.request.event.name.localize(self.request.event.locale),
"no_talk": str(
self.request.event.settings.broadcast_tools_lower_thirds_no_talk_info
),
"room-info": {
"lower_info": self.request.event.settings.broadcast_tools_room_info_lower_content
or "",
"show_next_talk": (
True
if self.request.event.settings.broadcast_tools_room_info_show_next_talk
else False
),
},
"slug": self.request.event.slug,
"start": self.request.event.date_from.isoformat(),
"end": self.request.event.date_to.isoformat(),
"timezone": str(self.request.event.tz),
"locale": self.request.event.locale,
},
)

View file

@ -0,0 +1,37 @@
from django.views.generic import FormView
from pretalx.common.mixins.views import PermissionRequired
from ..forms import BroadcastToolsSettingsForm
class BroadcastToolsOrgaView(PermissionRequired, FormView):
form_class = BroadcastToolsSettingsForm
permission_required = "orga.change_settings"
template_name = "pretalx_broadcast_tools/orga.html"
def get_success_url(self):
return self.request.path
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context["localized_rooms"] = [
room.name.localize(self.request.event.locale)
for room in self.request.event.rooms.all()
]
return context
def form_valid(self, form):
form.save()
return super().form_valid(form)
def get_object(self):
return self.request.event
def get_form_kwargs(self):
kwargs = super().get_form_kwargs()
return {
"obj": self.request.event,
"attribute_name": "settings",
"locales": self.request.event.locales,
**kwargs,
}

View file

@ -0,0 +1,30 @@
from xml.etree import ElementTree as ET
import qrcode
import qrcode.image.svg
from django.conf import settings
from django.http import HttpResponse
from django.utils.safestring import mark_safe
from django.views import View
class BroadcastToolsFeedbackQrCodeSvg(View):
def get(self, request, *args, **kwargs):
talk = self.request.event.submissions.filter(id=kwargs["talk"]).first()
domain = request.event.custom_domain or settings.SITE_URL
image = qrcode.make(
f"{domain}{talk.urls.feedback}", image_factory=qrcode.image.svg.SvgImage
)
svg_data = mark_safe(ET.tostring(image.get_image()).decode())
return HttpResponse(svg_data, content_type="image/svg+xml")
class BroadcastToolsPublicQrCodeSvg(View):
def get(self, request, *args, **kwargs):
talk = self.request.event.submissions.filter(id=kwargs["talk"]).first()
domain = request.event.custom_domain or settings.SITE_URL
image = qrcode.make(
f"{domain}{talk.urls.public}", image_factory=qrcode.image.svg.SvgImage
)
svg_data = mark_safe(ET.tostring(image.get_image()).decode())
return HttpResponse(svg_data, content_type="image/svg+xml")

View file

@ -0,0 +1,122 @@
import datetime as dt
from django.conf import settings
from django.http import JsonResponse
from django.urls import reverse
from django.views import View
from pretalx.agenda.views.schedule import ScheduleMixin
from pretalx.common.mixins.views import EventPermissionRequired
from pretalx.schedule.exporters import ScheduleData
from ..utils.placeholders import placeholders
class BroadcastToolsScheduleView(EventPermissionRequired, ScheduleMixin, View):
permission_required = "agenda.view_schedule"
def get(self, request, *args, **kwargs):
schedule = ScheduleData(
event=self.request.event,
schedule=self.schedule,
)
infoline = str(
schedule.event.settings.broadcast_tools_lower_thirds_info_string or ""
)
try:
return JsonResponse(
{
"rooms": sorted(
{
room["name"].localize(schedule.event.locale)
for day in schedule.data
for room in day["rooms"]
}
),
"talks": [
{
"id": talk.submission.id,
"start": talk.start.astimezone(
schedule.event.tz
).isoformat(),
"start_ts": int(talk.start.timestamp()),
"end": (talk.start + dt.timedelta(minutes=talk.duration))
.astimezone(schedule.event.tz)
.isoformat(),
"end_ts": int(
(
talk.start + dt.timedelta(minutes=talk.duration)
).timestamp()
),
"slug": talk.frab_slug,
"title": talk.submission.title,
"persons": [
person.get_display_name()
for person in talk.submission.speakers.all()
],
"track": (
{
"color": talk.submission.track.color,
"name": str(talk.submission.track.name),
}
if talk.submission.track
else None
),
"room": room["name"].localize(schedule.event.locale),
"infoline": infoline.format(
**placeholders(
schedule, talk, supports_html_colour=True
)
),
"image_url": talk.submission.image_url,
"locale": talk.submission.content_locale,
"do_not_record": talk.submission.do_not_record,
"abstract": talk.submission.abstract,
"urls": {
"feedback": "{}{}".format(
schedule.event.custom_domain or settings.SITE_URL,
talk.submission.urls.feedback,
),
"feedback_qr": reverse(
"plugins:pretalx_broadcast_tools:feedback_qr_id",
kwargs={
"event": schedule.event.slug,
"talk": talk.submission.id,
},
),
"public": "{}{}".format(
schedule.event.custom_domain or settings.SITE_URL,
talk.submission.urls.public,
),
"public_qr": reverse(
"plugins:pretalx_broadcast_tools:public_qr_id",
kwargs={
"event": schedule.event.slug,
"talk": talk.submission.id,
},
),
},
}
for day in schedule.data
for room in day["rooms"]
for talk in room["talks"]
],
},
)
except KeyError as e:
key = str(e)[1:-1]
return JsonResponse(
{
"error": [
f"Could not find value for placeholder {{{key}}} in info line.",
f"If you want to use {{{key}}} without evaluating it, please use as follows: {{{{{key}}}}}",
],
}
)
except Exception as e:
return JsonResponse(
{
"error": [
repr(e),
],
}
)

View file

@ -0,0 +1,9 @@
from django.views.generic.base import TemplateView
class BroadcastToolsLowerThirdsView(TemplateView):
template_name = "pretalx_broadcast_tools/lower_thirds.html"
class BroadcastToolsRoomInfoView(TemplateView):
template_name = "pretalx_broadcast_tools/room_info.html"

39
pyproject.toml Normal file
View file

@ -0,0 +1,39 @@
[project]
name = "pretalx-broadcast-tools"
version = "2.2.0"
description = """
Some tools which can be used for supporting a broadcasting software.
This currently includes a generator for PDF printouts, a 'lower thirds'
endpoint, and a full-screen webpage showing information about the
currently running talk.
"""
readme = "README.rst"
license = {text = "Apache Software License"}
keywords = ["pretalx"]
authors = [
{name = "Franziska Kunsmann", email = "git@kunsmann.eu"},
]
maintainers = [
{name = "Franziska Kunsmann", email = "git@kunsmann.eu"},
]
dependencies = [
]
[project.entry-points."pretalx.plugin"]
pretalx_broadcast_tools = "pretalx_broadcast_tools:PretalxPluginMeta"
[build-system]
requires = [
"setuptools",
]
[project.urls]
homepage = "https://github.com/Kunsi/pretalx-plugin-broadcast-tools"
repository = "https://github.com/Kunsi/pretalx-plugin-broadcast-tools.git"
[tool.setuptools]
include-package-data = true
[tool.setuptools.packages.find]
include = ["pretalx*"]

View file

@ -1,46 +1,3 @@
import os
from distutils.command.build import build
from setuptools import setup
from django.core import management
from setuptools import find_packages, setup
try:
with open(
os.path.join(os.path.dirname(__file__), "README.rst"), encoding="utf-8"
) as f:
long_description = f.read()
except FileNotFoundError:
long_description = ""
class CustomBuild(build):
def run(self):
management.call_command("compilemessages", verbosity=1)
build.run(self)
cmdclass = {"build": CustomBuild}
setup(
name="pretalx-plugin-broadcast-tools",
version="1.1.0-beta1",
description=(
"Some tools which can be used for supporting a broadcasting "
"software, for example a 'lower third' page which can be "
"embedded into your broadcasting software"
),
long_description=long_description,
url="https://github.com/Kunsi/pretalx-plugin-broadcast-tools",
author="kunsi",
author_email="git@kunsmann.eu",
license="Apache Software License",
install_requires=[],
packages=find_packages(exclude=["tests", "tests.*"]),
include_package_data=True,
cmdclass=cmdclass,
entry_points="""
[pretalx.plugin]
pretalx_broadcast_tools=pretalx_broadcast_tools:PretalxPluginMeta
""",
)
setup()