ety/owncast-clipper
1
0
Fork 0
Code Issues Packages Activity

initial commit

Browse Source
This commit is contained in:
Glyphscribe Ety 2025-04-26 23:45:24 -05:00
commit f60db11733
10 changed files with 856 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

170
.gitignore vendored Normal file
View File

@ -0,0 +1,170 @@
# ---> Python
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# 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/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# UV
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
#uv.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
.pdm.toml
.pdm-python
.pdm-build/
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

15
Dockerfile Normal file
View File

@ -0,0 +1,15 @@
# Dockerfile
# Base image and add git (for peertube library)
FROM python:3.13-alpine
RUN apk update && apk add --no-cache git shadow ffmpeg
RUN groupadd clipperuser && adduser --ingroup clipperuser --disabled-password --gecos "" clipperuser
# Set up app directory
USER clipperuser
WORKDIR /app
COPY . .
RUN pip install --no-cache-dir requests websocket-client git+https://framagit.org/framasoft/peertube/clients/python.git
CMD ["python", "-u", "main.py"]

170
LICENSE Normal file
View File

@ -0,0 +1,170 @@
Creative Commons Attribution-ShareAlike 4.0 International
Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
Using Creative Commons Public Licenses
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described.
Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
Creative Commons Attribution-ShareAlike 4.0 International Public License
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
Section 1 – Definitions.
a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
j. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
Section 2 – Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
A. reproduce and Share the Licensed Material, in whole or in part; and
B. produce, reproduce, and Share Adapted Material.
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
3. Term. The term of this Public License is specified in Section 6(a).
4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
5. Downstream recipients.
A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this Public License.
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
Section 3 – License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified form), You must:
A. retain the following if it is supplied by the Licensor with the Licensed Material:
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of warranties;
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
Section 4 – Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
Section 5 – Disclaimer of Warranties and Limitation of Liability.
a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
Section 6 – Term and Termination.
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
2. upon express reinstatement by the Licensor.
c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
Section 7 – Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
Section 8 – Interpretation.
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
Creative Commons may be contacted at creativecommons.org.

32
README.md Normal file
View File

@ -0,0 +1,32 @@
# owncast-clipper
WIP: a bot that listens for clip requests from owncast chat and uploads to a configured peertube instance.
## Example docker-compose.yml
```yaml
version: '3'
services:
owncast:
image: gabekangas/owncast:latest
restart: unless-stopped
ports:
- 1935:1935
volumes:
- ./data/owncast:/app/data
clipper:
image: code.mch.onl/ety/owncast-clipper:latest
restart: unless-stopped
depends_on:
- owncast
volumes:
- ./data/owncast:/app/data:ro
- type: tmpfs
target: /tmp
environment:
- PEERTUBE_HOST=https://video.peertube.site # your PeerTube server
- PEERTUBE_USER=your_peertube_username
- PEERTUBE_PASS=SuperSecretPassword
- OWNCAST_HOST=http://owncast:8080 # internal or fully-qualified Owncast server
- OWNCAST_AUTH=AReallyLongOwncastAccessTokenString # Owncast access token with chat permission
```

9
config.py Normal file
View File

@ -0,0 +1,9 @@
# Tuning Globals
WEBSOCKET_MAX_RETRIES = 5
WEBSOCKET_INITIAL_BACKOFF = 5.0
## Configuration Globals
CLIP_DIRECTORY, TEMP_DIRECTORY, CLIP_QUANTITY = None, None, None
PEERTUBE_HOST, PEERTUBE_USER, PEERTUBE_PASS = None, None, None
OWNCAST_HOST, OWNCAST_AUTH = None, None
AUTHENTICATION_REQUIRED, PT_API_BASE = None, None

110
helpers/clips.py Normal file
View File

