dirdiff -> uniondiff

Author: msg555

.dockerignore

@@ -1,5 +1,5 @@
 *
-!dirdiff
+!uniondiff
 !tests
 !requirements*
 !setup.cfg

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: dirdiff
+name: uniondiff
 on:
   push:
     branches:

.gitignore

@@ -6,4 +6,4 @@ test-basic
 .coverage
 *.pypi-token.gpg
 dist
-dirdiff.egg-info
+*.egg-info

Dockerfile

@@ -1,7 +1,7 @@
 FROM python:3.8
 
-ENV PYTHONPATH=/dirdiff
-WORKDIR /dirdiff
+ENV PYTHONPATH=/uniondiff
+WORKDIR /uniondiff
 
 COPY requirements* ./
 

Makefile

@@ -3,7 +3,7 @@ PYTHON ?= python3
 PLATFORM ?= linux/amd64
 PROFILE ?= dev
 IMAGE_BUILDER ?= docker
-IMAGE_NAME ?= msg555/dirdiff
+IMAGE_NAME ?= msg555/uniondiff
 
 all: format lint test docs
 
@@ -16,25 +16,25 @@ format-check:
 	$(PYTHON) -m isort --profile=black --check .
 
 pylint:
-	$(PYTHON) -m pylint dirdiff tests
+	$(PYTHON) -m pylint uniondiff tests
 
 typecheck:
-	$(PYTHON) -m mypy dirdiff tests
+	$(PYTHON) -m mypy uniondiff tests
 
 lint: format-check pylint typecheck
 
 test:
 ifeq ($(OS),Windows_NT)
-	$(PYTHON) -m pytest -sv --cov=dirdiff -m 'not cap and not unix' tests
+	$(PYTHON) -m pytest -sv --cov=uniondiff -m 'not cap and not unix' tests
 else
-	$(PYTHON) -m pytest -sv --cov=dirdiff -m 'not cap' tests
+	$(PYTHON) -m pytest -sv --cov=uniondiff -m 'not cap' tests
 endif
 
 test-all:
 ifeq ($(OS),Windows_NT)
-	$(PYTHON) -m pytest -sv --cov=dirdiff -m 'not unix' tests
+	$(PYTHON) -m pytest -sv --cov=uniondiff -m 'not unix' tests
 else
-	$(PYTHON) -m pytest -sv --cov=dirdiff -m '' tests
+	$(PYTHON) -m pytest -sv --cov=uniondiff -m '' tests
 endif
 
 build:
@@ -47,7 +47,7 @@ image:
 	$(IMAGE_BUILDER) build -t $(IMAGE_NAME) .
 
 image-%: image
-	docker run --rm -v "$${PWD}:/dirdiff" $(IMAGE_NAME) make $*
+	docker run --rm -v "$${PWD}:/uniondiff" $(IMAGE_NAME) make $*
 
 pypi-test: build
 	TWINE_USERNAME=__token__ TWINE_PASSWORD="$(shell gpg -d test.pypi-token.gpg)" \

README.md

@@ -1,59 +1,59 @@
-# dirdiff - Directory difference calculator
+# uniondiff - Directory difference calculator
 
