ownfoil 2.4.0__tar.gz

ownfoil-2.4.0/.devcontainer/devcontainer.json

@@ -0,0 +1,29 @@
+{
+    "name": "Ownfoil",
+    "image": "mcr.microsoft.com/devcontainers/base:bookworm",
+
+    // Install uv, Python and the virtualenv once, when the container is created.
+    "postCreateCommand": "bash .devcontainer/post-create.sh",
+
+    // Make the virtualenv the default interpreter for every process in the container.
+    "remoteEnv": {
+        "PATH": "${containerWorkspaceFolder}/.venv/bin:${containerEnv:PATH}"
+    },
+
+    // Ownfoil web UI
+    "forwardPorts": [8465],
+    "portsAttributes": {
+        "8465": {
+            "label": "Ownfoil",
+            "onAutoForward": "notify"
+        }
+    },
+
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "eamodio.gitlens"
+            ]
+        }
+    }
+}

ownfoil-2.4.0/.devcontainer/post-create.sh

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+# Prepare the development environment: uv, Python, virtualenv and dependencies.
+# Runs once when the dev container / Codespace is created.
+set -euo pipefail
+
+PYTHON_VERSION="3.14"
+REPO_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+VENV_DIR="${REPO_DIR}/.venv"
+
+# uv installs itself in ~/.local/bin
+export PATH="${HOME}/.local/bin:${PATH}"
+
+# 1. Install uv (the base image may already provide it)
+if ! command -v uv >/dev/null 2>&1; then
+    echo "Installing uv..."
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+fi
+uv --version
+
+# 2. Install the Python version used by the Ownfoil image (see Dockerfile)
+echo "Installing Python ${PYTHON_VERSION}..."
+uv python install "${PYTHON_VERSION}"
+
+# 3. Create the virtualenv
+echo "Creating virtualenv in ${VENV_DIR}..."
+uv venv --python "${PYTHON_VERSION}" --allow-existing "${VENV_DIR}"
+
+# 4. Install the application requirements, plus pytest to run the test suite
+echo "Installing requirements..."
+uv pip install --python "${VENV_DIR}/bin/python" --requirement "${REPO_DIR}/requirements.txt" pytest
+
+# 5. Activate the virtualenv in interactive shells
+for rc in "${HOME}/.bashrc" "${HOME}/.zshrc"; do
+    [ -f "${rc}" ] || continue
+    grep -qxF "source ${VENV_DIR}/bin/activate" "${rc}" || {
+        printf '\n# Activate the Ownfoil virtualenv\nsource %s/bin/activate\n' "${VENV_DIR}" >> "${rc}"
+    }
+done
+
+echo "Environment ready: $(${VENV_DIR}/bin/python --version)"
+
+# 6. Install the Claude Code CLI.
+if ! command -v claude >/dev/null 2>&1; then
+    echo "Installing Claude Code CLI..."
+    curl -fsSL https://claude.ai/install.sh | bash
+fi
+# Skip onboarding
+cat > ~/.claude.json << EOF
+{
+  "hasCompletedOnboarding": true,
+  "theme": "dark",
+  "projects": {
+    "${REPO_DIR}": {
+      "hasTrustDialogAccepted": true
+    }
+  }
+}
+EOF

ownfoil-2.4.0/.github/dependabot.yml

@@ -0,0 +1,31 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: "develop"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "type/build"
+
+  - package-ecosystem: "docker"
+    directory: "/"
+    target-branch: "develop"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "type/build"
+      
+  - package-ecosystem: "pip"
+    directory: "/"
+    target-branch: "develop"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "type/build"

ownfoil-2.4.0/.github/release.yml

@@ -0,0 +1,21 @@
+changelog:
+  categories:
+    - title: New Features
+      labels:
+        - 'type/feat'
+    - title: Fixes and Improvements
+      labels:
+        - 'type/fix'
+        - 'type/improv'
+    - title: Other Changes
+      labels:
+        - '*'
+      exclude:
+        labels:
+          - 'type/feat'
+          - 'type/fix'
+          - 'type/improv'
+          - 'type/build'
+    - title: Dependencies
+      labels:
+        - 'type/build'

ownfoil-2.4.0/.github/workflows/build_check.yml

@@ -0,0 +1,20 @@
+name: Validate Python package build
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  build:
+    name: uv build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Build package
+        run: uv build

ownfoil-2.4.0/.github/workflows/docker.yml

