sleamdge 0.0.0.dev0__tar.gz → 0.2.1__tar.gz

sleamdge-0.2.1/.copier-answers.yml

@@ -0,0 +1,45 @@
+# Do not edit manually!
+# Changes here will be overwritten by copier.
+# https://copier.readthedocs.io/
+_commit: 6fcd5f7
+_src_path: git+https://codeberg.org/slidge/legacy-module-template
+authors:
+-   email: nicoco@nicoco.fr
+    name: Nicolas Cedilnik
+ci_id: 14070
+container_build_files:
+- uv.lock
+- pyproject.toml
+container_build_native: false
+container_builder_deps:
+- git
+- make
+container_builder_deps_backports: []
+container_debian_version: bookworm
+container_dev_custom_hot_reload: ''
+container_dev_extra_lines: ''
+container_python_version: '3.11'
+container_requires_rustup: false
+container_runtime_deps: []
+custom_build_system: ''
+custom_readme_head: ''
+custom_readme_tail: ''
+dependencies:
+- steamio>=1.1,<2
+- slidge>=0.2.0a3,<0.3
+dev_dependencies: []
+intersphinx_mappings: []
+lint_excludes: []
+mypy_ignores: []
+native_builds: false
+pre_commit_custom_hooks: ''
+project_name: sleamdge
+requires_lottie: false
+silo:
+    lib:
+        name: steamio
+        url: https://steam-py.github.io/docs/latest/
+    name: Steam
+    url: https://steamcommunity.com/
+uv_sources: []
+wheels: false

{sleamdge-0.0.0.dev0 → sleamdge-0.2.1}/.pre-commit-config.yaml

@@ -1,3 +1,6 @@
+# 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

sleamdge-0.2.1/.woodpecker/autoupdate-deps.yaml

@@ -0,0 +1,14 @@
+# DO NOT EDIT
+# Generated from .copier-answers.yml
+
+when:
+  event: [cron, manual]
+  cron: lockfile
+
+steps:
+  refresh-deps:
+    image: codeberg.org/slidge/woodpecker-uv-update-lockfile:latest
+    pull: true
+    settings:
+      token:
+        from_secret: CODEBERG_TOKEN

sleamdge-0.2.1/.woodpecker/container.yaml

@@ -0,0 +1,67 @@
+# DO NOT EDIT
+# Generated from .copier-answers.yml
+
+when:
+  event: [push, tag]
+  path:
+    - "sleamdge/**"
+    - Dockerfile
+    - pyproject.toml
+    - uv.lock
+
+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}/sleamdge
+    username: ${CI_REPO_OWNER}
+    password:
+      from_secret: CODEBERG_TOKEN
+    registry: codeberg.org
+    target: sleamdge
+    # 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}/sleamdge:buildcache
+    platforms: linux/amd64,linux/arm64
+
+steps:
+  build-tag:
+    image: woodpeckerci/plugin-docker-buildx
+    when:
+      event: [tag]
+    settings:
+      <<: *settings
+      tags:
+        - latest
+        - ${CI_COMMIT_TAG}
+
+  build-branch:
+    when:
+      event: [push]
+    image: woodpeckerci/plugin-docker-buildx
+    settings:
+      <<: *settings
+      tags:
+        - ${CI_COMMIT_BRANCH}
+
+  build-ci:
+    when:
+      event: [push]
+      branch: ${CI_REPO_DEFAULT_BRANCH}
+    image: woodpeckerci/plugin-docker-buildx
+    settings:
+      <<: *settings
+      target: ci
+      tag: ci
+      cache_images:
+        - codeberg.org/${CI_REPO_OWNER}/sleamdge:buildcache-ci

sleamdge-0.2.1/.woodpecker/docs.yaml

