dir-content-diff 1.12.0__tar.gz → 1.13.0__tar.gz

{dir_content_diff-1.12.0 → dir_content_diff-1.13.0}/.github/workflows/commitlint.yml

@@ -11,8 +11,8 @@ jobs:
     env:
       PR_TITLE: ${{ github.event.pull_request.title }}
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
         with:
           node-version: '20'
       - run: npm install -g --force commitlint @commitlint/cli commitlint-plugin-cleanfeet

{dir_content_diff-1.12.0 → dir_content_diff-1.13.0}/.github/workflows/publish-sdist.yml

@@ -10,9 +10,9 @@ jobs:
     name: Build and publish on PyPI
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python 3.10
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.10"
       - name: Build a wheel and a source tarball

{dir_content_diff-1.12.0 → dir_content_diff-1.13.0}/.github/workflows/run-tox.yml

@@ -6,6 +6,8 @@ on:
     branches:
       - main
   workflow_dispatch:
+  schedule:
+    - cron: "0 2 15 1,7 *"
 
 jobs:
   build:
@@ -22,20 +24,17 @@ jobs:
             min_versions: "min_versions"
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
     - name: Get current month
       id: date
       run: echo "date=$(date +'%Y-%m')" >> $GITHUB_OUTPUT
-    - name: Cache APT Packages
-      uses: awalsh128/cache-apt-pkgs-action@latest
-      with:
-        packages: poppler-utils imagemagick
-        version: 1.0
-        execute_install_scripts: true
+    - name: Install APT Packages
+      run: |
+        sudo apt-get install -y poppler-utils imagemagick
     - name: Cache tox and precommit environments
       uses: actions/cache@v4
       with:

{dir_content_diff-1.12.0 → dir_content_diff-1.13.0}/.gitignore

@@ -30,6 +30,7 @@ test_venv
 docs/build
 docs/source/generated
 docs/source/examples
+docs/source/README_processed.md
 
 # reports
 reports