@@ -0,0 +1,68 @@
+name: Publish multi arch Docker image
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - '**'
+    tags:
+      - '*.*.*'
+
+jobs:
+  push_to_registry:
+    name: Push Docker image to Docker Hub
+    if: startsWith(github.ref, 'refs/tags/') || (!startsWith(github.ref, 'refs/heads/master') && !startsWith(github.ref, 'refs/heads/dependabot') && !startsWith(github.event.head_commit.message, 'ci') && !startsWith(github.event.head_commit.message, 'doc'))
+    runs-on: ubuntu-latest
+    steps:
+      # Get the repository's code
+      - name: Checkout
+        uses: actions/checkout@v7
+        # with:
+        #   submodules: recursive
+
+      # https://github.com/docker/setup-qemu-action
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v4
+
+      # https://github.com/docker/setup-buildx-action
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v4
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v4
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v6
+        with:
+          images: a1ex4/ownfoil
+          flavor: |
+            latest=auto
+          tags: |
+            type=ref,event=tag
+            type=raw,value=latest,enable=${{ startsWith(github.ref, 'refs/tags/') }}
+            type=ref,event=branch,enable=${{ github.ref != 'refs/heads/master' }}
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+
+      - name: Set platforms based on branch or tag
+        run: |
+          if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
+            echo "PLATFORMS=linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6" >> $GITHUB_ENV
+          else
+            echo "PLATFORMS=linux/amd64,linux/arm64" >> $GITHUB_ENV
+          fi
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v7
+        with:
+          context: .
+          platforms: ${{ env.PLATFORMS }}
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

ownfoil-2.4.0/.github/workflows/docker_pr.yml

@@ -0,0 +1,32 @@
+name: Build multi arch Docker image on PR
+
+on:
+  pull_request:
+
+jobs:
+  push_to_registry:
+    name: Build multi arch Docker image on PR
+    runs-on: ubuntu-latest
+    steps:
+      # Get the repository's code
+      - name: Checkout
+        uses: actions/checkout@v7
+        # with:
+        #   submodules: recursive
+
+      # https://github.com/docker/setup-qemu-action
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v4
+
+      # https://github.com/docker/setup-buildx-action
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v4
+
+      - name: Build Docker images
+        uses: docker/build-push-action@v7
+        with:
+          context: .
+          # platforms: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6
+          platforms: linux/amd64,linux/arm64
+          push: false

ownfoil-2.4.0/.github/workflows/pypi.yml

@@ -0,0 +1,27 @@
+name: Publish Python package to PyPI
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - '*.*.*'
+
+jobs:
+  build_and_publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

ownfoil-2.4.0/.github/workflows/region_titles.yml

