slidge 0.2.1__tar.gz → 0.2.3.post1__tar.gz

slidge-0.2.3.post1/.gitignore

@@ -0,0 +1,44 @@
+__pycache__
+*.__pycache__
+*.pyc
+dist/
+.pytest_cache
+*.bak
+.vscode
+docs/build
+persistent/
+.idea
+.mypy_cache
+.old
+requirements*
+slidge/plugins/whatsapp/generated
+dev/confs/slidge-tg.ini
+.ruff_cache
+
+/debian/.debhelper/generated
+/debian/.debhelper/slidge
+/debian/.debhelper/slidge/dbgsym-build-ids
+/debian/etc/discord.conf.example
+/debian/etc/facebook.conf.example
+/debian/etc/hackernews.conf.example
+/debian/etc/mattermost.conf.example
+/debian/etc/signal.conf.example
+/debian/etc/skype.conf.example
+/debian/etc/steam.conf.example
+/debian/etc/telegram.conf.example
+/debian/etc/whatsapp.conf.example
+/debian/slidge
+/debian/changelog
+/debian/debhelper-build-stamp
+/debian/files
+/debian/slidge.postinst.debhelper
+/debian/slidge.prerm.debhelper
+/debian/slidge.substvars
+/build/
+/docs/source/dev/api/slidge/
+*.egg-info
+.coverage
+htmlcov
+/dev/slidge.sqlite
+
+.python-version

slidge-0.2.3.post1/.pre-commit-config.yaml

@@ -0,0 +1,47 @@
+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
+    # uv version.
+    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: prettify-xml
+        name: Prettify XML in test strings
+        entry: .venv/bin/python dev/prettify_tests.py
+        language: system
+        pass_filenames: true
+        always_run: true
+        files: tests.*\.py

slidge-0.2.3.post1/.woodpecker/container-cache.yml

@@ -0,0 +1,71 @@
+# Generate build caches for containers used by the legacy modules and the CI images
+
+# We cannot do it directly in the container workflow, because buildx does not "magically"
+# merge multi-arch build caches, cf https://github.com/docker/buildx/discussions/1382#discussioncomment-4159926
+
+when:
+  event: [ manual, cron ]
+
+variables:
+  - &settings
+    username: slidge
+    registry: codeberg.org
+    password:
+      from_secret: CODEBERG_TOKEN
+    dry_run: true
+  - &when
+    when:
+      branch: main
+      path:
+        - Dockerfile
+        - pyproject.toml
+        - uv.lock
+
+matrix:
+  PLATFORM:
+    - arm64
+    - amd64
+
+steps:
+  builder-base:
+    image: woodpeckerci/plugin-docker-buildx
+    <<: *when
+    settings:
+      platforms: linux/${PLATFORM}
+      target: builder-base
+      cache_images:
+        - codeberg.org/slidge/slidge-builder:buildcache-base-${PLATFORM}
+      <<: *settings
+
+  builder:
+    image: woodpeckerci/plugin-docker-buildx
+    <<: *when
+    settings:
+      platforms: linux/${PLATFORM}
+      target: builder
+      cache_from: codeberg.org/slidge/slidge-builder:buildcache-base-${PLATFORM}
+      cache_images:
+        - codeberg.org/slidge/slidge-builder:buildcache-${PLATFORM}
+      <<: *settings
+
+  base:
+    image: woodpeckerci/plugin-docker-buildx
+    <<: *when
+    settings:
+      platforms: linux/${PLATFORM}
+      target: base
+      cache_from: codeberg.org/slidge/slidge-builder:buildcache-${PLATFORM}
+      cache_images:
+        - codeberg.org/slidge/slidge-base:buildcache-${PLATFORM}
+      <<: *settings
+
+  dev:
+    image: woodpeckerci/plugin-docker-buildx
+    <<: *when
+    settings:
+      platforms: linux/${PLATFORM}
+      target: dev
+      cache_from: codeberg.org/slidge/slidge-base:buildcache-${PLATFORM}
+      cache_images:
+        - codeberg.org/slidge/slidge-dev:buildcache-${PLATFORM}
+      <<: *settings

slidge-0.2.3.post1/.woodpecker/container-ci.yaml

@@ -0,0 +1,29 @@
+# Build a container with a virtualenv that can be used for tests and to build docs.
+
+when:
+  event: [ manual, cron ]
+
+depends_on: [ container-cache ]
+
+matrix:
+  PYTHON_VERSION:
+    - "3.11"
+    - "3.12"
+    - "3.13"
+
+steps:
+  build-and-push:
+    image: woodpeckerci/plugin-docker-buildx
+    settings:
+      repo: codeberg.org/${CI_REPO_OWNER}/woodpecker-${CI_REPO_NAME}
+      registry: codeberg.org
+      build_args:
+        PYTHONVER: "${PYTHON_VERSION}"
+      tag: ${PYTHON_VERSION}
+      target: woodpecker-${CI_REPO_NAME}
+      username: slidge
+      password:
+        from_secret: CODEBERG_TOKEN
+      cache_from: codeberg.org/slidge/slidge-builder:buildcache-base-amd64
+      cache_images:
+        - codeberg.org/slidge/woodpecker-slidge:buildcache-${PYTHON_VERSION}

