recursive-diff 1.0.0__tar.gz → 1.2.0__tar.gz

recursive_diff-1.2.0/.gitattributes

@@ -0,0 +1,2 @@
+# reduce the number of merge conflicts
+doc/whats-new.rst merge=union

recursive_diff-1.2.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+- [ ] Closes #xxxx
+- [ ] Tests added / passed
+- [ ] Passes `pre-commit run --all-files`

recursive_diff-1.2.0/.github/workflows/docs.yml

@@ -0,0 +1,47 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ['*']
+
+defaults:
+  run:
+    shell: bash -l {0}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Conda Environment
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-variant: Mambaforge
+          miniforge-version: latest
+          use-mamba: true
+          environment-file: ci/requirements-docs.yml
+          activate-environment: recursive_diff-docs
+
+      - name: Show conda options
+        run: conda config --show
+
+      - name: conda info
+        run: conda info
+
+      - name: conda list
+        run: conda list
+
+      - name: Install
+        run: python -m pip install --no-deps -e .
+
+      - name: Build docs
+        run: sphinx-build -n -j auto -b html -d build/doctrees doc build/html
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: recursive_diff-docs
+          path: build/html

recursive_diff-1.2.0/.github/workflows/pre-commit.yml

@@ -0,0 +1,16 @@
+name: Linting
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ['*']
+
+jobs:
+  checks:
+    name: pre-commit hooks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - uses: pre-commit/action@v3.0.0

recursive_diff-1.2.0/.github/workflows/pytest.yml

@@ -0,0 +1,123 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ['*']
+
+# When this workflow is queued, automatically cancel any previous running
+# or pending jobs from the same branch
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash -l {0}
+
+jobs:
+  build:
+    name: ${{ matrix.os }} ${{ matrix.python-version }} ${{ matrix.requirements }}
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu]
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        requirements: [latest]
+        include:
+          # Test on macos and windows (first and last version of python only)
+          - os: macos
+            python-version: '3.8'
+            requirements: latest
+          - os: macos
+            python-version: '3.12'
+            requirements: latest
+          - os: windows
+            python-version: '3.8'
+            requirements: latest
+          - os: windows
+            python-version: '3.12'
+            requirements: latest
+          # Test on minimal requirements
+          - os: ubuntu
+            python-version: '3.8'
+            requirements: minimal
+          - os: macos
+            python-version: '3.8'
+            requirements: minimal
+          - os: windows
+            python-version: '3.8'
+            requirements: minimal
+          # Test without any optional dependencies
+          - os: ubuntu
+            python-version: '3.8'
+            requirements: no_optionals
+          - os: ubuntu
+            python-version: '3.12'
+            requirements: no_optionals
+          - os: macos
+            python-version: '3.8'
+            requirements: no_optionals
+          - os: macos
+            python-version: '3.12'
+            requirements: no_optionals
+          - os: windows
+            python-version: '3.8'
+            requirements: no_optionals
+          - os: windows
+            python-version: '3.12'
+            requirements: no_optionals
+          # Test on nightly builds of requirements
+          - os: ubuntu
+            python-version: '3.12'
+            requirements: upstream
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Conda Environment
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-variant: Mambaforge
+          miniforge-version: latest
+          use-mamba: true
+          python-version: ${{ matrix.python-version }}
+          environment-file: ci/requirements-${{ matrix.requirements }}.yml
+          activate-environment: recursive_diff
+
+      - name: Install nightly builds
+        if: ${{ matrix.requirements == 'upstream' }}
+        run: |
+          # Pick up https://github.com/mamba-org/mamba/pull/2903
+          mamba install -n base 'mamba>=1.5.2'
+      
+          mamba uninstall --force numpy pandas scipy pyarrow
+          python -m pip install --no-deps --pre --prefer-binary \
+              --extra-index-url https://pypi.fury.io/arrow-nightlies/ \
+              pyarrow
+          python -m pip install --no-deps --pre \
+              -i https://pypi.anaconda.org/scientific-python-nightly-wheels/simple \
+              numpy pandas scipy
+
+      - name: Show conda options
+        run: conda config --show
+
+      - name: conda info
+        run: conda info
+
+      - name: conda list
+        run: conda list
+
+      - name: Install
+        run: python -m pip install --no-deps -e .
+
+      - name: pytest
+        run: py.test --verbose --cov=recursive_diff --cov-report=xml
+
+      - name: codecov.io
+        uses: codecov/codecov-action@v3