@@ -0,0 +1,24 @@
+# DO NOT EDIT
+# Generated from .copier-answers.yml
+
+when:
+  event: [push, tag, pull_request]
+  path: ["sleamdge/**/*.py", "docs/**/*", "README.md"]
+
+steps:
+  build:
+    image: codeberg.org/${CI_REPO_OWNER}/sleamdge:ci
+    pull: true
+    commands:
+      - cp -r /venv .venv
+      - 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

{sleamdge-0.0.0.dev0 → sleamdge-0.2.1}/.woodpecker/package.yaml

@@ -1,33 +1,37 @@
+# DO NOT EDIT
+# Generated from .copier-answers.yml
+
 when:
-  event: [ push, tag, pull_request ]
-  path: [ "${CI_REPO_NAME}/**/*", "pyproject.toml", "uv.lock", "README.md" ]
+  event: [push, tag]
+  path: ["sleamdge/**/*", "pyproject.toml", "README.md"]
+  branch: main
 
 variables:
-  - &image codeberg.org/slidge/woodpecker-${CI_REPO_NAME}
-  - &only-main-tag
-    when:
-      branch: main
-      event: tag
+  - &ci-image codeberg.org/${CI_REPO_OWNER}/sleamdge:ci
 
-steps:
-  version:
-    image: codeberg.org/slidge/woodpecker-version
-    pull: true
+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: *image
+    image: *ci-image
+    pull: true
     commands:
       - uv build
 
   codeberg-pypi:
     when:
-      event: [ push, tag ]
+      event: [push, tag]
+    image: *ci-image
     depends_on: build
-    image: *image
     environment:
       CODEBERG_TOKEN:
         from_secret: CODEBERG_TOKEN
@@ -35,9 +39,10 @@ steps:
       - uv publish --index codeberg --token $CODEBERG_TOKEN
 
   pypi:
-    image: *image
+    image: *ci-image
     depends_on: build
-    <<: *only-main-tag
+    when:
+      event: tag
     environment:
       PYPI_TOKEN:
         from_secret: PYPI_TOKEN
@@ -46,11 +51,12 @@ steps:
 
   codeberg-release:
     image: woodpeckerci/plugin-release
-    depends_on: build
-    <<: *only-main-tag
+    depends_on: [changelog, build]
+    when:
+      event: tag
     settings:
       files:
-        - dist/${CI_REPO_NAME}*
+        - dist/sleamdge*
       api_key:
         from_secret: CODEBERG_TOKEN
       note: CHANGELOG

sleamdge-0.2.1/.woodpecker/test.yaml

@@ -0,0 +1,36 @@
+# DO NOT EDIT
+# Generated from .copier-answers.yml
+
+when:
+  event: [push, pull_request]
+  path: [pyproject.toml, uv.lock, "**/*.py"]
+
+variables:
+  - &ci-image codeberg.org/${CI_REPO_OWNER}/sleamdge:ci
+
+steps:
+  update-venv:
+    image: *ci-image
+    pull: true
+    commands:
+      - cp -r /venv .venv
+      - 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

sleamdge-0.2.1/Dockerfile

@@ -0,0 +1,93 @@
+# DO NOT EDIT
+# This file is automatically generated with copier using https://codeberg.org/slidge/legacy-module-template
+
+# Builder
+# *******
+FROM ghcr.io/astral-sh/uv:python3.11-bookworm-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"
+# By making the venv relocatable, we can copy it to /workspace/.venv in CI, and only update
+# dependencies that might be out-of-date. If uv.lock is not modified, then updating
+# the .venv is a no-op.
+# This allows us to not wait on the CI container build for the test workflows to run,
+# and also to run workflows for pull requests that modify the lockfile. In this,
+# situation, updating the CI container is not an option.
+RUN uv venv $UV_PROJECT_ENVIRONMENT --relocatable
+COPY uv.lock pyproject.toml README.md .
+COPY sleamdge sleamdge
+# 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
+
+# CI container
+# ************
+FROM builder AS ci
+
+# In CI we copy /venv to .venv, then update it for the whole workflow.
+RUN --mount=source=.git,target=/build/.git,type=bind \
+    uv sync --all-groups --no-install-project
+ENV UV_PROJECT_ENVIRONMENT=.venv
+ENV UV_LINK_MODE=copy
+ENV PATH="/woodpecker/src/codeberg.org/slidge/sleamdge/.venv/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/sleamdge", \
+  "--recursive", \
+  "sleamdge", "--", \
+  "--jid", "slidge.localhost", \
+  "--secret", "secret", \
+  "--debug", \
+  "--upload-service", "upload.localhost", \
+  "--admins", "test@localhost", \
+  "--dev-mode"]
+
+# Prod container
+# **************
+FROM docker.io/python:3.11-slim-bookworm AS sleamdge
+
+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/sleamdge /venv/lib/python3.11/site-packages/sleamdge
+ENTRYPOINT ["sleamdge"]