@@ -0,0 +1,136 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Build titledb
+
+# Controls when the workflow will run
+on:
+  schedule:
+    - cron: '0 */4 * * *'
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+    inputs:
+      force:
+        description: 'Rebuild even if blawar/titledb has not moved'
+        type: boolean
+        default: false
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      actions: write
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # A no-op run must not conclude as a success: nightly.link serves the latest *successful*
+      # run's artifact to pre-release Ownfoil versions, so it has to keep pointing at a run that
+      # actually uploaded one. Cancelling leaves that resolution untouched.
+      - name: Skip when blawar/titledb has not moved
+        env:
+          GH_TOKEN: ${{ github.token }}
+          # This step runs before the checkout, so gh has no local repo to infer from
+          GH_REPO: ${{ github.repository }}
+        run: |
+          set -euo pipefail
+          remote=$(git ls-remote https://github.com/blawar/titledb.git HEAD | cut -f1)
+          published=$(curl -sfL "https://github.com/${{ github.repository }}/releases/download/titledb/latest" || true)
+          echo "upstream=${remote} published=${published:-<none>}"
+          echo "titledb_sha=${remote}" >> "$GITHUB_ENV"
+          if [ "$remote" = "$published" ] && [ "${{ inputs.force }}" != "true" ]; then
+            echo "titledb unchanged, cancelling this run"
+            gh run cancel "${{ github.run_id }}"
+            sleep 60
+          fi
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: '3.10'
+
+      # Runs a set of commands using the runners shell
+      - name: Setup folders
+        run: |
+          set -euo pipefail
+          sudo apt update && sudo apt install -y libcurl4-openssl-dev libssl-dev
+          git clone https://github.com/blawar/nut
+          cd nut
+          pip install -r requirements.txt
+          mkdir build_artefacts titledb
+          curl -fsSL --retry 3 "https://github.com/blawar/titledb/archive/${titledb_sha}.tar.gz" \
+            | tar -xz --strip-components=1 -C titledb \
+                  --exclude=ncas.json --exclude=cheats.json
+          echo "formatted_date=$(date +"%Y-%m-%d_%H%M%S")" >> $GITHUB_ENV
+          # Short hash inside the artefact: consumed by Ownfoil < 2.4 through nightly.link.
+          # Explicitly 7 chars, matching what --short gave on the old shallow clone.
+          touch "build_artefacts/latest_${titledb_sha:0:7}"
+          # Full hash outside the artefact: the release marker, and what the skip check compares.
+          # Both are now the sha the tarball was pinned to, so they agree by construction.
+          echo "$titledb_sha" > latest
+
+      - uses: jannekem/run-python-script-action@v1
+        name: Generate region titles
+        with:
+          script: |
+            import os, sys
+            import json
+
+            os.chdir('nut')
+            sys.path.append(os.getcwd())
+            import nut
+
+            with open('titledb/languages.json') as f:
+              languages = json.load(f)
+              languages = dict(sorted(languages.items()))
+            for region in languages.keys():
+              for language in languages[region]:
+                  print(region, language)
+                  nut.importRegion(region, language)
+                  os.rename('titledb/titles.json', f'build_artefacts/titles.{region}.{language}.json')
+
+            for f in [
+              'cnmts.json',
+              'languages.json',
+              'versions.json',
+              'versions.txt',
+            ]:
+              os.rename(f'titledb/{f}', f'build_artefacts/{f}')
+
+
+      # Must stay ahead of the compression step: pre-release versions read the uncompressed
+      # JSON straight out of this zip.
+      - uses: actions/upload-artifact@v7
+        with:
+          name: titledb
+          path: nut/build_artefacts/*
+          compression-level: 9
+
+      - name: Compress artefacts
+        run: zstd -12 -T0 --rm -q nut/build_artefacts/*.json nut/build_artefacts/versions.txt
+
+      - name: Publish to the titledb release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          set -euo pipefail
+          gh release view titledb >/dev/null 2>&1 || \
+            gh release create titledb --prerelease --latest=false --title 'titledb data' \
+              --notes 'Rolling titledb dataset consumed by Ownfoil. Assets are replaced in place; `latest` holds the blawar/titledb commit they were built from and is always written last.'
+          uploaded=false
+          for attempt in 1 2 3; do
+            if gh release upload titledb nut/build_artefacts/*.zst --clobber; then
+              uploaded=true
+              break
+            fi
+            echo "upload attempt ${attempt} failed, retrying"
+            sleep 30
+          done
+          # Guards the invariant below: never publish the marker over a half-uploaded dataset
+          [ "$uploaded" = true ]
+          # Written last, alone: a client that sees a new hash knows every asset is already in place
+          gh release upload titledb nut/latest --clobber

ownfoil-2.4.0/.github/workflows/stale.yml

@@ -0,0 +1,21 @@
+name: 'Close stale issues'
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '30 1 * * *'
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Close stale issues
+        uses: actions/stale@v11
+        with:
+          days-before-stale: 30
+          days-before-close: 7
+          stale-issue-label: 'status/stale'
+          stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.'
+          close-issue-message: 'Closing this issue due to inactivity. Feel free to reopen if necessary.'
+          any-of-labels: 'status/waiting-for-info'
+          operations-per-run: 200
+          debug-only: false

ownfoil-2.4.0/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Tests on ${{ matrix.os }}
+    if: ${{ !startsWith(github.event.head_commit.message, 'ci') && !startsWith(github.event.head_commit.message, 'doc') }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: '3.14'
+          enable-cache: true
+          cache-dependency-glob: requirements.txt
+
+      - name: Create virtualenv
+        run: uv venv
+
+      - name: Install dependencies
+        run: uv pip install --requirement requirements.txt pytest
+
+      - name: Run tests
+        run: uv run pytest tests -v
+        timeout-minutes: 20

ownfoil-2.4.0/.gitignore

@@ -0,0 +1,27 @@
+__pycache__
+config
+data
+
+# capture harness workdir: fixture db, settings and the pseudonym map
+tests/capture/.workdir
+
+# venv
+/bin
+/venv
+/include
+/lib
+/lib64
+/pyvenv.cfg
+/share
+/Scripts
+
+# pyenv
+.python-version
+
+# uv build/tool artifacts
+/dist
+ownfoil.bat
+uv.lock
+
+.claude
+CLAUDE.local.md

ownfoil-2.4.0/Dockerfile

@@ -0,0 +1,25 @@
+FROM python:3.14-alpine
+
+# Install platform-specific build dependencies
+ARG TARGETPLATFORM
+RUN apk update && apk add --no-cache bash sudo \
+    && if [ "$TARGETPLATFORM" = "linux/arm/v6" ] || [ "$TARGETPLATFORM" = "linux/arm/v7" ]; then \
+        apk add --no-cache build-base gcc musl-dev jpeg-dev zlib-dev libffi-dev cairo-dev pango-dev gdk-pixbuf-dev; \
+    fi
+
+COPY requirements.txt /tmp/
+RUN pip install --no-cache-dir --requirement /tmp/requirements.txt && rm /tmp/requirements.txt
+RUN if [ "$TARGETPLATFORM" = "linux/arm/v6" ] || [ "$TARGETPLATFORM" = "linux/arm/v7" ]; then \
+        apk del build-base gcc musl-dev jpeg-dev zlib-dev libffi-dev cairo-dev pango-dev gdk-pixbuf-dev; \
+    fi
+
+RUN mkdir /app
+COPY ./app /app
+COPY ./docker/run.sh /app/run.sh
+
+RUN mkdir -p /app/data
+
+WORKDIR /app
+
+ENTRYPOINT [ "/app/run.sh" ]
+