initial commit

.github/workflows/style.yml

@@ -0,0 +1,155 @@
+name: Code Style
+
+on:
+  push:
+    branches: [ main ]
+    paths-ignore:
+      - 'pretalx_lower_thirds/locale/**'
+      - 'pretalx_lower_thirds/static/**'
+  pull_request:
+    branches: [ main ]
+    paths-ignore:
+      - 'pretalx_lower_thirds/locale/**'
+      - 'pretalx_lower_thirds/static/**'
+
+
+jobs:
+  isort:
+    name: isort
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - 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 isort -Ue .
+      - name: Run isort
+        run: isort -c .
+  flake:
+    name: flake8
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - 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 flake8 -Ue .
+      - name: Run flake8
+        run: flake8 .
+        working-directory: .
+  black:
+    name: black
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - 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 black -Ue .
+      - name: Run black
+        run: black --check .
+        working-directory: .
+  docformatter:
+    name: docformatter
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - 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 docformatter -Ue .
+      - name: Run docformatter
+        run: docformatter --check -r .
+        working-directory: .
+      - name: Run docformatter
+  djhtml:
+    name: djhtml
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - 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 djhtml -Ue .
+      - 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: 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: .
+

.gitignore

@@ -0,0 +1,63 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+.ropeproject/
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2021 kunsi
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

MANIFEST.in

@@ -0,0 +1,3 @@
+recursive-include pretalx_lower_thirds/static *
+recursive-include pretalx_lower_thirds/templates *
+recursive-include pretalx_lower_thirds/locale *

Makefile

@@ -0,0 +1,8 @@
+all: localecompile
+
+localecompile:
+	django-admin compilemessages
+
+localegen:
+	django-admin makemessages -l de_DE -i build -i dist -i "*egg*"
+

README.rst

@@ -0,0 +1,32 @@
+Lower Thirds
+==========================
+
+This is a plugin for `pretalx`_. 
+
+Development setup
+-----------------
+
+1. Make sure that you have a working `pretalx development setup`_.
+
+2. Clone this repository, eg to ``local/pretalx-plugin-lower-thirds``.
+
+3. Activate the virtual environment you use for pretalx development.
+
+4. Execute ``python setup.py develop`` within this directory to register this application with pretalx's plugin registry.
+
+5. Execute ``make`` within this directory to compile translations.
+
+6. Restart your local pretalx server. You can now use the plugin from this repository for your events by enabling it in
+   the 'plugins' tab in the settings.
+
+
+License
+-------
+
+Copyright 2021 kunsi
+
+Released under the terms of the Apache License 2.0
+
+
+.. _pretalx: https://github.com/pretalx/pretalx
+.. _pretalx development setup: https://docs.pretalx.org/en/latest/developer/setup.html

pretalx_lower_thirds/apps.py

@@ -0,0 +1,17 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy
+
+
+class PluginApp(AppConfig):
+    name = "pretalx_lower_thirds"
+    verbose_name = "Lower Thirds"
+
+    class PretalxPluginMeta:
+        name = gettext_lazy("Lower Thirds")
+        author = "kunsi"
+        description = gettext_lazy("Creates lower thirds from your current schedule. Will show speaker names and talk title using the configured track and event colours.")
+        visible = True
+        version = "0.0.0"
+
+    def ready(self):
+        from . import signals  # NOQA

pretalx_lower_thirds/signals.py

@@ -0,0 +1 @@
+# Register your receivers here

pretalx_lower_thirds/static/pretalx_lower_thirds/frontend.css

@@ -0,0 +1,30 @@
+* {
+    margin: 0;
+    padding: 0;
+    line-height: 1.2em;
+}
+
+#box {
+    width: 1020px;
+
+    position: absolute;
+    bottom: 80px;
+    left: 50%;
+    margin-left: -510px;
+
+    color: white;
+    font-family: "Muli","Open Sans","OpenSans","Helvetica Neue",Helvetica,Arial,sans-serif;
+    padding: 15px;
+
+    box-shadow: 5px 5px 10px 0px rgba(50, 50, 50, 0.75);
+}
+
+#title {
+    font-size: 30px;
+    font-weight: 500;
+    margin-bottom: 15px;
+}
+
+#speaker {
+    font-size: 20px;
+}

pretalx_lower_thirds/static/pretalx_lower_thirds/update.js

