diffly 1.0.0__tar.gz

diffly-1.0.0/.claude/CLAUDE.md

@@ -0,0 +1 @@
+../AGENTS.md

diffly-1.0.0/.copier-answers.yml

@@ -0,0 +1,12 @@
+# This file is managed by Copier; DO NOT EDIT OR REMOVE.
+_commit: v0.4.1-60-g881f631
+_src_path: ../copier-template-python-open-source
+add_autobump_workflow: false
+author_email: ege.karaismailoglu@quantco.com
+author_name: Ege Karaismailoglu
+github_url: https://github.com/Quantco/diffly
+github_user: EgeKaraismailogluQC
+minimal_python_version: py311
+project_short_description: Utility package for comparing polars dataframes.
+project_slug: diffly
+use_devcontainer: false

diffly-1.0.0/.envrc

@@ -0,0 +1,4 @@
+watch_file pixi.toml pixi.lock
+eval "$(pixi shell-hook)"
+
+dotenv_if_exists .env

diffly-1.0.0/.gitattributes

@@ -0,0 +1,9 @@
+* text=auto
+
+*.{diff,patch} binary
+
+*.{py,yaml,yml,sh} text eol=lf
+*.bat text eol=crlf
+
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true
+tests/summary/fixtures/*/gen/pretty_True_* linguist-generated=true

diffly-1.0.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @EgeKaraismailogluQC @borchero @MariusMerkleQC

diffly-1.0.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+# Motivation
+
+<!-- Why is this change necessary? Link issues here if applicable. -->
+
+# Changes
+
+<!-- What changes have been performed? -->

diffly-1.0.0/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      gh-actions:
+        patterns:
+          - "*"
+    cooldown:
+      default-days: 7
+    commit-message:
+      prefix: ci

diffly-1.0.0/.github/release-drafter.yml

@@ -0,0 +1,101 @@
+# ------------------------------------- PULL REQUEST LABELS ------------------------------------- #
+autolabeler:
+  # Conventional Commit Types (https://github.com/commitizen/conventional-commit-types)
+  - label: build
+    title:
+      - '/^build(\(.*\))?(\!)?\:/'
+  - label: chore
+    title:
+      - '/^chore(\(.*\))?(\!)?\:/'
+  - label: ci
+    title:
+      - '/^ci(\(.*\))?(\!)?\:/'
+  - label: documentation
+    title:
+      - '/^docs(\(.*\))?(\!)?\:/'
+  - label: enhancement
+    title:
+      - '/^feat(\(.*\))?(\!)?\:/'
+  - label: fix
+    title:
+      - '/^fix(\(.*\))?(\!)?\:/'
+  - label: performance
+    title:
+      - '/^perf(\(.*\))?(\!)?\:/'
+  - label: refactor
+    title:
+      - '/^refactor(\(.*\))?(\!)?\:/'
+  - label: revert
+    title:
+      - '/^revert(\(.*\))?(\!)?\:/'
+  - label: style
+    title:
+      - '/^style(\(.*\))?(\!)?\:/'
+  - label: test
+    title:
+      - '/^test(\(.*\))?(\!)?\:/'
+  # Custom Types
+  - label: breaking
+    title:
+      - '/^[a-z]+(\(.*\))?\!\:/'
+# ------------------------------------- AUTOMATIC VERSIONING ------------------------------------ #
+version-resolver:
+  major:
+    labels:
+      - breaking
+  minor:
+    labels:
+      - enhancement
+  default: patch
+# ------------------------------------ RELEASE CONFIGURATION ------------------------------------ #
+name-template: "v$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"
+category-template: "### $TITLE"
+change-template: "- $TITLE by @$AUTHOR in [#$NUMBER]($URL)"
+replacers:
+  # remove conventional commit tag & scope from change list
+  - search: '/- [a-z]+(\(.*\))?(\!)?\: /g'
+    replace: "- "
+template: |
+  ## What's Changed
+
+  $CHANGES
+
+  **Full Changelog:** [`$PREVIOUS_TAG...v$RESOLVED_VERSION`](https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION)
+categories:
+  - title: ⚠️ Breaking Changes
+    labels:
+      - breaking
+  - title: ✨ New Features
+    labels:
+      - enhancement
+  - title: 🐞 Bug Fixes
+    labels:
+      - fix
+  - title: 🏎️ Performance Improvements
+    labels:
+      - performance
+  - title: 📚 Documentation
+    labels:
+      - documentation
+  - title: 🏗️ Testing
+    labels:
+      - test
+  - title: ⚙️ Automation
+    labels:
+      - ci
+  - title: 🛠 Builds
+    labels:
+      - build
+  - title: 💎 Code Style
+    labels:
+      - style
+  - title: 📦 Refactorings
+    labels:
+      - refactor
+  - title: ♻️ Chores
+    labels:
+      - chore
+  - title: 🗑 Reverts
+    labels:
+      - revert

diffly-1.0.0/.github/workflows/build.yml

@@ -0,0 +1,46 @@
+name: Build
+on:
+  pull_request:
+  push:
+    branches: [main]
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@82d477f15f3a381dbcc8adc1206ce643fe110fb7 # v0.9.3
+        with:
+          environments: build
+      - name: Build project
+        run: pixi run -e build build-wheel
+      - name: Check package
+        run: pixi run -e build check-wheel
+      - name: Upload package
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
+        with:
+          name: artifact
+          path: dist/*
+
+  release:
+    name: Publish package
+    if: github.event_name == 'release'
+    needs: [build]
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment: pypi
+    steps:
+      - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
+        with:
+          name: artifact
+          path: dist
+      - name: Publish package on PyPi
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0

diffly-1.0.0/.github/workflows/chore.yml

@@ -0,0 +1,68 @@
+name: Chore
+on:
+  pull_request_target: # zizmor: ignore[dangerous-triggers] no PR code executed
+    branches: [main]
+    types: [opened, reopened, edited, synchronize]
+  push:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check-pr-title:
+    name: Check PR Title
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - name: Check valid conventional commit message
+        id: lint
+        uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6.1.1
+        with:
+          subjectPattern: ^[A-Z].+[^. ]$ # subject must start with uppercase letter and may not end with a dot/space
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+      - name: Post comment about invalid PR title
+        if: failure()
+        uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4
+        with:
+          header: conventional-commit-pr-title
+          message: |
+            Thank you for opening this pull request! 👋🏼
+
+            This repository requires pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.
+
+            <details><summary><b>Details</b></summary>
+
+            ```
+            ${{ steps.lint.outputs.error_message }}
+            ```
+
+            ${{ github.event.pull_request.user.login == 'dependabot[bot]' && '*Note: Please manually adjust this for the first few PRs created by dependabot.* It will learn the pattern over time.' || '' }}
+
+            </details>
+      - name: Delete comment about invalid PR title
+        if: success()
+        uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4
+        with:
+          header: conventional-commit-pr-title
+          delete: true
+
+  release-drafter:
+    name: ${{ github.event_name == 'pull_request' && 'Assign Labels' || 'Draft Release' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: ${{ github.event_name == 'pull_request' && 'Assign labels' || 'Update release draft' }}
+        uses: release-drafter/release-drafter@6db134d15f3909ccc9eefd369f02bd1e9cffdf97 # v6.2.0
+        with:
+          disable-releaser: ${{ github.event_name == 'pull_request' }}
+          disable-autolabeler: ${{ github.event_name == 'push' }}
+        env:
+          GITHUB_TOKEN: ${{ github.token }}

diffly-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,69 @@
+name: CI
+on: [push]
+
+# Automatically stop old builds on the same branch/PR
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Pre-commit Checks
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Check out branch
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          # needed for 'pre-commit-mirrors-insert-license'
+          fetch-depth: 0
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@82d477f15f3a381dbcc8adc1206ce643fe110fb7 # v0.9.3
+        with:
+          environments: default lint
+      - name: Install repository
+        run: pixi run -e default postinstall
+      - name: pre-commit
+        run: pixi run pre-commit-run --color=always --show-diff-on-failure
+      - name: Upload coverage
+        uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  unit-tests:
+    name: pytest
+    timeout-minutes: 30
+    runs-on: ${{ matrix.os }}
+    permissions:
+      id-token: write
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        environment:
+          - py311
+          - py312
+          - py313
+          - py314
+          - no-optional-dependencies
+        os:
+          - ubuntu-latest
+          - windows-latest
+    steps:
+      - name: Check out branch
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@82d477f15f3a381dbcc8adc1206ce643fe110fb7 # v0.9.3
+        with:
+          environments: ${{ matrix.environment }}
+      - name: Install repository
+        run: pixi run -e ${{ matrix.environment }} postinstall
+      - name: Run pytest
+        run: pixi run -e ${{ matrix.environment }} test-coverage --color=yes
+      - name: Upload coverage
+        uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

diffly-1.0.0/.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,22 @@
+name: Copilot Setup Steps
+on:
+  pull_request:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+  workflow_dispatch:
+
+jobs:
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@82d477f15f3a381dbcc8adc1206ce643fe110fb7 # v0.9.3
+        with:
+          environments: default lint
+      - name: Install repository
+        run: pixi run postinstall

diffly-1.0.0/.github/workflows/scorecard.yml

@@ -0,0 +1,77 @@
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard supply-chain security
+on:
+  # For Branch-Protection check. Only the default branch is supported. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+  branch_protection_rule:
+  # To guarantee Maintained check is occasionally updated. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+  schedule:
+    - cron: "34 5 * * 0"
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    # `publish_results: true` only works when run from the default branch. conditional can be removed if disabled.
+    if: (github.event.repository.default_branch == github.ref_name || github.event_name == 'pull_request') && github.repository == 'Quantco/diffly'
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Needed to publish results and get a badge (see publish_results below).
+      id-token: write
+      # Uncomment the permissions below if installing in a private repository.
+      # contents: read
+      # actions: read
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecard on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional.
+          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Public repositories:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories:
+          #   - `publish_results` will always be set to `false`, regardless
+          #     of the value entered here.
+          publish_results: true
+
+          # (Optional) Uncomment file_mode if you have a .gitattributes with files marked export-ignore
+          # file_mode: git
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard (optional).
+      # Commenting out will disable upload of results to your repo's Code Scanning dashboard
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@b20883b0cd1f46c72ae0ba6d1090936928f9fa30 # v4.32.0
+        with:
+          sarif_file: results.sarif