slidcord 0.3.1__tar.gz

slidcord-0.3.1/.copier-answers.yml

@@ -0,0 +1,16 @@
+# Do not edit manually!
+# Changes here will be overwritten by copier.
+# https://copier.readthedocs.io/
+_commit: 4d7f077
+_src_path: git+https://codeberg.org/slidge/legacy-module-template
+debian_bundle: true
+native_build: false
+project_name: slidcord
+repology: ''
+silo:
+    hostile: true
+    lib:
+        name: discord.py-self
+        url: https://discordpy-self.readthedocs.io
+    name: Discord
+    url: https://discord.com/

slidcord-0.3.1/.gitignore

@@ -0,0 +1,11 @@
+__pycache__
+.mypy_cache
+.pytest_cache
+.ruff_cache
+.idea
+dist
+docs/build
+persistent
+.venv
+slidcord.egg-info
+build

slidcord-0.3.1/.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+# DO NOT EDIT
+# This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
+
+default_stages: [pre-commit]
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+        args: [--assume-in-merge]
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.5.21
+    hooks:
+      - id: uv-lock
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.9.2
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
+
+  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
+    rev: v9.20.0
+    hooks:
+    - id: commitlint
+      stages: [commit-msg]
+      additional_dependencies: ['@commitlint/config-conventional']
+
+  - repo: local
+    hooks:
+      - id: mypy
+        name: Static type check with mypy
+        entry: .venv/bin/mypy
+        language: system
+        pass_filenames: false
+        files: .*\.py
+      - id: pytest-check
+        name: pytest-check
+        entry: .venv/bin/pytest tests
+        language: system
+        pass_filenames: false
+        always_run: true

slidcord-0.3.1/.woodpecker/container.yaml

@@ -0,0 +1,102 @@
+# DO NOT EDIT
+# Generated from .copier-answers.yml
+
+
+labels:
+  platform: linux/amd64
+
+clone:
+  - name: clone-deep
+    image: woodpeckerci/plugin-git
+    settings:
+      tags: true
+      partial: false
+
+variables:
+  - &settings
+    repo: codeberg.org/${CI_REPO_OWNER}/slidcord
+    username: ${CI_REPO_OWNER}
+    password:
+      from_secret: CODEBERG_TOKEN
+    registry: codeberg.org
+    target: slidcord
+    # this only caches one of the two platforms unfortunately
+    # https://github.com/docker/buildx/discussions/1382
+    # https://github.com/docker/buildx/issues/1044
+    cache_images:
+      - codeberg.org/${CI_REPO_OWNER}/slidcord:buildcache
+    platforms: linux/amd64,linux/arm64
+  - &paths
+    - "slidcord/**"
+    - Dockerfile
+    - pyproject.toml
+    - .woodpecker/container.yaml
+
+when:
+  - event: tag
+  - event: push
+    path: *paths
+  - event: cron
+    cron: container-main
+  - event: cron
+    cron: container-latest
+
+steps:
+  build-tag:
+    image: woodpeckerci/plugin-docker-buildx:6.0.2
+    when:
+      event: [tag]
+    settings:
+      <<: *settings
+      build_args:
+        SLIDGE_USE_LOCKFILE: "1"
+      tags:
+        - latest
+        - ${CI_COMMIT_TAG}
+
+  build-branch:
+    when:
+      - event: push
+        path: *paths
+      - event: cron
+        cron: container-main
+    image: woodpeckerci/plugin-docker-buildx:6.0.2
+    settings:
+      <<: *settings
+      build_args:
+        SLIDGE_PRERELEASE: "1"
+      tags:
+        - ${CI_COMMIT_BRANCH}
+
+  build-ci:
+    when:
+        path: *paths
+        branch: ${CI_REPO_DEFAULT_BRANCH}
+    image: woodpeckerci/plugin-docker-buildx:6.0.2
+    settings:
+      <<: *settings
+      build_args:
+        SLIDGE_USE_LOCKFILE: "1"
+      target: ci
+      tag: ci
+      cache_images:
+        - codeberg.org/${CI_REPO_OWNER}/slidcord:buildcache-ci
+
+  checkout-latest-tag:
+    image: woodpeckerci/plugin-git
+    when:
+      - event: cron
+        cron: container-latest
+    commands:
+      - export TAG=$(git describe --tags --abbrev=0)
+      - git checkout $TAG
+      - git reset --hard
+      - echo latest > .tags
+
+  rebuild-tag:
+    image: woodpeckerci/plugin-docker-buildx:6.0.2
+    when:
+      - event: cron
+        cron: container-latest
+    settings:
+      <<: *settings