sleamdge-0.2.1/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: sleamdge
+Version: 0.2.1
+Summary: A Steam/XMPP gateway
+Author-email: Nicolas Cedilnik <nicoco@nicoco.fr>
+License-Expression: AGPL-3.0-or-later
+Project-URL: Homepage, https://codeberg.org/slidge/sleamdge
+Project-URL: Issues, https://codeberg.org/slidge/sleamdge/issues
+Project-URL: Repository, https://codeberg.org/slidge/sleamdge
+Project-URL: Chat room, https://slidge.im/xmpp-web/#/guest?join=slidge@conference.nicoco.fr
+Project-URL: Documentation, https://slidge.im/docs/sleamdge/main
+Project-URL: changelog, https://codeberg.org/slidge/sleamdge/releases
+Keywords: xmpp,gateway,bridge,instant messaging,chat,steam
+Classifier: Topic :: Internet :: XMPP
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: steamio<2,>=1.1
+Requires-Dist: slidge<0.3,>=0.2.0a3
+Dynamic: license-file
+
+# sleamdge
+
+A
+[feature-rich](https://slidge.im/docs/sleamdge/main/features.html)
+[Steam](https://steamcommunity.com/) to
+[XMPP](https://xmpp.org/) puppeteering
+[gateway](https://xmpp.org/extensions/xep-0100.html), based on
+[slidge](https://slidge.im) and
+[steamio](https://steam-py.github.io/docs/latest/).
+
+[![PyPI package version](https://badge.fury.io/py/sleamdge.svg)](https://pypi.org/project/sleamdge/)
+[![CI pipeline status](https://ci.codeberg.org/api/badges/14070/status.svg)](https://ci.codeberg.org/repos/14070)
+[![Chat](https://conference.nicoco.fr:5281/muc_badge/slidge@conference.nicoco.fr)](https://slidge.im/xmpp-web/#/guest?join=slidge@conference.nicoco.fr)
+
+
+## Installation
+
+Refer to the [slidge admin documentation](https://slidge.im/docs/slidge/main/admin/)
+for general info on how to set up an XMPP server component.
+
+### Containers
+
+From [the codeberg package registry](https://codeberg.org/slidge/-/packages/container/sleamdge/latest)
+
+```sh
+docker run codeberg.org/slidge/sleamdge  # works with podman too
+```
+
+Use the `:latest` tag for the latest release, `:vX.X.X` for release X.X.X, and `:main`
+for the bleeding edge.
+
+### Python package
+
+With [pipx](https://pypa.github.io/pipx/):
+
+```sh
+
+# for the latest stable release (if any)
+pipx install sleamdge
+
+# for the bleeding edge
+pipx install sleamdge \
+    --pip-args='--extra-index-url https://codeberg.org/api/packages/slidge/pypi/simple/'
+
+sleamdge --help
+```
+
+## Documentation
+
+Hosted on [codeberg pages](https://slidge.im/docs/sleamdge/main/).
+
+## Dev
+
+```sh
+git clone https://codeberg.org/slidge/sleamdge
+cd sleamdge
+docker-compose up  # works with podman-compose too
+```

{sleamdge-0.0.0.dev0 → sleamdge-0.2.1}/README.md

@@ -1,7 +1,7 @@
 # sleamdge
 
 A
-[feature-rich](https://slidge.im/sleamdge/features.html)
+[feature-rich](https://slidge.im/docs/sleamdge/main/features.html)
 [Steam](https://steamcommunity.com/) to
 [XMPP](https://xmpp.org/) puppeteering
 [gateway](https://xmpp.org/extensions/xep-0100.html), based on
@@ -9,8 +9,9 @@ A
 [steamio](https://steam-py.github.io/docs/latest/).
 
 [![PyPI package version](https://badge.fury.io/py/sleamdge.svg)](https://pypi.org/project/sleamdge/)
-[![CI pipeline status](https://ci.codeberg.org/api/badges/14068/status.svg)](https://ci.codeberg.org/repos/14068)
-[![Chat](https://conference.nicoco.fr:5281/muc_badge/slidge@conference.nicoco.fr)](https://slidge.im/xmpp-web/#/guest)
+[![CI pipeline status](https://ci.codeberg.org/api/badges/14070/status.svg)](https://ci.codeberg.org/repos/14070)
+[![Chat](https://conference.nicoco.fr:5281/muc_badge/slidge@conference.nicoco.fr)](https://slidge.im/xmpp-web/#/guest?join=slidge@conference.nicoco.fr)
+
 
 ## Installation
 
@@ -19,12 +20,15 @@ for general info on how to set up an XMPP server component.
 
 ### Containers
 
-From [the codeberg package registry](https://codeberg.org/slidge/-/packages?q=&type=container)
+From [the codeberg package registry](https://codeberg.org/slidge/-/packages/container/sleamdge/latest)
 
 ```sh
-docker run codeberg.org/slidge/sleamdge
+docker run codeberg.org/slidge/sleamdge  # works with podman too
 ```
 
+Use the `:latest` tag for the latest release, `:vX.X.X` for release X.X.X, and `:main`
+for the bleeding edge.
+
 ### Python package
 
 With [pipx](https://pypa.github.io/pipx/):
@@ -35,20 +39,20 @@ With [pipx](https://pypa.github.io/pipx/):
 pipx install sleamdge
 
 # for the bleeding edge
-pipx install sleamdge==0.0.0.dev0 \
+pipx install sleamdge \
     --pip-args='--extra-index-url https://codeberg.org/api/packages/slidge/pypi/simple/'
 
-# to update bleeding edge installs
-pipx install sleamdge==0.0.0.dev0 \
-    --pip-args='--extra-index-url https://codeberg.org/api/packages/slidge/pypi/simple/' --force
-
 sleamdge --help
 ```
 
+## Documentation
+
+Hosted on [codeberg pages](https://slidge.im/docs/sleamdge/main/).
+
 ## Dev
 
 ```sh
 git clone https://codeberg.org/slidge/sleamdge
 cd sleamdge
-docker-compose up
+docker-compose up  # works with podman-compose too
 ```

sleamdge-0.2.1/commitlint.config.js

@@ -0,0 +1,34 @@
+// DO NOT EDIT
+// Generated from .copier-answers.yml
+//
+// This files defines the allowed "headers" for the commit messages.
+// Following the rules makes the changelog generation easier.
+// They come from angular conventions, unless commented.
+const Configuration = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum':
+      [
+        2,
+        'always',
+        [
+          'build',
+          'chore',
+          'ci',
+          'docs',
+          'feat',
+          'fix',
+          'perf',
+          'refactor',
+          'revert',
+          'style',
+          'test',
+          'compat',  // workaround to play nice with non-compliant clients or servers; ideally reverted once fixed upstream
+          'cfix', // fixes an unreleased commit, should not appear in changelog
+          'imprv',  // improvement of an existing feature
+        ]
+      ],
+  },
+}
+
+module.exports = Configuration

{sleamdge-0.0.0.dev0 → sleamdge-0.2.1}/docker-compose.yml

@@ -1,4 +1,6 @@
-version: "3.9"
+# DO NOT EDIT
+# Generated from .copier-answers.yml
+
 services:
   slidge:
     build:
@@ -6,8 +8,8 @@ services:
       target: dev
     network_mode: service:prosody
     volumes:
-      - ./sleamdge:/venv/lib/python/site-packages/legacy_module
-      - ./persistent:/var/lib/slidge
+      - ./sleamdge:/build/sleamdge
+      - ./persistent:/var/lib/slidge/slidge.localhost
     depends_on:
       prosody:
         condition: service_started

{sleamdge-0.0.0.dev0 → sleamdge-0.2.1}/docs/source/conf.py

@@ -1,11 +1,17 @@
+# DO NOT EDIT
+# Generated from .copier-answers.yml
+
+import os
 from datetime import datetime
 from pathlib import Path
 
+from slidge.__version__ import __version__ as slidge_version
+
 project = "sleamdge"
-branch = "main"
-slidge_version = "main"
 copyright = f"{datetime.today().year}, the {project} contributors"
 author = f"the {project} contributors"
+branch = os.getenv("CI_COMMIT_BRANCH", "main")
+
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
@@ -26,12 +32,11 @@ autoapi_python_class_content = "both"
 
 autoapi_type = "python"
 autoapi_dirs = ["../../sleamdge"]
-autoapi_ignore = ["generated/*"]
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "slixmpp": ("https://slixmpp.readthedocs.io/en/latest/", None),
-    "slidge": (f"https://slidge.im/docs/slidge/{slidge_version}", None),
+    "slidge": (f"https://slidge.im/docs/slidge/{slidge_version}/", None),
 }
 
 extlinks = {"xep": ("https://xmpp.org/extensions/xep-%s.html", "XEP-%s")}

sleamdge-0.2.1/docs/source/config.rst

@@ -0,0 +1,41 @@
+Configuration
+=============
+
+Minimal setup
+-------------
+
+For a minimal ``prosody <https://prosody.im>`` based setup, add these lines at the bottom of
+``/etc/prosody/prosody.cfg.lua``:
+
+.. code-block:: lua
+
+  Component "sleamdge.example.org"
+      component_secret = "secret"
+
+And start sleamdge with:
+
+.. code-block:: bash
+
+  sleamdge \
+    --jid sleamdge.example.org \
+    --secret secret \
+    --home-dir /somewhere/writable
+
+Advanced usage
+--------------
+
+Refer to the `slidge admin docs <https://slidge.im/docs/slidge/main/admin>`_ for more
+advanced setups and examples of configuration for other XMPP servers.
+
+You will probably want to add support for `attachments <https://slidge.im/docs/slidge/main/admin/attachments.html>`_
+received from Steam, and setup sleamdge as a `privileged component <https://slidge.im/docs/slidge/main/admin/privilege.html>`_
+for better UX.
+
+sleamdge-specific config
+------------------------
+
+All `generic slidge configuration options <https://slidge.im/docs/slidge/main/admin/config/#common-config>`_
+apply.
+sleamdge provides these additional component-wide options:
+
+.. config-obj:: sleamdge.config

{sleamdge-0.0.0.dev0 → sleamdge-0.2.1}/docs/source/index.rst

@@ -2,7 +2,7 @@ sleamdge
 ========
 
 A
-`feature-rich <https://slidge.im/sleamdge/features.html>`_
+`feature-rich <https://slidge.im/docs/sleamdge/main/features.html>`_
 `Steam <https://steamcommunity.com/>`_ to
 `XMPP <https://xmpp.org/>`_ puppeteering
 `gateway <https://xmpp.org/extensions/xep-0100.html>`_, based on