Merge pull request #338 from Kattis/develop

Merge `develop` into `master`

Author: gkreitz

.github/workflows/pypi.yml

@@ -0,0 +1,88 @@
+name: Publish python distribution to PyPI and TestPyPI
+
+on:
+  workflow_dispatch:
+    inputs:
+      pushTestPyPi:
+        description: 'Push package to TestPyPi'
+        required: true
+        type: boolean
+      pushPyPi:
+        description: 'Push package to PyPi'
+        required: true
+        type: boolean
+
+jobs:
+  build-pypi:
+    runs-on: ubuntu-latest
+    container:
+      image: quay.io/pypa/manylinux_2_28_x86_64
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # We need full history for setuptools_scm to figure out version
+    - name: Set safe directory (work around checkout not doing that properly for containers)
+      run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+    - name: Install build dependencies for checktestdata
+      run: yum -y install boost-devel gmp-devel
+    - name: Build sdist (and broken wheel)
+      run: /opt/python/cp311-cp311/bin/python -m build
+    - name: Repair wheel
+      run: auditwheel repair dist/problemtools-*.whl
+    - name: Replace broken wheel with repaired wheel
+      run: |
+        rm -f dist/*.whl
+        cp wheelhouse/*.whl dist
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-testpypi:
+    name: Publish Python distribution to TestPyPI
+    needs:
+    - build-pypi
+    runs-on: ubuntu-latest
+    if: ${{ inputs.pushTestPyPi }}
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/problemtools
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+
+  publish-to-pypi:
+    name: Publish Python distribution to PyPI
+    needs:
+    - build-pypi
+    runs-on: ubuntu-latest
+    if: ${{ inputs.pushPyPi }}
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/problemtools
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/python-app.yml

@@ -0,0 +1,62 @@
+# This workflow will install Python dependencies, run tests and lint
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python tests
+
+on:
+  push:
+    branches: [ "master", "develop" ]
+  pull_request:
+    branches: [ "master", "develop" ]
+
+permissions:
+  contents: read
+
+jobs:
+  pythontests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"] # 3.11 is the lowest we support, since we want StrEnum
+    container:
+      image: problemtools/githubci:latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m venv venv
+        venv/bin/python --version
+        venv/bin/pip install mypy ruff pytest
+        if [ -f requirements.txt ]; then venv/bin/pip install -r requirements.txt; fi
+    - name: Lint with ruff
+      run: venv/bin/ruff check --output-format=github
+    - name: Check ruff formatting
+      run: venv/bin/ruff format --check --diff
+    - name: Test with pytest
+      run:  venv/bin/pytest
+    - name: Run mypy
+      run: |
+        venv/bin/mypy --non-interactive --config-file mypy.ini -p problemtools
+
+  packages: # Use a separate job to test debian packaging to speed things up (no need to test this for every python version above)
+    runs-on: ubuntu-latest
+    container:
+      image: problemtools/githubci:latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: true
+    - name: Build debian packages
+      run:  |
+        make builddeb
+    - name: Install debian package
+      run:  dpkg -i ../kattis-problemtools_*.deb
+    - name: Verify examples
+      run: |
+        shopt -s extglob
+        verifyproblem examples/!(README.md)
+      shell: bash

.gitignore

@@ -1,6 +1,13 @@
 *.pyc
 *~
+*.swp
 /.cache/
 /problemtools.egg-info/
 /support/default_validator/default_validator
 /support/interactive/interactive
+build/
+/problemtools/_version.py
+
+venv/
+.pytest_cache/
+.mypy_cache/

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.11.8
+  hooks:
+    - id: ruff
+    - id: ruff-format

.travis.yml

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2010-2019 Kattis and all respective contributors
+Copyright (c) Kattis and all respective contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Dockerfile

@@ -1,4 +1,9 @@
 recursive-include problemtools/config *
 recursive-include problemtools/templates *
 recursive-include problemtools/tests *
+recursive-include examples *
 recursive-include support *
+recursive-include tests *
+global-exclude */__pycache__/*
+global-exclude *.pyc
+recursive-exclude .github *

LICENSE

@@ -8,3 +8,7 @@ checktestdata: support/checktestdata/bootstrap
 
 support/checktestdata/bootstrap:
 	git submodule update --init
+
+clean:
+	make -C support clean
+	rm -rf problemtools.egg-info build