-*dirdiff* is a simple tool for calculating the directory difference between two
-directories or archives. Dirdiff performs the calculation below:
+*uniondiff* is a simple tool for calculating the directory difference between two
+directories or archives. *uniondiff* performs the calculation below:
 
 ```
 upper = merged - lower
 ```
 
 This tool acts as the inverse [union mount](https://en.wikipedia.org/wiki/Union_mount)
 file systems. Whereas typically you combine a *lower* and *upper* directory to
-produce a *merged* directory, *dirdiff* takes as input the *merged* directory
+produce a *merged* directory, *uniondiff* takes as input the *merged* directory
 and subtracts out the *lower* directory to produce the *upper* directory. In
 particular, the resulting output can be mounted as the *upper* directory
 along with the *lower* to produce the original *merged* directory.
 
-*dirdiff* is intended for use with low level file system tools (e.g. container
+*uniondiff* is intended for use with low level file system tools (e.g. container
 systems) or for simply storing diffs of directories. Note that this tool *does
 not* store compact diffs of individual files; a file will appear in full in the
 diff iff its content or metadata has changed between the *merged* and *lower*
 operands.
 
 ## Installation
 
-*dirdiff* can be installed through *pip*. This installs both the `dirdiff`
-CLI utility and the *dirdiff* Python library.
+*uniondiff* can be installed through *pip*. This installs both the `uniondiff`
+CLI utility and the *uniondiff* Python library.
 
 ```sh
 pip install tplbuild
 ```
 
-*dirdiff* is supported and tested on Python 3.8-3.10
+*uniondiff* is supported and tested on Python 3.8-3.10
 
 ## Examples
 
 Compute the directory difference between the directory "data-day10" and
 "data-day9". By default the output will be written as a tar file.
 
 ```sh
-dirdiff data-day10 data-day9 > diff.tar
+uniondiff data-day10 data-day9 > diff.tar
 ```
 
-Dirdiff can also write directly to the file system. Note that it will ignore
+*uniondiff* can also write directly to the file system. Note that it will ignore
 ownership changes unless you also pass the `--preserve-owners` flag.
 
 ```sh
-dirdiff data-day10 data-day9 --output-type file -o diff
+uniondiff data-day10 data-day9 --output-type file -o diff
 ```
 
 You can also use tar archives as the input paths.
 
 ```sh
-dirdiff data-day10.tar data-day9.tgz > diff.tar
+uniondiff data-day10.tar data-day9.tgz > diff.tar
 ```
 
 ## Contributing
 
-If you want to contribute to *dirdiff*, you can do so by creating a pull request.
+If you want to contribute to *uniondiff*, you can do so by creating a pull request.
 lease make sure to include a detailed description of the changes you're proposing.

setup.cfg

@@ -1,12 +1,12 @@
 [metadata]
-name = dirdiff
-version = attr: dirdiff._version.__version__
+name = uniondiff
+version = attr: uniondiff._version.__version__
 author = Mark Gordon
 author_email = [email protected]
 description = Directory difference CLI tool
 long_description = file: README.md
 long_description_content_type = text/markdown
-url = http://github.com/msg555/dirdiff/
+url = http://github.com/msg555/uniondiff/
 classifiers =
     Programming Language :: Python
     Programming Language :: Python :: 3
@@ -18,14 +18,14 @@ classifiers =
 
 [options]
 packages =
-    dirdiff
+    uniondiff
 python_requires = >=3.8
 include-package-data = True
 
 [options.package_data]
-dirdiff =
+uniondiff =
   py.typed
 
 [options.entry_points]
 console_scripts =
-  dirdiff = dirdiff.cli:main
+  uniondiff = uniondiff.cli:main

tests/conftest.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from dirdiff.output_file import OutputBackendFile
+from uniondiff.output_file import OutputBackendFile
 
 
 @pytest.fixture

tests/test_e2e.py

@@ -3,7 +3,7 @@
 import tarfile
 import tempfile
 
-from dirdiff.cli import main
+from uniondiff.cli import main
 
 
 def tar_summarize(tf: tarfile.TarFile):

tests/test_io_file.py

@@ -4,8 +4,8 @@
 
 import pytest
 
-from dirdiff.filelib import DirectoryManager, StatInfo
-from dirdiff.osshim import major, makedev, minor
+from uniondiff.filelib import DirectoryManager, StatInfo
+from uniondiff.osshim import major, makedev, minor
 
 # pylint: disable=redefined-outer-name
 
@@ -60,7 +60,7 @@ def test_file_write_dir(file_backend):
 def test_file_write_reg(file_backend):
     """Test writing a regular file than reading the regular file"""
     mode = 0o644 | stat.S_IFREG
-    data = b"Hello dirdiff!"
+    data = b"Hello uniondiff!"
     file_name = "my-file"
 
     st = stat_with_defaults(mode=mode, size=len(data))
@@ -83,7 +83,7 @@ def test_file_write_reg(file_backend):
 def test_file_write_link(file_backend):
     """Test writing a file and a symlink pointing to it then reading the same"""
     mode = 0o644 | stat.S_IFREG
-    data = b"Hello dirdiff!"
+    data = b"Hello uniondiff!"
     file_name = "my-file"
 
     st = stat_with_defaults(mode=mode, size=len(data))
@@ -155,7 +155,7 @@ def test_file_write_device(ftype, file_backend):
 def test_file_write_chown(file_backend_preserve):
     """Test ownership preservation with a regular file"""
     mode = 0o644 | stat.S_IFREG
-    data = b"Hello dirdiff!"
+    data = b"Hello uniondiff!"
     file_name = "my-file"
     uid = 123
     gid = 543