@@ -0,0 +1,70 @@
+schedule = null;
+room_name = null;
+
+$(function() {
+    $('#speaker').text('Content will appear soon.');
+});
+
+function update_lower_third() {
+    current_time = new Date(Date.now()).getTime()
+
+    try {
+        hash = decodeURIComponent(window.location.hash.substring(1));
+        room_name = hash;
+    } catch (e) {
+        console.error(e);
+        return
+    }
+
+    if (!schedule) {
+        console.warn("There's no schedule yet, exiting ...");
+        return
+    }
+
+    if (schedule['rooms'].length > 1 && !schedule['rooms'].includes(room_name)) {
+        $('#title').text('Error')
+        $('#speaker').text('Invalid room_name. Valid names: ' + schedule['rooms'].join(', '));
+
+        return
+    }
+
+    current_talk = null;
+
+    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();
+        talk_end = new Date(talk['end']).getTime();
+
+        if (talk_start < current_time && talk_end > current_time) {
+            current_talk = talk;
+        }
+    }
+
+    if (current_talk) {
+        $('#title').text(current_talk['title']);
+        $('#speaker').text(current_talk['persons'].join(', '));
+        $('#box').css('border-bottom', '10px solid ' + current_talk['track']['color']);
+    } else {
+        $('#title').text('Currently no talk');
+        $('#speaker').text('');
+        $('#box').css('border-bottom', 'none');
+    }
+}
+window.setInterval(update_lower_third, 1000);
+
+function update_schedule() {
+    $.getJSON('schedule.json', function(data) {
+        console.info('schedule updated with ' + data['talks'].length + ' talks in ' + data['rooms'].length + ' rooms');
+
+        schedule = data;
+
+        window.setTimeout(update_schedule, 30000);
+    });
+}
+update_schedule();

pretalx_lower_thirds/templates/pretalx_lower_thirds/lower_thirds.html

@@ -0,0 +1,25 @@
+{% load static %}
+{% load compress %}
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta http-equiv="content-type" content="text/html" charset="UTF-8">
+        <title>{{ request.event.name }} lower thirds</title>
+        {% compress js %}
+        <script src="{% static "vendored/jquery-3.1.1.js" %}"></script>
+        {% endcompress %}
+        <script src="{% static "pretalx_lower_thirds/update.js" %}"></script>
+        <link rel="stylesheet" href="{% static "pretalx_lower_thirds/frontend.css" %}" />
+        <style type="text/css">
+            #box {
+                background-color: {{ request.event.primary_color }};
+            }
+        </style>
+    </head>
+    <body>
+        <div id="box">
+            <p id="title">Loading ...</p>
+            <p id="speaker">Content should appear soon. If not, please verify you have Javascript enabled.</p>
+        </div>
+    </body>
+</html>

pretalx_lower_thirds/urls.py

@@ -0,0 +1,18 @@
+from django.urls import re_path
+
+from pretalx.event.models.event import SLUG_CHARS
+
+from . import views
+
+urlpatterns = [
+    re_path(
+        f"^(?P<event>[{SLUG_CHARS}]+)/p/lower-thirds/$",
+        views.LowerThirdsView.as_view(),
+        name="lowerthirds",
+    ),
+    re_path(
+        f"^(?P<event>[{SLUG_CHARS}]+)/p/lower-thirds/schedule.json$",
+        views.ScheduleView.as_view(),
+        name="schedule",
+    ),
+]

pretalx_lower_thirds/views.py

@@ -0,0 +1,71 @@
+import datetime as dt
+import json
+import pytz
+import random
+
+from django.contrib import messages
+from django.db.models import Case, OuterRef, Subquery, When
+from django.http import Http404, JsonResponse
+from django.shortcuts import redirect
+from django.urls import reverse
+from django.utils.functional import cached_property
+from django.utils.timezone import now
+from django.utils.translation import gettext_lazy as _
+from django.views.generic.base import TemplateView
+from django_context_decorator import context
+
+from pretalx.agenda.views.schedule import ScheduleMixin
+from pretalx.common.mixins.views import EventPermissionRequired
+from pretalx.common.signals import register_data_exporters
+from pretalx.schedule.exporters import ScheduleData
+
+
+class LowerThirdsView(TemplateView):
+    template_name = "pretalx_lower_thirds/lower_thirds.html"
+
+
+class ScheduleView(EventPermissionRequired, ScheduleMixin, TemplateView):
+    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)
+        return JsonResponse(
+            {
+                "conference": {
+                    "slug": schedule.event.slug,
+                    "name": str(schedule.event.name),
+                },
+                "rooms": sorted({
+                    str(room["name"])
+                    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": sorted({
+                            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": str(room["name"]),
+                    }
+                    for day in schedule.data
+                    for room in day["rooms"]
+                    for talk in room["talks"]
+                ],
+            },
+            json_dumps_params={
+                "indent": 4,
+            },
+        )

pylama.ini

@@ -0,0 +1,3 @@
+[pylama]
+ignore = E501,
+skip = */settings.py,*/celery_app.py,*.ropeproject/*

pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+DJANGO_SETTINGS_MODULE=pretalx.common.settings.test_settings

setup.cfg

@@ -0,0 +1,10 @@
+[isort]
+balanced_wrapping = True
+combine_as_imports = True
+default_section = THIRDPARTY
+include_trailing_comma = True
+known_third_party = pretalx
+line_length = 80
+multi_line_output = 5
+not_skip = __init__.py
+skip = migrations,setup.py

setup.py

@@ -0,0 +1,42 @@
+import os
+from distutils.command.build import build
+
+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-lower-thirds",
+    version="0.0.0",
+    description="Creates lower thirds from your current schedule. Will show speaker names and talk title using the configured track and event colours.",
+    long_description=long_description,
+    url="https://git.franzi.business/kunsi/pretalx-plugin-lower-thirds",
+    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_lower_thirds=pretalx_lower_thirds:PretalxPluginMeta
+""",
+)