mkdocs

.github/workflows/python-publish.yml

@@ -15,6 +15,6 @@ jobs:
           fetch-depth: 0
       - run: python3 -m pip install --upgrade build && python3 -m build
       - name: Publish package
-        uses: pypa/gh-action-pypi-publish@v1.8.10
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          password: ${{ secrets.PYPI_GITHUB_ORGAFOLD }}
+          password: ${{ secrets.PYPI_GITHUB_ORGAFOLD }}

.github/workflows/run-unittest.yml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.11, 3.12, 3.13]
+        python-version: [3.11, 3.12]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}

Makefile

@@ -3,4 +3,4 @@ export TAG := `grep version pyproject.toml | pz --search '"(\d+\.\d+\.\d+(?:rc\d
 release:
 	git tag $(TAG)
 	git push origin $(TAG)
-	#mkdocs gh-deploy
+	mkdocs gh-deploy

README.md

@@ -0,0 +1 @@
+docs/index.md

deduplidog/__main__.py

@@ -6,8 +6,6 @@
 
 
 def main():
-    # NOTE: I'd like to have the default in case work dir is not specified args=("--work-dir", str(Path.cwd()))
-    # Currently, args overthrows CLI arguments.
     with run(Deduplidog, interface=None) as m:
         try:
             while True:
@@ -32,9 +30,9 @@ def main():
         except KeyboardInterrupt:
             print("")
             sys.exit()
-        except Exception as e:
-            import ipdb
-            ipdb.post_mortem()  # TODO
+        # except Exception as e:
+        #     import ipdb
+        #     ipdb.post_mortem()
 
 
 if __name__ == "__main__":

deduplidog/deduplidog.py

@@ -37,6 +37,8 @@
 
 @dataclass
 class Action:
+    """ What is to be done with the duplicates. """
+
     execute: bool = False
     "If False, nothing happens, just a safe run is performed."
 
@@ -63,6 +65,8 @@ class Action:
 
 @dataclass
 class Execution:
+    """ Parameters affecting the way the execution runs. """
+
     set_both_to_older_date: bool = False
     "If `execute=True`, `media_magic=True` or (media_magic=False and `ignore_date=True`), both files are set to the older date. Ex: work file get's the original file's date or vice versa."
 
@@ -80,11 +84,15 @@ class Execution:
     "By default, when a file with bigger size or older date should be affected, just warning is generated. Turn this to suppress it."
 
     confirm_one_by_one: bool = True
-    """ Instead of executing changes all at once, confirm one by one. So that you may decide whether the media similarity detection works. """
+    """ Instead of executing changes all at once, confirm one by one.
+        So that you may decide whether the media similarity detection works.
+        If a warning occurs, the default is 'no' to perform the action. """
 
 
 @dataclass
 class Match:
+    """ The way the files are compared. """
+
     casefold: bool = False
     "Case insensitive file name comparing."
     checksum: bool = False
@@ -123,6 +131,7 @@ class Match:
 
 @dataclass
 class Media:
+    """ Media files similarity detection. """
 
     media_magic: bool = False
     """ Media files similarity detection.
@@ -146,6 +155,8 @@ class Media:
 
 @dataclass
 class Helper:
+    """ Helper settings. """
+
     log_level: int = logging.WARNING
     "10 debug .. 50 critical"  # NOTE check
 

docs/Changelog.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.7.0 (2025-01-09)
+Working as expected.

docs/Overview.md

@@ -0,0 +1,22 @@
+## Deduplidog overview
+
+Launch `deduplidog` and change these parameter from GUI/TUI, or set them via CLI.
+
+::: deduplidog.Deduplidog
+    options:
+        members:
+          - work_dir
+          - original_dir
+        show_aliases: false
+        show_source: false
+
+# Action
+::: deduplidog.deduplidog.Action
+# Execution
+::: deduplidog.deduplidog.Execution
+# Match
+::: deduplidog.deduplidog.Match
+# Media
+::: deduplidog.deduplidog.Media
+# Helper
+::: deduplidog.deduplidog.Helper