Merge branch 'dev'

.github/workflows/docs.yaml

@@ -0,0 +1,48 @@
+# Adjusted workflow from: https://github.com/mitmproxy/pdoc/blob/25f325d06aaacba9711f957f48e770029f608f6a/.github/workflows/docs.yml
+
+name: Generate documentation using pdoc and deploy as gh page.
+
+# build the documentation whenever there are new commits on main
+on:
+  workflow_dispatch:
+    branches:
+  push:
+    branches:
+    tags:
+    - '*'
+
+# security: restrict permissions for CI jobs.
+permissions:
+  contents: read
+
+jobs:
+  # Build the documentation and upload the static HTML files as an artifact.
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
+      # Install all dependencies (including pdoc)
+    - run: pip install -e .[docs]
+    - run: pdoc -d numpy -o docs dvc_stage
+    - uses: actions/upload-pages-artifact@v3
+      with:
+        path: docs/
+
+  # Deploy the artifact to GitHub pages.
+  # This is a separate job so that only actions/deploy-pages has the necessary permissions.
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+    - id: deployment
+      uses: actions/deploy-pages@v4

.github/workflows/pre-commit.yaml

@@ -0,0 +1,11 @@
+name: run pre-commit hooks
+
+on: [push]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+    - uses: pre-commit/action@v3.0.1

.github/workflows/release.yaml

@@ -0,0 +1,118 @@
+# Inspired by: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+
+name: Publish Python Distribution to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.x
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPi
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/dvc-stage
+    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 PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python distribution with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'
+
+  publish-to-testpypi:
+    name: Publish Python distribution to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/dvc-stage
+
+    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:
+        skip-existing: true
+        repository-url: https://test.pypi.org/legacy/

.github/workflows/run_demo.yaml

@@ -18,8 +18,10 @@ jobs:
       fail-fast: false
       matrix:
         py:
+        - '3.11'
         - '3.10'
         - '3.9'
+        - '3.8'
         os:
         - ubuntu-latest
         - macos-latest
@@ -40,4 +42,5 @@ jobs:
       run: |
         cd examples
         pip install .
+        dvc-stage update-all -y
         dvc repro

.gitignore

@@ -73,7 +73,7 @@ flycheck_*.el
 .LSOverride
 
 # Icon must end with two \r
-Icon
+Icon
 
 # Thumbnails
 ._*

.pre-commit-config.yaml

@@ -1,37 +1,41 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
 repos:
-- repo: https://github.com/timothycrosley/isort
-  rev: 5.12.0
-  hooks:
-  - id: isort
-    args: [--profile, black]
-- repo: https://github.com/psf/black
-  rev: 23.3.0
-  hooks:
-  - id: black
-  - id: black-jupyter
-- repo: https://github.com/PyCQA/flake8
-  rev: 6.0.0
-  hooks:
-  - id: flake8
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
-  hooks:
-  - id: trailing-whitespace
-  - id: end-of-file-fixer
-  - id: check-yaml
-    args: [--unsafe]
-  - id: check-toml
-  - id: check-ast
+- hooks:
+  - args:
+    - --fix
+    id: ruff
+  - id: ruff-format
+  repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.6.5
+- hooks:
   - id: check-added-large-files
+  - id: check-executables-have-shebangs
   - id: check-merge-conflict
   - id: check-shebang-scripts-are-executable
-  - id: check-executables-have-shebangs
-- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-  rev: v2.9.0
-  hooks:
-  - id: pretty-format-yaml
-    args: [--autofix, --indent, '2']
-  - id: pretty-format-toml
-    args: [--autofix]
+  - id: check-toml
+  - id: check-yaml
+  - id: end-of-file-fixer
+  - id: mixed-line-ending
+  - id: trailing-whitespace
+  repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+- hooks:
+  - args:
+    - --autofix
+    - --indent
+    - '2'
+    id: pretty-format-yaml
+  - args:
+    - --autofix
+    id: pretty-format-toml
+  - args:
+    - --autofix
+    id: pretty-format-ini
+  repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.14.0
+- hooks:
+  - id: commitizen
+  - id: commitizen-branch
+    stages:
+    - push
+  repo: https://github.com/commitizen-tools/commitizen
+  rev: v3.29.0

CHANGELOG.md

@@ -0,0 +1,41 @@
+## v1.0.0 (2024-09-15)
+
+### Feat
+
+- add `--yes` flag for automatically confirmation
+
+### Fix
+
+- correct default arguments for included and excluded keys to empty list
+- use python 3.8 compatible type annotations
+- update pandera to a version supporting NumPy 2
+
+## v1.0.0rc5 (2024-09-13)
+
+### Feat
+
+- allows to provide returned keys for custom data loaders
+
+### Fix
+
+- dynamically retrieve version from package meta data
+
+## v1.0.0-rc4 (2023-06-14)
+
+## v1.0.0-rc3 (2023-03-21)
+
+## v1.0.0-rc2 (2023-02-16)
+
+## v1.0.0-rc1 (2023-02-13)
+
+## v0.0.7 (2023-02-07)
+
+## v0.0.6 (2022-12-16)
+
+## v0.0.5 (2022-12-01)
+
+## v0.0.4 (2022-12-01)
+
+## v0.0.3 (2022-12-01)
+
+## v0.0.2 (2022-11-29)