recursive_diff-1.2.0/.gitignore

@@ -0,0 +1,62 @@
+*.pyc
+__pycache__
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+.eggs
+dist
+build
+eggs
+parts
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage*
+coverage.xml
+.tox
+nosetests.xml
+.cache
+.mypy_cache/
+.ropeproject/
+.tags*
+.testmon*
+.pytest_cache
+dask-worker-space/
+
+# asv environments
+.asv
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# IDEs
+.idea
+*.swp
+.DS_Store
+.vscode/
+
+# Sync tools
+Icon*
+
+.ipynb_checkpoints
+
+doc/_build
+Untitled.ipynb
+htmlcov/

recursive_diff-1.2.0/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/MarcoGorelli/absolufy-imports
+    rev: v0.3.1
+    hooks:
+      - id: absolufy-imports
+        name: absolufy-imports
+  - repo: https://github.com/psf/black
+    rev: 23.12.1
+    hooks:
+      - id: black
+        language_version: python3
+        args:
+          - --target-version=py38
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.14
+    hooks:
+      - id: ruff
+        args: ["--fix", "--show-fixes"]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          # Typed libraries
+          - numpy
+          - pandas
+          - xarray

recursive_diff-1.2.0/.readthedocs.yaml

@@ -0,0 +1,19 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: mambaforge-22.9
+
+conda:
+  environment: ci/requirements-docs.yml
+
+python:
+   install:
+      - method: pip
+        path: .
+
+sphinx:
+  builder: html
+  configuration: doc/conf.py
+  fail_on_warning: false

recursive_diff-1.2.0/HOW_TO_RELEASE

