pum 1.1.14__tar.gz → 1.1.15__tar.gz

{pum-1.1.14/pum.egg-info → pum-1.1.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pum
-Version: 1.1.14
+Version: 1.1.15
 Summary: Pum stands for "Postgres Upgrades Manager". It is a Database migration management tool very similar to flyway-db or Liquibase, based on metadata tables.
 Author-email: Denis Rouzaud <denis@opengis.ch>
 License-Expression: GPL-2.0-or-later

{pum-1.1.14 → pum-1.1.15/pum.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pum
-Version: 1.1.14
+Version: 1.1.15
 Summary: Pum stands for "Postgres Upgrades Manager". It is a Database migration management tool very similar to flyway-db or Liquibase, based on metadata tables.
 Author-email: Denis Rouzaud <denis@opengis.ch>
 License-Expression: GPL-2.0-or-later

pum-1.1.15/pum.egg-info/SOURCES.txt

@@ -0,0 +1,33 @@
+LICENSE
+README.md
+pyproject.toml
+pum/__init__.py
+pum/changelog.py
+pum/checker.py
+pum/cli.py
+pum/config_model.py
+pum/dependency_handler.py
+pum/dumper.py
+pum/exceptions.py
+pum/hook.py
+pum/info.py
+pum/parameter.py
+pum/pum_config.py
+pum/role_manager.py
+pum/schema_migrations.py
+pum/sql_content.py
+pum/upgrader.py
+pum.egg-info/PKG-INFO
+pum.egg-info/SOURCES.txt
+pum.egg-info/dependency_links.txt
+pum.egg-info/entry_points.txt
+pum.egg-info/requires.txt
+pum.egg-info/top_level.txt
+requirements/base.txt
+requirements/development.txt
+test/test_changelog.py
+test/test_config.py
+test/test_dumper.py
+test/test_roles.py
+test/test_schema_migrations.py
+test/test_upgrader.py

{pum-1.1.14 → pum-1.1.15}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=61.0", "setuptools-scm", "wheel", "setuptools-git-versioning"]
+requires = ["setuptools>=61.0", "wheel", "setuptools-git-versioning"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -38,7 +38,7 @@ packages = ["pum"]
 
 [tool.setuptools-git-versioning]
 enabled = true
-starting_version = "1.2.3"
+starting_version = "0.0.0"
 
 [tool.setuptools.dynamic]
 readme = {file = ["README.md"], content-type = "text/markdown"}

pum-1.1.14/.ci/setup_db.sh

@@ -1,17 +0,0 @@
-#!/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.1.14/.github/dependabot.yml

@@ -1,20 +0,0 @@
-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.1.14/.github/workflows/deploy-to-pypi.yml

@@ -1,41 +0,0 @@
-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@v6
-        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.1.14/.github/workflows/docs.yml

@@ -1,65 +0,0 @@
-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@v5
-
-    - uses: actions/setup-python@v6
-      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@v5
-      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.1.14/.github/workflows/tests.yml

@@ -1,72 +0,0 @@
-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@v5
-        with:
-          fetch-tags: true
-
-      - name: Set up Python
-        uses: actions/setup-python@v6
-        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
-
-      - 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.1.14/.github/workflows/wheel.yml

@@ -1,42 +0,0 @@
-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@v5
-
-      - name: Set up Python
-        uses: actions/setup-python@v6
-        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@v5
-        with:
-          name: python_wheel
-          path: dist/*
-          if-no-files-found: error

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

@@ -1,71 +0,0 @@
-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@v5
-
-      - name: Set up Python
-        uses: actions/setup-python@v6
-        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
-
-      - 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.1.14/.gitignore

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

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

@@ -1,39 +0,0 @@
-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

pum-1.1.14/docs/docs/api/changelog.md

@@ -1 +0,0 @@
-::: pum.Changelog

pum-1.1.14/docs/docs/api/dump_format.md

@@ -1 +0,0 @@
-::: pum.DumpFormat

pum-1.1.14/docs/docs/api/dumper.md

@@ -1 +0,0 @@
-::: pum.Dumper

pum-1.1.14/docs/docs/api/exceptions.md

@@ -1,2 +0,0 @@
-
-::: pum.exceptions

pum-1.1.14/docs/docs/api/hook_base.md

@@ -1,2 +0,0 @@
-
-::: pum.HookBase

pum-1.1.14/docs/docs/api/hook_handler.md

@@ -1,2 +0,0 @@
-
-::: pum.HookHandler

pum-1.1.14/docs/docs/api/parameter_definition.md

@@ -1 +0,0 @@
-::: pum.ParameterDefinition

pum-1.1.14/docs/docs/api/parameter_type.md

@@ -1 +0,0 @@
-::: pum.ParameterType

pum-1.1.14/docs/docs/api/permission.md

@@ -1 +0,0 @@
-::: pum.Permission

pum-1.1.14/docs/docs/api/permission_type.md

@@ -1 +0,0 @@
-::: pum.PermissionType

pum-1.1.14/docs/docs/api/pum_config.md

@@ -1 +0,0 @@
-::: pum.PumConfig

pum-1.1.14/docs/docs/api/role.md

@@ -1 +0,0 @@
-::: pum.Role

pum-1.1.14/docs/docs/api/role_manager.md

@@ -1 +0,0 @@
-::: pum.RoleManager

pum-1.1.14/docs/docs/api/schema_migrations.md

@@ -1 +0,0 @@
-::: pum.SchemaMigrations

pum-1.1.14/docs/docs/api/sql_content.md

@@ -1,2 +0,0 @@
-
-::: pum.SqlContent

pum-1.1.14/docs/docs/api/upgrader.md

@@ -1 +0,0 @@
-::: pum.Upgrader

pum-1.1.14/docs/docs/cli/baseline.md

@@ -1,6 +0,0 @@
-usage: create_cli_help.py baseline [-h] -b BASELINE
-
-### options:
-- `-h, --help`: show this help message and exit
-- `-b BASELINE, --baseline BASELINE`
-- `Set baseline in the format x.x.x`

pum-1.1.14/docs/docs/cli/check.md

@@ -1,14 +0,0 @@
-usage: create_cli_help.py check [-h]
-- `[-i {tables,columns,constraints,views,sequences,indexes,triggers,functions,rules} [{tables,columns,constraints,views,sequences,indexes,triggers,functions,rules} ...]]`
-- `[-N EXCLUDE_SCHEMA] [-P EXCLUDE_FIELD_PATTERN] [-o OUTPUT_FILE]`
-
-### options:
-- `-h, --help`: show this help message and exit
-- `-i {tables,columns,constraints,views,sequences,indexes,triggers,functions,rules} [{tables,columns,constraints,views,sequences,indexes,triggers,functions,rules} ...], --ignore {tables,columns,constraints,views,sequences,indexes,triggers,functions,rules} [{tables,columns,constraints,views,sequences,indexes,triggers,functions,rules} ...]`
-- `Elements to be ignored`
-- `-N EXCLUDE_SCHEMA, --exclude-schema EXCLUDE_SCHEMA`
-- `Schema to be ignored.`
-- `-P EXCLUDE_FIELD_PATTERN, --exclude-field-pattern EXCLUDE_FIELD_PATTERN`
-- `Fields to be ignored based on a pattern compatible with SQL LIKE.`
-- `-o OUTPUT_FILE, --output_file OUTPUT_FILE`
-- `Output file`

pum-1.1.14/docs/docs/cli/dump.md

@@ -1,11 +0,0 @@
-usage: create_cli_help.py dump [-h] [-f {DumpFormat.CUSTOM,DumpFormat.PLAIN}] [-N EXCLUDE_SCHEMA] file
-
-### positional arguments:
-- `file`: The backup file
-
-### options:
-- `-h, --help`: show this help message and exit
-- `-f {DumpFormat.CUSTOM,DumpFormat.PLAIN}, --format {DumpFormat.CUSTOM,DumpFormat.PLAIN}`
-- `Dump format. Choices: ['custom', 'plain']. Default: plain.`
-- `-N EXCLUDE_SCHEMA, --exclude-schema EXCLUDE_SCHEMA`
-- `Schema to be ignored.`

pum-1.1.14/docs/docs/cli/info.md

@@ -1,4 +0,0 @@
-usage: create_cli_help.py info [-h]
-
-### options:
-- `-h, --help`: show this help message and exit

pum-1.1.14/docs/docs/cli/install.md

@@ -1,10 +0,0 @@
-usage: create_cli_help.py install [-h] [-p PARAMETER PARAMETER] [--max-version MAX_VERSION] [-r] [-g]
-
-### options:
-- `-h, --help`: show this help message and exit
-- `-p PARAMETER PARAMETER, --parameter PARAMETER PARAMETER`
-- `Assign variable for running SQL deltas. Format is name value.`
-- `--max-version MAX_VERSION`
-- `maximum version to install`
-- `-r, --roles`: Create roles
-- `-g, --grant`: Grant permissions to roles

pum-1.1.14/docs/docs/cli/restore.md

@@ -1,10 +0,0 @@
-usage: create_cli_help.py restore [-h] [-x] [-N EXCLUDE_SCHEMA] file
-
-### positional arguments:
-- `file`: The backup file
-
-### options:
-- `-h, --help`: show this help message and exit
-- `-x`: ignore pg_restore errors
-- `-N EXCLUDE_SCHEMA, --exclude-schema EXCLUDE_SCHEMA`
-- `Schema to be ignored.`

pum-1.1.14/docs/docs/cli/role.md

@@ -1,8 +0,0 @@
-usage: create_cli_help.py role [-h] {create,grant,revoke,drop}
-
-### positional arguments:
-- `{create,grant,revoke,drop}`
-- `Action to perform`
-
-### options:
-- `-h, --help`: show this help message and exit

pum-1.1.14/docs/docs/cli/upgrade.md

@@ -1,8 +0,0 @@
-usage: create_cli_help.py upgrade [-h] [-u MAX_VERSION] [-p PARAMETER PARAMETER]
-
-### options:
-- `-h, --help`: show this help message and exit
-- `-u MAX_VERSION, --max-version MAX_VERSION`
-- `upper bound limit version`
-- `-p PARAMETER PARAMETER, --parameter PARAMETER PARAMETER`
-- `Assign variable for running SQL deltas. Format is: name value.`

pum-1.1.14/docs/docs/cli.md

@@ -1,25 +0,0 @@
-usage: create_cli_help.py [-h] [-c CONFIG_FILE] -s PG_SERVICE [-d DIR] [-v] [--version]
-- `{info,install,role,check,dump,restore,baseline,upgrade} ...`
-
-### options:
-- `-h, --help`: show this help message and exit
-- `-c CONFIG_FILE, --config_file CONFIG_FILE`
-- `set the config file. Default: .pum.yaml`
-- `-s PG_SERVICE, --pg-service PG_SERVICE`
-- `Name of the postgres service`
-- `-d DIR, --dir DIR`: Directory or URL of the module. Default: .
-- `-v, --verbose`: Increase output verbosity (e.g. -v, -vv)
-- `--version`: Show program's version number and exit.
-
-### commands:
-- `valid pum commands`
-
-- `{info,install,role,check,dump,restore,baseline,upgrade}`
-- `info`: show info about schema migrations history.
-- `install`: Installs the module.
-- `role`: manage roles in the database
-- `check`: check the differences between two databases
-- `dump`: dump a Postgres database
-- `restore`: restore a Postgres database from a dump file
-- `baseline`: Create upgrade information table and set baseline
-- `upgrade`: upgrade db

pum-1.1.14/docs/docs/configuration/config_model.md

@@ -1,5 +0,0 @@
-# ConfigModel
-
-Top-level Pydantic model for the PUM configuration file.
-
-::: pum.config_model.ConfigModel

pum-1.1.14/docs/docs/configuration/configuration.md

@@ -1,26 +0,0 @@
-# Configuration file .pum.yaml
-
-## Introduction
-
-In the config file `.pum.yaml`, you can define, with the YAML syntax:
-
-* `changelogs_directory`: the directory with the changelogs files.
-* `parameters`: the definition of parameters for the migration.
-* `migrations_hooks`: the `pre` and `post` migrations hooks.
-
-For example:  
-```yaml
-
-changelogs_directory: my_custom_directory
-
-parameters:
-  - name: SRID
-    type: integer
-    default: 2056
-    description: Coordinate Reference System (CRS) to use for the data. This is used for the geometry column in the database. Default is 2056 (CH1903+ / LV95).
-
-```  
-
-## Complete documentation
-
-For detailed configuration options, see the [Configuration Model](configuration/config_model.md).