{dir_content_diff-1.12.0 → dir_content_diff-1.13.0}/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## [1.13.0](https://github.com/BlueBrain/dir-content-diff/compare/1.12.1..1.13.0)
+
+> 12 September 2025
+
+### New Features
+
+- Add patterns to ignore files in the reference directory (Adrien Berchet - [#86](https://github.com/BlueBrain/dir-content-diff/pull/86))
+
+### Documentation Changes
+
+- Fix format in Sphinx (Adrien Berchet - [#85](https://github.com/BlueBrain/dir-content-diff/pull/85))
+- Clarify how reference and compared directories are processed (Adrien Berchet - [#83](https://github.com/BlueBrain/dir-content-diff/pull/83))
+
+### Performance Improvements
+
+- Build comparator registry only once before iterating over all files (Adrien Berchet - [#87](https://github.com/BlueBrain/dir-content-diff/pull/87))
+
+## [1.12.1](https://github.com/BlueBrain/dir-content-diff/compare/1.12.0..1.12.1)
+
+> 3 July 2025
+
+### Fixes
+
+- Properly update the verbosity in PDF comparator (Adrien Berchet - [#75](https://github.com/BlueBrain/dir-content-diff/pull/75))
+
+### CI Improvements
+
+- Schedule CI every 6 months (Adrien Berchet - [#76](https://github.com/BlueBrain/dir-content-diff/pull/76))
+
 ## [1.12.0](https://github.com/BlueBrain/dir-content-diff/compare/1.11.0..1.12.0)
 
 > 18 November 2024

{dir_content_diff-1.12.0/dir_content_diff.egg-info → dir_content_diff-1.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: dir-content-diff
-Version: 1.12.0
+Version: 1.13.0
 Summary: Simple tool to compare directory contents.
 Author: Blue Brain Project, EPFL
 License: Apache License 2.0
@@ -21,6 +21,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 License-File: AUTHORS.md
+Requires-Dist: attrs>=21.3.0
 Requires-Dist: click>=8
 Requires-Dist: dictdiffer>=0.8
 Requires-Dist: dicttoxml>=1.7.12
@@ -60,6 +61,8 @@ Requires-Dist: morph_tool>=2.9; extra == "morphio"
 Provides-Extra: voxcell
 Requires-Dist: voxcell>=3.1.1; extra == "voxcell"
 Requires-Dist: pynrrd<1.1,>=0.4; extra == "voxcell"
+Dynamic: license-file
+Dynamic: provides-extra
 
 [![Version](https://img.shields.io/pypi/v/dir-content-diff)](https://github.com/BlueBrain/dir-content-diff/releases)
 [![Build status](https://github.com/BlueBrain/dir-content-diff/actions/workflows/run-tox.yml/badge.svg?branch=main)](https://github.com/BlueBrain/dir-content-diff/actions)
@@ -99,7 +102,7 @@ the files, so it is not able to report which values are different.
 
 ### Compare two directories
 
-If one wants to compare two directories with the following structures:
+Let's compare two directories with the following structures:
 
 ```bash
 └── reference_dir
@@ -118,6 +121,9 @@ If one wants to compare two directories with the following structures:
     └── file_1.c
 ```
 
+The `reference` directory contains all the files that should be checked in the `compared` directory,
+which means that extraneous files in the `compared` directory are just ignored.
+
 These two directories can be compared with the following code:
 
 ```python
@@ -126,7 +132,15 @@ import dir_content_diff
 dir_content_diff.compare_trees("reference_dir", "compared_dir")
 ```
 
-This code will return an empty dictionary because no difference was detected.
+> [!WARNING]
+> The order of the parameters is important: the first path is considered as the `reference`
+> directory while the second one is the `compared` directory. Inverting the parameters may return
+> a different result (in this example it would return that the file `sub_file_3.b` is missing).
+
+If all the files are identical, this code will return an empty dictionary because no difference
+was detected. As mentioned previously, this is because `dir-content-diff` is only looking for files
+in the compared directory that are also present in the reference directory, so the file
+`sub_file_3.b` is just ignored in this case.
 
 If ``reference_dir/file_1.c`` is the following JSON-like file:
 
@@ -226,7 +240,7 @@ specific_args = {
 }
 ```
 
-And last but not least, it's possible to use regular expressions to associate specific arguments to
+Another possibility is to use regular expressions to associate specific arguments to
 a set of files:
 
 ```python
@@ -238,6 +252,22 @@ specific_args = {
 }
 ```
 
+And last but not least, it's possible to filter files from the reference directory (for example
+because the reference directory contains temporary files that should not be compared). For
+example, the following code will ignore all files whose name does not start with `file_` and does
+not ends with `_tmp.yaml`:
+
+```python
+import dir_content_diff
+
+dir_content_diff.compare_trees(
+    "reference_dir",
+    "compared_dir",
+    include_patterns=[r"file_.*"],
+    exclude_patterns=[r".*_tmp\.yaml"],
+)
+```
+
 
 ### Export formatted data
 

{dir_content_diff-1.12.0 → dir_content_diff-1.13.0}/README.md

@@ -36,7 +36,7 @@ the files, so it is not able to report which values are different.
 
 ### Compare two directories
 
-If one wants to compare two directories with the following structures:
+Let's compare two directories with the following structures:
 
 ```bash
 └── reference_dir
@@ -55,6 +55,9 @@ If one wants to compare two directories with the following structures:
     └── file_1.c
 ```
 
+The `reference` directory contains all the files that should be checked in the `compared` directory,
+which means that extraneous files in the `compared` directory are just ignored.
+
 These two directories can be compared with the following code:
 
 ```python
@@ -63,7 +66,15 @@ import dir_content_diff
 dir_content_diff.compare_trees("reference_dir", "compared_dir")
 ```
 
-This code will return an empty dictionary because no difference was detected.
+> [!WARNING]
+> The order of the parameters is important: the first path is considered as the `reference`
+> directory while the second one is the `compared` directory. Inverting the parameters may return
+> a different result (in this example it would return that the file `sub_file_3.b` is missing).
+
+If all the files are identical, this code will return an empty dictionary because no difference
+was detected. As mentioned previously, this is because `dir-content-diff` is only looking for files
+in the compared directory that are also present in the reference directory, so the file
+`sub_file_3.b` is just ignored in this case.
 
 If ``reference_dir/file_1.c`` is the following JSON-like file:
 
@@ -163,7 +174,7 @@ specific_args = {
 }
 ```
 
-And last but not least, it's possible to use regular expressions to associate specific arguments to
+Another possibility is to use regular expressions to associate specific arguments to
 a set of files:
 
 ```python
@@ -175,6 +186,22 @@ specific_args = {
 }
 ```
 
+And last but not least, it's possible to filter files from the reference directory (for example
+because the reference directory contains temporary files that should not be compared). For
+example, the following code will ignore all files whose name does not start with `file_` and does
+not ends with `_tmp.yaml`:
+
+```python
+import dir_content_diff
+
+dir_content_diff.compare_trees(
+    "reference_dir",
+    "compared_dir",
+    include_patterns=[r"file_.*"],
+    exclude_patterns=[r".*_tmp\.yaml"],
+)
+```
+
 
 ### Export formatted data