slidcord-0.3.1/.woodpecker/docs.yaml

@@ -0,0 +1,23 @@
+# DO NOT EDIT
+# Generated from .copier-answers.yml
+
+when:
+  event: [push, tag, pull_request]
+  path: ["slidcord/**/*.py", "docs/**/*", "uv.lock", ".woodpecker/docs.yaml"]
+
+steps:
+  build:
+    image: codeberg.org/${CI_REPO_OWNER}/slidcord:ci
+    pull: true
+    commands:
+      - uv sync --all-groups --all-extras
+      - cd docs && make html
+
+  publish:
+    image: codeberg.org/slidge/woodpecker-publish-pages
+    pull: true
+    when:
+      event: [push, tag]
+    settings:
+      token:
+        from_secret: CODEBERG_TOKEN

slidcord-0.3.1/.woodpecker/package.yaml

@@ -0,0 +1,62 @@
+# DO NOT EDIT
+# Generated from .copier-answers.yml
+
+when:
+  event: [push, tag]
+  path: ["slidcord/**/*", "pyproject.toml", "README.md"]
+  branch: main
+
+variables:
+  - &ci-image codeberg.org/${CI_REPO_OWNER}/slidcord:ci
+
+clone:
+  - name: clone-deep
+    image: woodpeckerci/plugin-git
+    settings:
+      tags: true
+      partial: false
+
+steps:
+  changelog:
+    image: codeberg.org/slidge/woodpecker-generate-changelog
+    pull: true
+
+  build:
+    image: *ci-image
+    pull: true
+    commands:
+      - uv build
+
+  codeberg-pypi:
+    when:
+      event: [push, tag]
+    image: *ci-image
+    depends_on: build
+    environment:
+      CODEBERG_TOKEN:
+        from_secret: CODEBERG_TOKEN
+    commands:
+      - uv publish --index codeberg --token $CODEBERG_TOKEN
+
+  pypi:
+    image: *ci-image
+    depends_on: build
+    when:
+      event: tag
+    environment:
+      PYPI_TOKEN:
+        from_secret: PYPI_TOKEN
+    commands:
+      - uv publish --token $PYPI_TOKEN
+
+  codeberg-release:
+    image: woodpeckerci/plugin-release
+    depends_on: [changelog, build]
+    when:
+      event: tag
+    settings:
+      files:
+        - dist/slidcord*
+      api_key:
+        from_secret: CODEBERG_TOKEN
+      note: CHANGELOG

slidcord-0.3.1/.woodpecker/test.yaml

@@ -0,0 +1,35 @@
+# DO NOT EDIT
+# Generated from .copier-answers.yml
+
+when:
+  event: [push, pull_request]
+  path: [pyproject.toml, uv.lock, "**/*.py", ".woodpecker/test.yaml"]
+
+variables:
+  - &ci-image codeberg.org/${CI_REPO_OWNER}/slidcord:ci
+
+steps:
+  update-venv:
+    image: *ci-image
+    pull: true
+    commands:
+      - uv sync --all-groups --all-extras
+
+  ruff:
+    image: *ci-image
+    depends_on: update-venv
+    commands:
+      - ruff check
+      - ruff format --check
+
+  mypy:
+    image: *ci-image
+    depends_on: update-venv
+    commands:
+      - mypy
+
+  test:
+    image: *ci-image
+    depends_on: update-venv
+    commands:
+      - python -m pytest tests

slidcord-0.3.1/CONTRIBUTING.md

