pum 0.9.14__tar.gz → 1.0.0__tar.gz

pum-1.0.0/.ci/setup_db.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+export PGUSER=postgres
+
+# determine the pg_service conf file location
+if [ -z "$PGSYSCONFDIR" ]; then
+    PGSERVICE_FILE="$HOME/.pg_service.conf"
+else
+    PGSERVICE_FILE="$PGSYSCONFDIR/pg_service.conf"
+fi
+
+pgsrv="pum_test"
+echo "Adding service ${pgsrv} to $PGSERVICE_FILE"
+printf "[${pgsrv}]\nhost=localhost\ndbname=${pgsrv}\nuser=postgres\npassword=postgres\n\n" >> "$PGSERVICE_FILE"
+
+psql -c "DROP DATABASE IF EXISTS ${pgsrv};" "service=${pgsrv} dbname=postgres"
+psql -c "CREATE DATABASE  ${pgsrv};" "service=${pgsrv} dbname=postgres"

pum-1.0.0/.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: "/requirements"
+    schedule:
+      interval: monthly
+      time: "04:00"
+      timezone: Europe/Paris
+
+  - package-ecosystem: pip
+    directory: "/docs"
+    schedule:
+      interval: monthly
+      time: "04:00"
+      timezone: Europe/Paris
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

pum-1.0.0/.github/workflows/deploy-to-pypi.yml

@@ -0,0 +1,41 @@
+name: 🚀 Deploying to pypi
+
+on:
+  push:
+    tags:
+      - "*"
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  build-python-wheel:
+    name: "🐍 Python Wheel"
+    uses: ./.github/workflows/wheel.yml
+    secrets: inherit
+
+  release-pypi:
+    name: "🐍 Release on PyPI"
+    runs-on: ubuntu-latest
+    needs: [build-python-wheel]
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/${{ github.event.repository.name }}
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - name: Retrieve artifact from Python build
+        uses: actions/download-artifact@v4
+        with:
+          name: python_wheel
+          path: dist/
+
+      - name: upload release asset
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh release upload --repo ${{ github.repository_owner }}/${{ github.event.repository.name }} ${{ github.ref_name }} "dist/${{ github.event.repository.name }}-${{ github.ref_name }}.tar.gz"
+
+      - name: Deploy to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pum-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,65 @@
+name: "📚 Documentation Builder"
+
+on:
+  push:
+    branches:
+        - main
+        - docs
+    paths:
+      - .github/workflows/docs.yml
+      - pum/**/*.py
+      - docs/**/*
+    tags:
+      - "*"
+
+  pull_request:
+    branches:
+        - main
+    paths:
+      - .github/workflows/docs.yml
+      - pum/**/*.py
+      - docs/**/*
+
+# Allow one concurrent deployment
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-docs:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Get source code
+      uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install -r requirements/base.txt
+        python -m pip install -r docs/requirements.txt
+
+    - name: Install pum
+      run: python -m pip install .
+
+    - name: Update CLI docs
+      run: ./docs/update_cli_docs.py
+
+    - name: Build documentation
+      run: mkdocs build -f docs/mkdocs.yml
+
+    - uses: actions/upload-artifact@v4
+      if: ${{ github.event_name == 'pull_request' }}
+      with:
+        name: docs
+        path: docs/site
+        if-no-files-found: error
+
+    - name: Deploy to GitHub Pages
+      if: contains(fromJSON('["push", "workflow_dispatch"]'), github.event_name)
+      working-directory: docs
+      run: mkdocs gh-deploy --force

pum-1.0.0/.github/workflows/tests.yml

