update docs

Author: cnheider

.github/images/octocat.svg

@@ -1,10 +1,10 @@
 fail_fast: true
 repos:
   - repo: https://github.com/ambv/black
-    rev: 22.6.0
+    rev: 23.3.0
     hooks:
       - id: black
-        language_version: python3.8
+        language_version: python3.10
   - repo: local
     hooks:
       - id: pytest-check

.pre-commit-config.yaml

@@ -14,7 +14,7 @@
 from pathlib import Path
 from typing import Iterable, Callable, Optional, Sequence, Mapping, List
 
-from warg.os_utilities.filtering import negate, is_python_module, is_python_package
+from warg.os_utilities.filtering import negate, is_python_package
 
 
 def has_import_aliases(path: Path, *, verbose: bool = False) -> bool:

devpack/batch_tools/aliases.py

@@ -270,7 +270,6 @@ def recursive_check_alls(
             if exclusion_filter is None or not any(
                 flt(child) for flt in exclusion_filter
             ):
-
                 recursive_check_alls(
                     child,
                     exclusion_filter,

devpack/batch_tools/alls.py

@@ -15,6 +15,7 @@
 from typing import Optional, Callable, Iterable
 
 from draugr.os_utilities.linux_utilities.user_utilities import get_username
+
 from warg.os_utilities.filtering import is_python_module, negate
 
 

devpack/batch_tools/privates.py

@@ -14,6 +14,7 @@
 from typing import Callable, Iterable, Optional
 
 from sorcery import assigned_names
+
 from warg.os_utilities.filtering import negate, is_python_package
 
 

devpack/batch_tools/readmes.py

@@ -12,8 +12,8 @@
 import argparse
 from pathlib import Path
 
-from devpack.batch_tools.readmes import TouchModeEnum, recursive_add_readmes
 from devpack.batch_tools.inits import recursive_remove_inits
+from devpack.batch_tools.readmes import TouchModeEnum, recursive_add_readmes
 
 
 def recursively_add_readmes_from_here():

devpack/entry_points/batch.py

@@ -7,8 +7,8 @@
 
 import argparse
 
-from devpack.development import pip_uninstall_package
 from devpack.development import pip_install_development_package
+from devpack.development import pip_uninstall_package
 
 
 def install_develop():

devpack/entry_points/cli.py

@@ -0,0 +1,25 @@
+import argparse
+from pathlib import Path
+from devpack.batch_tools.readmes import recursive_add_readmes
+
+
+def bump():
+    def recursively_add_readmes_from_here():
+        """
+        Add readmes to all python modules in the current directory
+        """
+        parser = argparse.ArgumentParser(description="DevPack add readmes from here")
+        parser.add_argument(
+            "--path", "-p", type=Path, default=Path.cwd(), help="Path to add readmes to"
+        )
+        parser.add_argument(
+            "--verbose", action="store_true", help="Verbose output of touched files"
+        )
+        args = parser.parse_args()
+
+        recursive_add_readmes(
+            args.path,
+            touch_mode=args.touch_mode,
+            readme_name=args.readme_name,
+            verbose=args.verbose,
+        )