slidge-0.2.3.post1/.woodpecker/container.yml

@@ -0,0 +1,49 @@
+# Build the containers used as bases by the legacy modules
+
+variables:
+  - &platforms linux/arm64/v8,linux/amd64
+  - settings: &settings
+      platforms: *platforms
+      cache_from: codeberg.org/slidge/slidge-${TARGET}:buildcache-arm64
+      # TODO: also pull cache from :buildcache-amd64
+      # cf https://codeberg.org/woodpecker-plugins/docker-buildx/pulls/212
+
+depends_on: [ container-cache ]
+
+when:
+  event: [ cron, manual ]
+  branch: main
+  path: [ Dockerfile, uv.lock, "slidge/**/*" ]
+
+matrix:
+  TARGET:
+    - builder
+    - base
+    - dev
+
+steps:
+  version:
+    image: codeberg.org/slidge/woodpecker-version
+
+  build-and-push:
+    image: woodpeckerci/plugin-docker-buildx
+    pull: true
+    settings:
+      repo: codeberg.org/slidge/slidge-${TARGET}
+      registry: codeberg.org
+      auto_tag: true
+      target: ${TARGET}
+      username: slidge
+      password:
+        from_secret: CODEBERG_TOKEN
+      <<: *settings
+    when:
+      event: [ push, tag ]
+
+  build:
+    image: woodpeckerci/plugin-docker-buildx
+    settings:
+      dry-run: true
+      <<: *settings
+    when:
+      event: pull_request

slidge-0.2.3.post1/.woodpecker/docs.yaml

@@ -0,0 +1,24 @@
+when:
+  event: [ push, tag, pull_request ]
+  path: [ "slidge/**/*.py", "superduper/**/*.py", "docs/**/*" ]
+
+steps:
+  build:
+    image: codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:3.13
+    pull: true
+    commands:
+      # the first 2 commands update the virtualenv, which is a no-op unless uv.lock has been modified
+      - uv export > req.txt
+      - uv pip install --requirements req.txt
+      - uv pip install .
+      - cd docs
+      - make html
+
+  publish:
+    image: codeberg.org/slidge/woodpecker-publish-pages
+    pull: true
+    when:
+      event: [ push, tag ]
+    settings:
+      token:
+        from_secret: CODEBERG_TOKEN

slidge-0.2.3.post1/.woodpecker/package.yaml

@@ -0,0 +1,51 @@
+# Build a source dist and a wheel.
+
+when:
+  event: [ push, tag, pull_request ]
+  path: [ "slidge/**/*", "pyproject.toml", "uv.lock", "README.md" ]
+
+# We do not need to build several packages for several python versions
+# since slidge is pure python.
+variables:
+  - &image codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:3.13
+
+steps:
+  version:
+    image: codeberg.org/slidge/woodpecker-version
+
+  build:
+    image: *image
+    commands:
+      - uv build
+
+  codeberg-pypi:
+    when:
+      event: [ push, tag ]
+    image: *image
+    environment:
+      CODEBERG_TOKEN:
+        from_secret: CODEBERG_TOKEN
+    commands:
+      - uv publish --index codeberg --token $CODEBERG_TOKEN
+
+  pypi:
+    when:
+      branch: main
+      event: tag
+    image: *image
+    environment:
+      PYPI_TOKEN:
+        from_secret: PYPI_TOKEN
+    commands:
+      - uv publish --token $PYPI_TOKEN
+
+  codeberg-release:
+    when:
+      branch: main
+      event: tag
+    image: woodpeckerci/plugin-release
+    settings:
+      files:
+        - dist/slidge*
+      api_key:
+        from_secret: CODEBERG_TOKEN

slidge-0.2.3.post1/.woodpecker/test.yaml