@@ -0,0 +1,100 @@
+# Contributing
+
+We are really happy to welcome new contributors to slidcord!
+Before starting anything, please join [our chat room](xmpp:slidge@conference.nicoco.fr?join)
+to say hi and see if anyone is already working on the bug you want to fix or
+the feature you want to implement.
+
+## Quickstart
+
+To start hacking on slidcord, you need to:
+
+1. Clone the repository: `git clone https://codeberg.org/slidge/slidcord`.
+2. Install the required dependencies. (see below)
+3. Spin up a development XMPP server for slidcord to connect to. (see below)
+
+### Easy mode: docker-compose
+
+The easiest way to achieve 2 and 3 at the same time is to use the provided
+`docker-compose.yml` file. Run ``docker compose up`` (or ``podman-compose up``)
+in the directory of the repository you just cloned. It will:
+
+- spin up a [prosody](https://prosody.im) instance configured for development;
+- launch slidcord in a dedicated container, with hot code reload.
+
+You will then be able to connect to that prosody using any XMPP client, using
+"test@localhost" as JID and "password" as password. We recommended
+[gajim](https://gajim.org) which lets you start a different profile than your
+main profile: `gajim -p slidge -c ~/.local/share/gajim-slidge`.
+
+To avoid having to accept self-signed certificates, you can add prosody's
+certificate to your local store. In debian, you can do that with:
+
+```bash
+# download the certificate
+curl https://codeberg.org/slidge/prosody-dev-container/raw/branch/main/localhost.crt | sudo tee /usr/local/share/ca-certificates/localhost.crt
+# set the right perms
+chmod 600 /usr/local/share/ca-certificates/localhost.crt
+# import it
+sudo update-ca-certificates
+```
+
+### Slightly harder mode: setting up a virtualenv
+
+In some situations, developing in containers is not optimal, for instance if
+you want to attach an interactive debugger to the slidcord process.
+
+slidcord defines its dependencies in a [PEP 517](https://peps.python.org/pep-0517/)-compliant
+`pyproject.toml` file. This means that you can use different tools to set up a
+virtualenv with the appropriate dependencies.
+
+We recommend using [uv](https://docs.astral.sh/uv/) which is fast and has some
+nice features. By running ``uv sync --frozen --all-groups --all-extras``, a
+standard virtualenv will be installed in `./.venv`. You can then activate it
+with `source .venv/bin/activate` and launch `slidcord --help`.
+
+NB: you will need to set up a local XMPP server. An easy way to do that is to
+use the `slidge-prosody-dev` container: `docker run --network host codeberg.org/slidge/prosody-slidge-dev`.
+With it you will be able to launch slidcord with
+``slidcord --jid slidge.localhost --secret secret --debug --home-dir ./persistent``.
+
+### Hacking on slidge core simultaneously
+
+Maybe you will discover that what you want to change, add or fix is not part
+of slidcord but part of slidge core. To modify slidge core, first you
+need to clone [the slidge repo](https://codeberg.org/slidge/slidge) somewhere
+on your computer.
+
+Let's assume you cloned `slidge` in the same root dir as `slidcord`,
+e.g., `~/src/slidcord` and `~/src/slidge`.
+With the `docker-compose`-based dev setup, you will need to add an additional
+mount for the slidge dir, e.g., `../slidge:/build/slidge`. If you opted for
+the virtualenv solution, you can install slidge in your virtualenv in editable
+mode with `[uv] pip install -e ../slidge`.
+
+## Guidelines
+
+slidcord uses these tools to ensure some level of code quality:
+
+- [mypy](https://www.mypy-lang.org/)
+  for static type checking,
+- [ruff](https://docs.astral.sh/ruff/)
+  to detect common python mistakes and enforce a consistent style,
+- [pytest](https://docs.pytest.org/en/stable/)
+  for automated tests.
+
+Commit messages should be in the form of
+[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), with
+some additional types defined in [./commitlinx.config.js](https://codeberg.org/slidge/slidcord/src/branch/main/commitlint.config.js).
+This makes it possible to automatically generate changelogs on releases, it
+is worth it! We use [git-cliff](https://git-cliff.org/) for this. You don't have
+to install git-cliff locally, the magic happens in CI.
+
+We recommended setting up [pre-commit](https://pre-commit.com/) to ensure that
+these pass for each commit: `pre-commit install && pre-commit install --hook-type commit-msg`.
+
+Make a new git branch, commit your changes, push it to your fork and open a
+pull request!
+
+NB: we also accept contributions without pull requests. Just push your changes
+somewhere and tell us where to pull via the group chat.

slidcord-0.3.1/Dockerfile

@@ -0,0 +1,92 @@
+ARG PYTHONVERSION=3.13
+ARG DEBIANVERSION=trixie
+
+# Builder
+# *******
+FROM ghcr.io/astral-sh/uv:python$PYTHONVERSION-$DEBIANVERSION-slim AS builder
+
+# install git for setuptools scm
+RUN apt-get update -y && \
+    apt-get install \
+        git \
+        make \
+        -y --no-install-recommends && \
+    rm -rf /var/lib/apt/lists/*
+WORKDIR /build
+ENV UV_PROJECT_ENVIRONMENT=/venv
+ENV PATH="/venv/bin:/root/.cargo/bin:$PATH"
+RUN uv venv $UV_PROJECT_ENVIRONMENT
+COPY pyproject.toml uv.lock  README.md .
+COPY slidcord slidcord
+ARG SLIDGE_USE_LOCKFILE=
+RUN [ -z "$SLIDGE_USE_LOCKFILE" ] && rm uv.lock || true
+# install dependencies in /venv
+# .git/ needs to be mounted for setuptools-scm to set the version
+RUN --mount=source=.git,target=/build/.git,type=bind \
+    uv sync --no-dev
+ARG SLIDGE_PRERELEASE
+RUN [ ! -z "$SLIDGE_PRERELEASE" ] && uv pip install slidge --upgrade --prerelease allow || true
+
+# CI container
+# ************
+FROM builder AS ci
+
+# We won't use this venv in CI, but this populates the uv cache in the container,
+# minimizing (or even nulling) downloads.
+RUN --mount=source=.git,target=/build/.git,type=bind \
+    uv sync --all-groups --no-install-project
+ENV UV_PROJECT_ENVIRONMENT="/woodpecker/src/codeberg.org/slidge/slidcord/.venv"
+ENV UV_LINK_MODE=copy
+ENV PATH="$UV_PROJECT_ENVIRONMENT/bin:$PATH"
+
+# Dev container
+# *************
+FROM builder AS dev
+
+# copy "localhost" certs from the prosody slidge dev container, so
+COPY --from=codeberg.org/slidge/prosody-slidge-dev:latest \
+  /etc/prosody/certs/localhost.crt \
+  /usr/local/share/ca-certificates/
+RUN update-ca-certificates
+RUN apt-get update -y \
+    && apt-get install -y --no-install-recommends \
+        libmagic1 \
+        media-types \
+        shared-mime-info \
+    && rm -rf /var/lib/apt/lists/*
+RUN uv pip install watchdog[watchmedo]
+COPY --from=ci /venv /venv
+ENTRYPOINT ["watchmedo", "auto-restart", \
+  "--pattern", "*.py", \
+  "--directory", "/build/slidcord", \
+  "--recursive", \
+  "slidcord", "--", \
+  "--jid", "slidge.localhost", \
+  "--secret", "secret", \
+  "--debug", \
+  "--upload-service", "upload.localhost", \
+  "--admins", "test@localhost", \
+  "--dev-mode"]
+
+# Prod container
+# **************
+FROM docker.io/python:$PYTHONVERSION-slim-$DEBIANVERSION AS slidcord
+ARG PYTHONVERSION
+ENV PYTHONUNBUFFERED=1
+ENV PATH="/venv/bin:$PATH"
+STOPSIGNAL SIGINT
+WORKDIR /var/lib/slidge
+# libmagic1: to guess mime type from files
+# media-types: to determine file name suffix based on file type
+RUN apt-get update -y \
+    && apt-get install -y --no-install-recommends \
+        libmagic1 \
+        media-types \
+        shared-mime-info \
+    && rm -rf /var/lib/apt/lists/*
+RUN addgroup --system --gid 10000 slidge
+RUN adduser --system --uid 10000 --ingroup slidge --home /var/lib/slidge slidge
+USER slidge
+COPY --from=builder /venv /venv
+COPY --from=builder /build/slidcord /venv/lib/python$PYTHONVERSION/site-packages/slidcord
+ENTRYPOINT ["slidcord"]