diff options
| -rw-r--r-- | patternutils/commands/tmv.py | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/patternutils/commands/tmv.py b/patternutils/commands/tmv.py index 145a261..3f618d2 100644 --- a/patternutils/commands/tmv.py +++ b/patternutils/commands/tmv.py @@ -47,6 +47,14 @@ def tmv( verbose: bool, ) -> None: + """Rename files based on the OUTPUT_PATTERN. + + It read a JSON list containing objects. The object needs to have a + key named _abspath, which points to the file to move. The rest of the + keys will be supplied to the templating engine to generate the new + filename. + """ + try: data = json.load(read_from) # type: ignore except json.JSONDecodeError: |