@@ -0,0 +1,64 @@
+How to issue a release in 15 easy steps
+
+Time required: about an hour.
+
+ 1. Ensure your main branch is synced to origin:
+       git pull origin main
+ 2. Look over whats-new.rst and the docs. Make sure "What's New" is complete
+    (check the date!) and add a brief summary note describing the release at the
+    top.
+ 3. If you have any doubts, run the full test suite one final time!
+      py.test
+ 4. On the main branch, commit the release in git:
+      git commit -a -m 'Release vX.Y.Z'
+ 5. Tag the release:
+      git tag -a vX.Y.Z -m 'vX.Y.Z'
+ 6. Push your changes to main:
+      git push origin main
+      git push origin --tags
+ 7. Update the stable branch (used by ReadTheDocs) and switch back to main:
+      git checkout stable
+      git rebase main
+      git push origin stable
+      git checkout main
+    It's OK to force push to 'stable' if necessary.
+    We also update the stable branch with `git cherrypick` for documentation
+    only fixes that apply the current released version.
+ 8. Build and test the release package
+      python -m pip install --upgrade build twine
+      rm -rf dist
+      python -m build
+      python -m twine check dist/*
+ 9. Add a section for the next release to doc/whats-new.rst.
+10. Commit your changes and push to main again:
+      git commit -a -m 'Revert to dev version'
+      git push origin main
+    You're done pushing to main!
+11. Issue the release on GitHub. Open https://github.com/crusaderky/recursive_diff/releases;
+    the new release should have automatically appeared. Otherwise, click on
+    "Draft a new release" and paste in the latest from whats-new.rst.
+12. Use twine to register and upload the release on pypi. Be careful, you can't
+    take this back!
+      twine upload dist/*
+    You will need to be listed as a package owner at
+    https://pypi.python.org/pypi/recursive_diff for this to work.
+13. Update the docs. Login to https://readthedocs.org/projects/recursive_diff/versions/
+    and switch your new release tag (at the bottom) from "Inactive" to "Active".
+    It should now build automatically.
+    Make sure that both the new tagged version and 'stable' build successfully.
+14. Update conda-forge.
+14a.  Clone https://github.com/conda-forge/recursive_diff-feedstock
+14b.  Update the version number and sha256 in meta.yaml.
+      You can calculate sha256 with
+        sha256sum dist/*
+14c.  Double check dependencies in meta.yaml and update them to match pyproject.toml.
+14d.  Submit a pull request.
+14e.  Write a comment in the PR:
+        @conda-forge-admin, please rerender
+      Wait for the rerender commit (it may take a few minutes).
+14f.  Wait for CI to pass and merge.
+14g.  The next day, test the conda-forge release
+        conda search recursive_diff
+        conda create -n recursive_diff-test recursive_diff
+        conda list
+        python -m 'import recursive_diff'

recursive_diff-1.2.0/MANIFEST.in

@@ -0,0 +1,13 @@
+include HOW_TO_RELEASE
+include LICENSE
+include *.md
+include *.py
+recursive-include ci *
+recursive-include doc *
+recursive-include recursive_diff *
+prune doc/_build
+global-exclude __pycache__
+global-exclude *.pyc
+global-exclude .DS_Store
+global-exclude .ipynb_checkpoints
+global-exclude dask-worker-space

recursive_diff-1.2.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: recursive_diff
+Version: 1.2.0
+Summary: Recursively compare two Python data structures
+Author-email: Guido Imperiale <crusaderky@gmail.com>
+License: Apache
+Project-URL: Homepage, https://github.com/crusaderky/recursive_diff
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: numpy>=1.16
+Requires-Dist: pandas>=0.25
+Requires-Dist: xarray>=0.12
+
+Recursively compare two Python data structures

recursive_diff-1.2.0/README.md

@@ -0,0 +1,10 @@
+recursive_diff
+=============
+[![doc-badge](https://github.com/crusaderky/recursive_diff/actions/workflows/docs.yml/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
+[![pre-commit-badge](https://github.com/crusaderky/recursive_diff/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
+[![pytest-badge](https://github.com/crusaderky/recursive_diff/actions/workflows/pytest.yml/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
+[![codecov-badge](https://codecov.io/gh/crusaderky/recursive_diff/branch/main/graph/badge.svg)](https://codecov.io/gh/crusaderky/recursive_diff/branch/main)
+
+Recursively compare two Python data structures
+
+Full documentation at http://recursive_diff.readthedocs.io/

recursive_diff-1.2.0/ci/requirements-docs.yml

@@ -0,0 +1,10 @@
+name: recursive_diff-docs
+channels:
+  - conda-forge
+dependencies:
+  - python=3.12
+  - sphinx
+  - sphinx_rtd_theme
+
+  - dask
+  - xarray

recursive_diff-1.2.0/ci/requirements-latest.yml

@@ -0,0 +1,12 @@
+name: recursive_diff
+channels:
+  - conda-forge
+dependencies:
+  - pytest
+  - pytest-cov
+  - packaging
+
+  - xarray
+  - dask
+  - h5netcdf  # NetCDF engine
+  - scipy  # NetCDF engine

recursive_diff-1.2.0/ci/requirements-minimal.yml

@@ -0,0 +1,17 @@
+name: recursive_diff
+channels:
+  - conda-forge
+dependencies:
+  - pytest
+  - pytest-cov
+  - packaging
+
+  - dask=2.0
+  - numpy=1.16
+  - pandas=0.25
+  - xarray=0.12
+
+  # NetCDF engines
+  - scipy=1.3
+  - h5netcdf=0.7
+  - hdf5=1.10

recursive_diff-1.2.0/ci/requirements-no_optionals.yml

@@ -0,0 +1,10 @@
+name: recursive_diff
+channels:
+  - conda-forge
+dependencies:
+  - pytest
+  - pytest-cov
+  - packaging
+
+  - xarray
+  - pyarrow  # Only needed to suppress warnings; remove when pandas 3.0 is released

recursive_diff-1.2.0/ci/requirements-upstream.yml

@@ -0,0 +1,19 @@
+name: recursive_diff
+channels:
+  - conda-forge
+dependencies:
+  - pytest
+  - pytest-cov
+  - packaging
+
+  - xarray
+  - dask
+  - h5netcdf  # NetCDF engine
+  - scipy  # NetCDF engine
+
+  - pip
+  - pip:
+      - git+https://github.com/dask/dask
+      - git+https://github.com/dask/distributed
+      - git+https://github.com/pydata/xarray
+      # numpy, pandas, pyarrow, and scipy are upgraded to nightly builds by pytest.yml