@ -0,0 +1,110 @@
# Standard Imports
import sys
import subprocess
from pathlib import Path
from datetime import datetime
# Local Imports
import config
from helpers.peertube_api import authenticate_to_peertube, upload_to_peertube
from helpers.owncast_api import get_owncast_title, send_owncast_message
def get_recent_segments(directory: Path, n: int):
"""
Returns a filtered list of the most recent .ts files in a directory.
Args:
directory (Path): The directory to search for .ts files.
n (int): The maximum number of files to return.
Returns:
list[str]: A list of absolute paths of the most recent n files.
"""
files = [f for f in directory.iterdir() if f.is_file()
and f.suffix.lower() == '.ts']
files.sort(key=lambda f: f.stat().st_mtime, reverse=False)
return [str(f.resolve()) for f in files[:n]]
def merge_segments_to_mp4(segments: list[str], output_path: Path, output_filename: str):
"""
Accepts a list of .ts files and attempts to concatenate them via ffmpeg.
Args:
segments (list[str]): A list of absolute paths to .ts filenames.
output_path (Path): An absolute path of the directory to create the new output file.
output_filename (str): The filename of the file to be created.
Returns:
Path: An asbsolute path to the created file, or None if the process failed.
"""
output_file = output_path / output_filename
if output_file.exists():
print(f'File already exists at: {output_file}. Abandoning.')
return None
# concat:/path/to/file1|/path/to/file2|...
segment_list = 'concat:' + '|'.join([f'{f}' for f in segments])
command = ['ffmpeg',
'-protocol_whitelist', 'concat,file',
'-i', segment_list,
'-c', 'copy',
output_file
]
process = subprocess.Popen(
command, stdin=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
stdout, stderr = process.communicate()
if process.returncode != 0:
print(f'ffmpeg ran into an issue creating {output_file}: {stderr}')
return None
return output_file
def generate_and_post_clip(user: str, title: str, timestamp: datetime):
"""
Invokes clip collection, remux, upload, and notification (chat) routines.
Args:
user (str): The name of the chat user that invoked the clip request.
title (str): The provided (or generated) title of the clip to be uploaded.
timestamp (datetime): The tz-aware timestamp indicating when clip was made.
Returns:
None
"""
recent_clips = get_recent_segments(
config.CLIP_DIRECTORY, config.CLIP_QUANTITY)
new_filename = f'{timestamp.strftime("%Y%m%d_%H%M%S_%f")}.mp4'
new_filepath = merge_segments_to_mp4(
recent_clips, config.TEMP_DIRECTORY, new_filename)
if (token := authenticate_to_peertube(config.PT_API_BASE, config.PEERTUBE_USER, config.PEERTUBE_PASS)) is None:
print(f'Failed to authenticate to PeerTube', file=sys.stderr)
return
# TODO: handle this gracefully
stream_title = ''
if (stream_title := get_owncast_title()):
stream_title = f'during the "{stream_title}" stream'
upload_options = {}
upload_options[
'description'] = f'🎞️ Clipped by **{user}** {stream_title} on {timestamp.strftime("%Y-%m-%d %H:%M:%S")}'
upload_options['description'] += f'\n🌐 {config.OWNCAST_HOST}'
if (video_url := upload_to_peertube(config.PT_API_BASE, token, new_filepath, 3800, title, **upload_options)) is None:
print(f'Failed to upload file to PeerTube', file=sys.stderr)
return
# TODO: handle this gracefully
clip_url = f'{config.PEERTUBE_HOST}{video_url}'
message = f'**{title}**: {clip_url}'
send_owncast_message(message)
print(f'Clip created by {user} at {timestamp}: {clip_url}')
return

57
helpers/owncast_api.py Normal file
View File

@ -0,0 +1,57 @@
# Standard imports
import json
import sys
# Package Imports
import requests
# Local Imports
import config
def get_owncast_title():
"""
Gets the current owncast stream title, if any, via API call
Returns:
str: The current stream title, if one is set; otherwise None.
"""
try:
response = requests.get(f'{config.OWNCAST_HOST}/api/status')
if response.status_code != 200:
print(
f'Received a {response.status_code} response from Owncast while getting the title: {response}', file=sys.stderr)
return None
data = response.json()
except json.JSONDecodeError as e:
print(
f'Unable to parse response JSON from Owncast: {e}: {response}', file=sys.stderr)
return None
return data.get('streamTitle')
# TODO this should probably return whether or not it was successful.
def send_owncast_message(message: str):
"""
Sends a chat message to the owncast server via self-contained API call.
Args:
message (str): The message to be sent to owncast as the Clip Bot user
Returns:
None
"""
try:
url = f'{config.OWNCAST_HOST}/api/integrations/chat/send'
headers = {'Authorization': f'Bearer {config.OWNCAST_AUTH}'}
response = requests.post(
url=url, headers=headers, json={'body': message})
if response.status_code != 200:
print(
f'Received a {response.status_code} response from Owncast while trying to send a message: {response}', file=sys.stderr)
except requests.exceptions.RequestException as e:
print(
f'Error occurred while sending a chat message: {e}', file=sys.stderr)
return

132
helpers/peertube_api.py Normal file
View File

@ -0,0 +1,132 @@
# Standard Imports
import sys
import json
from pprint import pprint
# Package Imports
import requests
import peertube
# Local Imports
from peertube.rest import ApiException
from pathlib import Path
def peertube_request(endpoint: str, verb: str, **kwargs):
"""
A helper function that facilitates basic requests to PeerTube and decodes.
Args:
endpoint (str): A URL to act against.
verb (str): either "GET" or "POST".
**kwargs: Passed through to underlying request call (for e.g. POSTs).
Returns:
dict: The JSON-decoded response from the request, or None if there was an error.
"""
data = kwargs.get('data', None)
try:
if verb == 'GET':
response = requests.get(endpoint)
elif verb == 'POST':
response = requests.post(endpoint, data=data)
else:
return None
status_code = response.status_code
data = response.json()
if status_code != 200:
print(
f'Received a {status_code} response from PeerTube: {response}', file=sys.stderr)
return None
except json.JSONDecodeError as e:
print(
f'Unable to parse response JSON from PeerTube: {e}: {response}', file=sys.stderr)
return None
except requests.exceptions.RequestException as e:
print(
f'An error occurred while communicating with PeerTube: {e}', file=sys.stderr)
return None
else:
return data
def authenticate_to_peertube(api_base: str, username: str, password: str):
"""
Collects an access token from PeerTube via password authentication
Args:
api_base (str): The API base url for the given PeerTube instance, e.g. https://video.site/api/v1
username (str): The username of the PeerTube account to be used in authentication
password (str): The password of the PeerTube account to be used in authentication
Returns:
str: A string containing the access_token following authentication, or None if unable to auth.
"""
if (data := peertube_request(api_base + '/oauth-clients/local', 'GET')) is None:
print('Error initializing OAuth flow with PeerTube.', file=sys.stderr)
return None
client_id = data['client_id']
client_secret = data['client_secret']
data = {
'client_id': client_id,
'client_secret': client_secret,
'grant_type': 'password',
'response_type': 'code',
'username': username,
'password': password
}
if (data := peertube_request(api_base + '/users/token', 'POST', data=data)) is None:
print('Error authenticating with PeerTube via OAuth.', file=sys.stderr)
return None
return data['access_token']
def upload_to_peertube(api_base: str, api_token: str, file: Path, channel_id: int, title: str, **kwargs):
"""
Uploads a file from the local filesystem to PeerTube and returns a ready-to-consume URL to the video.
Args:
api_base (str): The API base url for the given PeerTube instance, e.g. https://video.site/api/v1
api_token (str): A valid OAuth access token obtained from previous authentication.
file (Path): An absolute path to the video file to be uploaded.
channel_id (int): The internal ID number of the PeerTube channel to be uploaded to.
title (str): The public-facing name of the video on PeerTube
**kwargs: Any other values to pass to the PeerTube Video Upload API: https://framagit.org/framasoft/peertube/clients/python/-/blob/master/docs/VideoApi.md#videos_upload_post
Returns:
str: A string containing the URL to the video on PeerTube, or None if unable to publish.
"""
configuration = peertube.Configuration(
host=api_base
)
configuration.access_token = api_token
with peertube.ApiClient(configuration) as api_client:
api_instance = peertube.VideoApi(api_client)
try:
options = {
**kwargs,
'privacy': 1,
'wait_transcoding': True
}
api_response = api_instance.videos_upload_post(
file, channel_id, title, **options)
except ApiException as e:
print(
f'Exception while uploading to PeerTube: {e}', file=sys.stderr)
return None
try:
video_id = api_response.video.uuid
api_response = api_instance.videos_id_get(video_id)
except ApiException as e:
print(
f'Exception while getting Clip URL from PeerTube: {e}', file=sys.stderr)
return None
except KeyError as e:
print(
f'Could not find Video ID in response from PeerTube: {e}', file=sys.stderr)
return None
return api_response.embed_path

98
helpers/websocket.py Normal file
View File

@ -0,0 +1,98 @@
# Standard Imports
import re
import sys
import html
import time
import json
from datetime import datetime
from zoneinfo import ZoneInfo
# Package Imports
import websocket
# Local Imports
from helpers.clips import generate_and_post_clip
def owncast_on_message(ws, message):
"""
Handles incoming messages from websocket, filters for commands, and dispatches.
Args:
ws: The websocket object calling this handler.
message: The message received by the websocket.
Returns:
None
"""
try:
data = json.loads(message)
if 'type' in data and data['type'] == 'CHAT':
# TODO: add anti-spam and authentication checks
current_time = datetime.now(ZoneInfo("America/Chicago"))
chat_message = html.unescape(
re.sub('<.*?>', '', data['body'])).strip()
if chat_message == '!clip' or chat_message.startswith('!clip '):
if len(chat_message) == 5:
clip_title = f'Clip by {data["user"]["displayName"]} on {current_time.strftime("%Y-%m-%d %H:%M:%S")}'
generate_and_post_clip(
data['user']['displayName'], clip_title, current_time)
elif len(chat_message) > 5 and len(chat_message) < 126:
generate_and_post_clip(
data['user']['displayName'], chat_message[6:], current_time)
else:
# TODO: report this error back to the chat
return
except json.JSONDecodeError as e:
print(f'Failed to decode incoming owncast websocket message.', file=sys.stderr)
def owncast_on_error(ws, error):
print(f'[WS-ERR] {error}', file=sys.stderr)
def owncast_on_close(ws, code, message):
print(f'Owncast websocket closed (code: {code}): {message}')
def owncast_on_open(ws):
print('Owncast websocket opened successfully.')
def owncast_connect(url: str, retries: int, initial_backoff: float):
"""
Attempts to connect to the Owncast websocket and auto-reconnect with backoff
Args:
url (str): The websocket service url to connect to.
retries (int): The maximum number of reconnect attemps before failing.
initial_backoff (float): The base amount of reconnection backoff time in seconds
Returns:
None
"""
attempt = 0
backoff = initial_backoff
while attempt < retries:
ws = websocket.WebSocketApp(url,
on_open=owncast_on_open,
on_message=owncast_on_message,
on_error=owncast_on_error,
on_close=owncast_on_close
)
try:
ws.run_forever()
except KeyboardInterrupt:
print('\nInterrupted by user. Exiting.')
sys.exit(0)
attempt += 1
if attempt < retries:
print(f'Reconnecting in {backoff:.1f}s ({attempt} of {retries})')
time.sleep(backoff)
backoff *= 2
print(f'Max reconnect attempts reached. Exiting.')

63
main.py Normal file
View File

@ -0,0 +1,63 @@
# Standard Imports
import os
import sys
from urllib.parse import urlparse
from pathlib import Path
# Module Imports
import config
from helpers.websocket import owncast_connect
def main():
config.CLIP_DIRECTORY = Path(os.environ.get(
'CLIP_DIRECTORY', '/app/data/hls/0/'))
config.TEMP_DIRECTORY = Path(os.environ.get('TEMP_DIRECTORY', '/tmp/'))
try:
config.CLIP_QUANTITY = int(os.environ.get('CLIP_QUANTITY', '20'))
except ValueError:
print("Error: config.CLIP_QUANTITY must be an integer.", file=sys.stderr)
sys.exit(1)
try:
# full base, e.g. https://peertube.coolsite.com or http://peertube:8080
config.PEERTUBE_HOST = os.environ['PEERTUBE_HOST'].rstrip('/')
config.PEERTUBE_USER = os.environ['PEERTUBE_USER']
config.PEERTUBE_PASS = os.environ['PEERTUBE_PASS']
except KeyError as e:
print(
f'Error: PeerTube host and credentials must be specified: {e}', file=sys.stderr)
sys.exit(1)
config.PT_API_BASE = f'{config.PEERTUBE_HOST}/api/v1'
try:
# full base, e.g. https://owncast.site or http://app:8080
config.OWNCAST_HOST = os.environ['OWNCAST_HOST'].rstrip('/')
config.OWNCAST_AUTH = os.environ['OWNCAST_AUTH']
except KeyError as e:
print(
f'Error: Owncast host and access token must be specified: {e}', file=sys.stderr)
sys.exit(1)
config.AUTHENTICATION_REQUIRED = os.environ.get(
'AUTHENTICATION_REQUIRED', False)
for d in [config.CLIP_DIRECTORY, config.TEMP_DIRECTORY]:
if not d.is_dir():
print(f'Error: {d} is not a directory.', file=sys.stderr)
sys.exit(1)
owncast_parsed = urlparse(config.OWNCAST_HOST)
owncast_scheme, owncast_domain = owncast_parsed.scheme, owncast_parsed.netloc
if owncast_scheme.lower() == 'http':
owncast_ws_scheme = 'ws'
elif owncast_scheme.lower() == 'https':
owncast_ws_scheme = 'wss'
owncast_connect_url = f'{owncast_ws_scheme}://{owncast_domain}/ws?accessToken={config.OWNCAST_AUTH}'
print(owncast_connect_url)
owncast_connect(owncast_connect_url, config.WEBSOCKET_MAX_RETRIES,
config.WEBSOCKET_INITIAL_BACKOFF)
if __name__ == "__main__":
main()