@@ -0,0 +1,73 @@
+name: 🧪 Testing
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Testing (py${{ matrix.python }}-pg${{ matrix.postgres }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+        python:
+          - "3.10"
+        postgres: # dockerhub tags
+          - "13-3.5"
+
+    runs-on: ${{ matrix.os }}
+
+    env:
+      PGSYSCONFDIR: .
+
+    services:
+      postgres:
+        image: postgis/postgis:${{ matrix.postgres }}
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-tags: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -r requirements/base.txt
+          python -m pip install -r requirements/development.txt
+          python -m pip install git+https://github.com/opengisch/pirogue.git@v3#egg=pirogue
+
+      - name: Install pum
+        run: python -m pip install .
+
+      - name: Setup db
+        shell: bash
+        run: ./.ci/setup_db.sh
+
+      - name: Run base tests
+        run: nose2 -v
+
+      # - name: Run migrations tests
+      #   shell: bash
+      #   run: ./test/test_pum.sh

pum-1.0.0/.github/workflows/wheel.yml

@@ -0,0 +1,42 @@
+name: "🐍 Python Wheel"
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  build-wheel:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get source code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+          cache: "pip"
+          cache-dependency-path: "requirements/base.txt"
+
+      - name: Install project requirements
+        run: |
+          python -m pip install -U pip setuptools wheel
+          python -m pip install -U build
+
+      - name: Install project as a package
+        run: python -m pip install -e .
+
+      - name: Build a binary wheel and a source tarball
+        run: python -m  build .
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: python_wheel
+          path: dist/*
+          if-no-files-found: error

pum-1.0.0/.github/workflows/windows-tests.yml

@@ -0,0 +1,72 @@
+name: 🪟 Winows Testing
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: Testing Windows
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest]
+        pg_major: [13]
+
+    runs-on: ${{ matrix.os }}
+
+    env:
+      PGSYSCONFDIR: .
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      # Adapted from https://github.com/npgsql/npgsql/actions/runs/33087254/workflow#L28-L66
+      # alternatively we could use postgres-windows docker images (stellirin/postgres-windows:9.6)
+      - name: Start PostgreSQL ${{ matrix.pg_major }} (Windows)
+        if: startsWith(matrix.os, 'windows')
+        run: |
+          # Find EnterpriseDB version number
+          EDB_VERSION=$(\
+            curl -Ls 'http://sbp.enterprisedb.com/applications.xml' |
+            sed -n "\#<id>postgresql_${{ matrix.pg_major }}</id>#{n;p;n;p;}" |
+            sed -n "\#<platform>windows-x64</platform>#{n;p;}" |
+            sed -E 's#.*<version>([^<]+)</version>#\1#')
+          # Install PostgreSQL
+          echo "Installing PostgreSQL (version: ${EDB_VERSION})"
+          curl -o pgsql.zip -L https://get.enterprisedb.com/postgresql/postgresql-${EDB_VERSION}-windows-x64-binaries.zip
+          unzip pgsql.zip -x 'pgsql/include/**' 'pgsql/doc/**' 'pgsql/pgAdmin 4/**' 'pgsql/StackBuilder/**'
+          # Start PostgreSQL
+          pgsql/bin/initdb -D pgsql/PGDATA -E UTF8 -U postgres
+          pgsql/bin/pg_ctl -D pgsql/PGDATA -l logfile start
+        shell: bash
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -r requirements/base.txt
+          python -m pip install -r requirements/development.txt
+          python -m pip install git+https://github.com/opengisch/pirogue.git@v3#egg=pirogue
+
+      - name: Install pum
+        run: python -m pip install .
+
+      # see https://github.community/t5/GitHub-Actions/Append-PATH-on-Windows/m-p/42873/highlight/true#M5155
+      - name: Add psql/bin path
+        env:
+          ACTIONS_ALLOW_UNSECURE_COMMANDS: 'true'
+        run: echo "##[add-path].\pgsql\bin"
+
+      - name: Setup db
+        shell: bash
+        run: ./.ci/setup_db.sh
+
+      - name: Run base tests
+        run: nose2 -v
+
+      # - name: Run migrations tests
+      #   shell: bash
+      #   run: ./test/test_pum.sh

pum-1.0.0/.gitignore

@@ -0,0 +1,13 @@
+docs/site
+build/
+__pycache__/
+.idea
+.vscode
+*.egg-info
+*.py[cod]
+*$py.class
+*.pyc
+venv
+.python-version
+dist/
+.DS_Store

pum-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+fail_fast: false
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+        args: ["--maxkb=600"]
+      - id: check-case-conflict
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+
+  # Ruff: linter, import sorter, autoflake, pyupgrade replacement
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.8
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+          - --target-version=py310
+        types_or:
+          - python
+          - pyi
+      - id: ruff-format
+        args:
+          - --line-length=100
+          - --target-version=py310
+        types_or:
+          - python
+          - pyi
+
+ci:
+  autofix_prs: true
+  autoupdate_schedule: quarterly