Merge pull request #362 from justjanne/refactor-imports

Modernize build setup & tests

Author: Kunsi

.github/workflows/test.yaml

@@ -0,0 +1,34 @@
+name: Test
+
+on: [push]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+      - name: Install the project
+        run: uv sync --dev
+      - name: Run tests
+        run: uv run pytest
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          context: .
+          push: false

.python-version

@@ -1 +1 @@
-3.6.9
+>=3.11

Dockerfile

@@ -0,0 +1,24 @@
+FROM ubuntu:22.04
+
+RUN apt-get update \
+ && apt-get install -y --no-install-recommends \
+        ffmpeg \
+        gir1.2-gstreamer-1.0 \
+        gir1.2-gst-plugins-base-1.0 \
+        libgstreamer1.0-0 \
+        gstreamer1.0-libav \
+        gstreamer1.0-plugins-bad \
+        gstreamer1.0-plugins-base \
+        gstreamer1.0-plugins-good \
+        gstreamer1.0-plugins-ugly \
+        gstreamer1.0-tools \
+        python3 \
+        python3-gi \
+        python3-pip \
+ && rm -rf /var/lib/apt/lists/*
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+ADD . /voctomix
+WORKDIR /voctomix
+RUN uv pip install --system --requirements pyproject.toml
+ENTRYPOINT ["python3", "-m", "voctocore"]

README.md

@@ -6,6 +6,20 @@ We support all python versions between "latest stable" and "available in
 debian stable". Older python versions might work, but we don't test on
 those.
 
+## Developer Setup
+
+```bash
+uv venv --system-site-packages
+uv sync
+uv pip install pygobject-stubs --config-settings=config=Gtk3
+```
+
+## Tests
+
+```bash
+uv run pytest
+```
+
 ## Current Documentation
 
 - [Core](https://github.com/voc/voctomix/tree/voctomix2/voctocore)

example-scripts/gstreamer/ingest.py

@@ -26,9 +26,6 @@
 Gst.init([])
 
 # this is to use the same code tha gui uses to get config from core
-sys.path.insert(0, '../..')
-sys.path.insert(0, '.')
-
 import voctogui.lib.connection as Connection
 
 

pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "voctomix"
+version = "0.1.0"
+description = "voctomix is a video mixing software, written in python."
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "scipy>=1.15.2",
+    "sdnotify>=0.3.2",
+]
+
+[dependency-groups]
+dev = [
+    "mock>=5.2.0",
+    "pytest>=8.3.5",
+    "pygobject-stubs>=2.13.0",
+]
+
+[tool.uv]
+python-preference = "only-system"
+
+[tool.pytest.ini_options]
+testpaths = [
+    "voctocore/tests",
+    "voctogui/tests",
+]

uv.lock

@@ -3,7 +3,6 @@
 import logging
 import sys
 
-from lib.config import Config
 from gi.repository import Gst
 
 gi.require_version('GstController', '1.0')
@@ -50,13 +49,13 @@ def create_mixmatrix(in_channels: int, out_channels: int, channel_mapping: str):
     return pipeline
 
 
-def construct_audio_encoder_pipeline(section):
+def construct_audio_encoder_pipeline(config, section):
     """
     Build audio encoder pipeline block including an adapter matrix for channel mapping
     :param section: Name of the config section this block is for
     :return: String containing the pipeline block
     """
-    encoder = Config.get_audio_encoder(section)
+    encoder = config.get_audio_encoder(section)
     encoder_options = None
     # check if we have an option string as part of the codec config
     if ',' in encoder:
@@ -66,11 +65,11 @@ def construct_audio_encoder_pipeline(section):
     if encoder in encoders:
         pipeline += """! audioconvert
                            {mixmatrix} ! {encoder} ! {acaps}
-                    """.format(mixmatrix=create_mixmatrix(Config.getAudioChannels(),
-                                                          Config.get_sink_audio_channels(section),
-                                                          Config.get_sink_audio_map(section)),
+                    """.format(mixmatrix=create_mixmatrix(config.getAudioChannels(),
+                                                          config.get_sink_audio_channels(section),
+                                                          config.get_sink_audio_map(section)),
                                encoder=encoder,
-                               acaps=Config.getAudioCaps(section))
+                               acaps=config.getAudioCaps(section))
     else:
         log.error("Unknown audio encoder {}".format(encoder))
         sys.exit(-1)

vocto/audio_codecs.py

@@ -14,18 +14,18 @@ def from_str(command):
         B = None
         # match case: c(A,B)
         r = re.match(
-            r'^\s*([|+-]?\w[-_\w]*)\s*\(\s*([-_\w*]+)\s*,\s*([-_\w*]+)\)\s*$', command)
+            r'^\s*([|+-]?[-_\w*]+)\s*\(\s*([-_\w*]+)\s*,\s*([-_\w*]+)\)\s*$', command)
         if r:
             A = r.group(2)
             B = r.group(3)
         else:
             # match case: c(A)
-            r = re.match(r'^\s*([|+-]?\w[-_\w]*)\s*\(\s*([-_\w*]+)\s*\)\s*$', command)
+            r = re.match(r'^\s*([|+-]?[-_\w*]+)\s*\(\s*([-_\w*]+)\s*\)\s*$', command)
             if r:
                 A = r.group(2)
             else:
                 # match case: c
-                r = re.match(r'^\s*([|+-]?\w[-_\w]*)\s*$', command)
+                r = re.match(r'^\s*([|+-]?[-_\w*]+)\s*$', command)
                 assert r
         composite = r.group(1)
         if composite == '*':

vocto/composite_commands.py

@@ -5,7 +5,6 @@
 from configparser import ConfigParser
 
 from gi.repository import Gst
-from lib.args import Args
 
 from vocto import kind_has_audio, kind_has_video
 from vocto.audio_streams import AudioStreams