@@ -0,0 +1,64 @@
+when:
+  event: [ push, pull_request ]
+  path: [ pyproject.toml, uv.lock, "slidge/**/*.py", "tests/**/*.py" ]
+
+matrix:
+  PYTHON_VERSION:
+    - "3.11"
+    - "3.12"
+    - "3.13"
+
+variables:
+  - &only-once
+    when:
+      matrix:
+        PYTHON_VERSION: "3.11"
+      event: push
+
+steps:
+  # This is often a no-op, but since we manually build the woodpecker-slidge:3.x images,
+  # their venv may be out of date, even if uv.lock is not modified.
+  update-venv:
+    image: codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:${PYTHON_VERSION}
+    pull: true
+    commands:
+      - cp -r /venv .venv
+      - uv venv --allow-existing .venv
+      - uv export > req.txt
+      - uv pip install --requirements req.txt
+
+  ruff:
+    image: codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:${PYTHON_VERSION}
+    commands:
+      - ruff check
+      - ruff format
+
+  mypy:
+    image: codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:${PYTHON_VERSION}
+    commands:
+      - mypy
+
+  test:
+    image: codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:${PYTHON_VERSION}
+    commands:
+      - coverage run -m pytest tests
+      - coverage report | tee coverage.txt
+      - coverage html
+
+  badge:
+    image: codeberg.org/slidge/woodpecker-${CI_REPO_NAME}:${PYTHON_VERSION}
+    commands:
+      - uv pip install pybadges
+      - COVERAGE=$(tail -n1 coverage.txt | awk 'NF>1{print $NF}')
+      - python -m pybadges --left-text=coverage --right-text=$COVERAGE --right-color=green > htmlcov/coverage.svg || true
+    <<: *only-once
+
+  publish:
+    image: codeberg.org/slidge/woodpecker-publish-pages
+    pull: true
+    settings:
+      token:
+        from_secret: CODEBERG_TOKEN
+      html-root: htmlcov
+      root: coverage
+    <<: *only-once

slidge-0.2.3.post1/Dockerfile

@@ -0,0 +1,94 @@
+ARG PYTHONVER=3.11
+ARG DISTRO=bookworm
+## Base build stage for Slidge, prepares and installs common dependencies.
+FROM ghcr.io/astral-sh/uv:python$PYTHONVER-$DISTRO AS builder-base
+ARG PYTHONVER
+ENV PATH="/venv/bin:$PATH"
+
+# rust/cargo is for building "cryptography" since they don't provide wheels for arm32
+RUN apt-get update -y && apt-get install -y --no-install-recommends \
+    build-essential \
+    ca-certificates \
+    cargo \
+    curl \
+    git \
+    gcc \
+    g++ \
+    libffi-dev \
+    libssl-dev \
+    pkg-config \
+    python3-dev \
+    rustc
+
+RUN uv venv /venv
+WORKDIR /build
+# Only copy files used to define dependencies, so this step can be in cache
+# as long as we don't touch the deps.
+COPY uv.lock pyproject.toml /build/
+
+FROM builder-base AS builder
+RUN uv export --no-dev > requirements.txt
+RUN uv pip install --requirement requirements.txt
+RUN ln -s /venv/lib/python$PYTHONVER /venv/lib/python
+
+# CI environment for slidge
+FROM builder-base AS woodpecker-slidge
+# In CI we sometimes move /venv to .venv, then update it for the whole workflow.
+ENV PATH=".venv/bin:$PATH"
+RUN uv export > requirements.txt
+RUN uv pip install --requirement requirements.txt
+
+## Minimal runtime environment for slidge
+# We re-use this for plugins that need extra dependencies, but copy the ./slidge
+# dir as the last step to be docker cache-friendly
+FROM docker.io/library/python:$PYTHONVER-slim AS base
+ARG PYTHONVER
+ENV PATH="/venv/bin:$PATH"
+ENV PYTHONUNBUFFERED=1
+
+# 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 python3-slixmpp-lib
+
+RUN addgroup --system --gid 10000 slidge
+RUN adduser --system --uid 10000 --ingroup slidge --home /var/lib/slidge slidge
+
+ENV SLIDGE_LEGACY_MODULE=legacy_module
+
+WORKDIR /var/lib/slidge
+COPY --from=builder /venv /venv
+# hacky, link compiled (fast) stringprep.so to the proper dir
+RUN ln -s /usr/lib/python3/dist-packages/slixmpp/stringprep*.so /venv/lib/python$PYTHONVER/site-packages/slixmpp/
+
+STOPSIGNAL SIGINT
+USER slidge
+
+ENTRYPOINT ["python", "-m", "slidge"]
+
+# dev container with hot reload on code change
+FROM base AS dev
+
+USER root
+
+COPY --from=docker.io/nicocool84/slidge-prosody-dev:latest \
+  /etc/prosody/certs/localhost.crt \
+  /usr/local/share/ca-certificates/
+RUN update-ca-certificates
+
+RUN pip install watchdog[watchmedo]
+
+COPY --from=builder /venv /venv
+COPY ./slidge /venv/lib/python/site-packages/slidge
+
+ENTRYPOINT ["watchmedo", "auto-restart", \
+  "--pattern", "*.py", \
+  "--directory", "/venv/lib/python/site-packages/legacy_module/", \
+  "--recursive", \
+  "python", "--", "-m", "slidge", \
+  "--jid", "slidge.localhost", \
+  "--secret", "secret", \
+  "--debug", \
+  "--upload-service", "upload.localhost", \
+  "--admins", "test@localhost", \
+  "--dev-mode"]