chname 2.1.3__tar.gz

chname-2.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021- Steve Scholnick
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

chname-2.1.3/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.3
+Name: chname
+Version: 2.1.3
+Summary: Renames files in powerful ways
+License: MIT
+Author: Steve Scholnick
+Author-email: scholnicks@gmail.com
+Requires-Python: >=3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: docopt-ng (>=0.9.0,<0.10.0)
+Project-URL: Repository, https://github.com/scholnicks/chname
+Description-Content-Type: text/markdown
+
+# chname
+
+chname renames files in powerful ways.
+
+```
+Usage:
+    chname [options] [<files>...]
+
+Options:
+    -a, --append=<suffix>                      Suffix to be appended
+    -d, --delimiter=<delimiter>                Specifies the delimiter for fixing numerical filenames
+    --directory=<directory>                    Destination directory [default: .]
+    -f, --fix=<maximum number of digits>       Fixes numerical file names
+    -h, --help                                 Show this help screen
+    -l, --lower                                Translates the filenames to lowercase
+    --merge                                    Merges the files in order specfied on command line
+    -o, --order                                Take any input files and renames them in numerical order
+    -p, --prepend=<prefix>                     Prefix to be prepended
+    --random                                   Randomizes the files
+    -r, --remove=<pattern>                     Pattern to be removed, can be a regex
+    -q, --quiet                                Quiet mode
+    -s, --substitute=<substitution pattern>    Substitutes a pattern (old/new, old can be a regex)
+    -t, --test                                 Test mode (Just prints the rename operations)
+    --titles=<input file with titles>          Rename the files by names in the specified input file
+    --usage                                    Detailed usage information
+    -v, --verbose                              Verbose mode
+    --version                                  Prints the version
+```
+
+## Installation
+
+```bash
+pip install chname
+```
+
+## License
+
+chname is freeware released under the [MIT License](https://github.com/scholnicks/chname/blob/main/LICENSE).
+

chname-2.1.3/README.md

@@ -0,0 +1,38 @@
+# chname
+
+chname renames files in powerful ways.
+
+```
+Usage:
+    chname [options] [<files>...]
+
+Options:
+    -a, --append=<suffix>                      Suffix to be appended
+    -d, --delimiter=<delimiter>                Specifies the delimiter for fixing numerical filenames
+    --directory=<directory>                    Destination directory [default: .]
+    -f, --fix=<maximum number of digits>       Fixes numerical file names
+    -h, --help                                 Show this help screen
+    -l, --lower                                Translates the filenames to lowercase
+    --merge                                    Merges the files in order specfied on command line
+    -o, --order                                Take any input files and renames them in numerical order
+    -p, --prepend=<prefix>                     Prefix to be prepended
+    --random                                   Randomizes the files
+    -r, --remove=<pattern>                     Pattern to be removed, can be a regex
+    -q, --quiet                                Quiet mode
+    -s, --substitute=<substitution pattern>    Substitutes a pattern (old/new, old can be a regex)
+    -t, --test                                 Test mode (Just prints the rename operations)
+    --titles=<input file with titles>          Rename the files by names in the specified input file
+    --usage                                    Detailed usage information
+    -v, --verbose                              Verbose mode
+    --version                                  Prints the version
+```
+
+## Installation
+
+```bash
+pip install chname
+```
+
+## License
+
+chname is freeware released under the [MIT License](https://github.com/scholnicks/chname/blob/main/LICENSE).

chname-2.1.3/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "chname"
+version = "2.1.3"
+description = "Renames files in powerful ways"
+authors = [
+    {name = "Steve Scholnick",email = "scholnicks@gmail.com"}
+]
+readme = "README.md"
+license="MIT"
+license-files=["LICENSE"]
+requires-python = ">=3.13"
+dependencies = [
+    "docopt-ng (>=0.9.0,<0.10.0)"
+]
+
+[project.urls]
+repository="https://github.com/scholnicks/chname"
+
+[tool.poetry]
+packages = [{include = "chname", from = "src"}]
+
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+chname = "chname.__main__:main"

chname-2.1.3/src/chname/__main__.py

@@ -0,0 +1,274 @@
+#!/usr/bin/env python -B
+# vi: set syntax=python ts=4 sw=4 sts=4 et ff=unix ai si :
+#
+# (c) Steven Scholnick <scholnicks@gmail.com>
+# The chname source code is published under a MIT license.
+
+"""
+chname: Renames files in powerful ways
+
+Usage:
+    chname [options] [<files>...]
+
+Options:
+    -a, --append=<suffix>                      Suffix to be appended
+    -d, --delimiter=<delimiter>                Specifies the delimiter for fixing numerical filenames
+    --directory=<directory>                    Destination directory [default: .]
+    -f, --fix=<maximum number of digits>       Fixes numerical file names
+    -h, --help                                 Show this help screen
+    -l, --lower                                Translates the filenames to lowercase
+    --merge                                    Merges the files in order specfied on command line
+    -o, --order                                Take any input files and fluxes them in numerical order
+    -p, --prepend=<prefix>                     Prefix to be prepended
+    --random                                   Randomizes the files
+    -r, --remove=<pattern>                     Pattern to be removed, can be a regex
+    -q, --quiet                                Quiet mode
+    -s, --substitute=<substitution pattern>    Substitutes a pattern (old/new, old can be a regex)
+    -t, --test                                 Test mode (Just prints the operations)
+    --titles=<input file with titles>          Rename the files by names in the specified input file
+    --usage                                    Detailed usage information
+    -v, --verbose                              Verbose mode
+    --version                                  Prints the version
+"""
+
+import os
+import random
+import re
+import sys
+
+from docopt import docopt
+
+
+def main():
+    """Main Method"""
+    global arguments
+    arguments = docopt(__doc__, version="chname 2.1.4")
+
+    if arguments["--test"]:
+        arguments["--verbose"] = True
+
+    flux(arguments["<files>"])
+
+
+def flux(files):
+    """Renames the specified files"""
+
+    if arguments["--usage"] or not files:
+        usage()
+
+    if arguments["--verbose"]:
+        arguments["--quiet"] = False
+        print("Renaming: {}\n".format(", ".join(files)))
+
+    if arguments["--random"]:
+        randomizeFiles(files)
+    elif arguments["--merge"]:
+        mergeFiles(files)
+    elif arguments["--titles"]:
+        nameFilesByInputFile(files)
+    elif arguments["--order"]:
+        orderFiles(files)
+    else:
+        for fileName in files:
+            performRenameOperation(fileName)
+
+    sys.exit(0)
+
+
+def nameFilesByInputFile(files):
+    """Names files by using an input text file"""
+    extension = calculateExtension(files)
+
+    with open(arguments["--titles"], "r") as fp:
+        exportFileNames = [line.strip() for line in fp if line.strip()]
+
+    if len(files) != len(exportFileNames):
+        raise SystemExit(
+            "{} filenames ({}) and files length ({}) do not match".format(
+                arguments["--titles"], len(exportFileNames), len(files)
+            )
+        )
+
+    filenameTemplate = (
+        r"{num:02d} - {filename}{extension}" if len(files) < 100 else r"{num:04d} - {filename}{extension}"
+    )
+    index = 1
+    for currentFilePath, newFileName in zip(files, exportFileNames):
+        newFilePath = os.path.join(
+            os.path.dirname(currentFilePath),
+            filenameTemplate.format(num=index, filename=newFileName, extension=extension),
+        )
+        rename_file(currentFilePath, newFilePath)
+        index += 1
+
+
+def orderFiles(files):
+    """Orders the files"""
+    filenameTemplate = r"{num:02d} - {filename}" if len(files) < 100 else r"{num:04d} - {filename}"
+
+    for index, currentFilePath in enumerate(sorted(files), 1):
+        newFilePath = os.path.join(
+            os.path.dirname(currentFilePath),
+            filenameTemplate.format(num=index, filename=os.path.basename(currentFilePath)),
+        )
+        rename_file(currentFilePath, newFilePath)
+
+
+def randomizeFiles(files):
+    """randomly shuffles a list of files with the same extension"""
+
+    # determine the extension
+    extension = calculateExtension(files)
+
+    # do the shuffle
+    random.shuffle(files)
+
+    prefix = arguments["--prepend"] if arguments["--prepend"] else "file"
+
+    # rename the files in numeric order
+    for index, filename in enumerate(files, 1):
+        new_file_name = os.path.join(
+            os.path.dirname(filename),
+            "{prefix}_{num:04d}{extension}".format(prefix=prefix, num=index, extension=extension),
+        )
+        rename_file(filename, new_file_name)
+
+
+def mergeFiles(files):
+    """reorders a set of files in order in a target directory"""
+
+    if not arguments["--directory"]:
+        raise SystemExit("--directory must be set")
+
+    # determine the extension
+    extension = calculateExtension(files)
+
+    prefix = arguments["--prepend"] if arguments["--prepend"] else "file"
+
+    # rename the files in argument specified order
+    for index, filename in enumerate(files, 1):
+        new_file_name = os.path.join(
+            arguments["--directory"], "{prefix}_{num:04d}".format(prefix=prefix, num=index) + extension
+        )
+        rename_file(filename, new_file_name)
+
+
+def calculateExtension(files):
+    """determines a single extension"""
+    extensions = set((os.path.splitext(f)[1].lower() for f in files))
+    if len(extensions) > 1:
+        raise SystemExit("Only one extension allowed. Found: {}".format(", ".join(extensions)))
+
+    return extensions.pop()
+
+
+def performRenameOperation(fileName):
+    """Performs a renaming operation on the specified filename"""
+    if not os.path.exists(fileName):
+        if not arguments["--quiet"]:
+            print("{} does not exist, skipping.".format(fileName), file=sys.stderr)
+        return
+
+    newFileName = fileName
+
+    if arguments["--lower"]:
+        newFileName = newFileName.lower()
+
+    if arguments["--append"]:
+        newFileName = newFileName + arguments["--append"]
+
+    if arguments["--prepend"]:
+        newFileName = arguments["--prepend"] + newFileName
+
+    if arguments["--remove"]:
+        newFileName = re.sub(arguments["--remove"], r"", newFileName)
+
+    if arguments["--delimiter"]:
+        if not (arguments["--delimiter"] and arguments["--fix"]):
+            raise SystemExit("--delimiter and --fix are both required")
+        newFileName = fixNumbers(newFileName, arguments["--delimiter"], arguments["--fix"])
+
+    if arguments["--substitute"]:
+        newFileName = substitute(newFileName, arguments["--substitute"])
+
+    if newFileName != fileName:
+        rename_file(fileName, newFileName)
+
+
+def rename_file(oldName, newName):
+    """Performs the actual file rename"""
+    if arguments["--verbose"]:
+        print("Renaming {} to {}".format(oldName, newName))
+
+    if not arguments["--test"]:
+        os.rename(oldName, newName)
+
+
+def substitute(fileName, pattern):
+    """Performs the pattern substitution"""
+    try:
+        (old, new) = re.match(r"^(.*)/(.*)$", pattern).groups()
+        return re.sub(old, new, fileName)
+    except AttributeError:
+        raise SystemExit("chname: Illegal substitute pattern. Pattern must be old/new")
+
+
+def fixNumbers(fileName, delimiter, numberLength):
+    """Fixes the numeric part of a filename"""
+    if delimiter not in fileName:
+        return fileName
+
+    (base, extension) = os.path.splitext(fileName)
+    (prefix, number) = base.split(delimiter, 2)
+
+    sequenceValue = number
+
+    for i in range(len(number), int(numberLength)):
+        sequenceValue = "0" + sequenceValue
+
+    return prefix + delimiter + sequenceValue + extension
+
+
+def usage():
+    print(
+        __doc__
+        + """
+
+Merge
+-----
+To merge files from two different directories into the current directory:
+
+chname --merge d1/* d2/*
+
+Input Files: d1/file1.txt d1/file2.txt d2/file1.txt
+Results: ./file_0001.txt ./file_0002.txt ./file_0003.txt
+
+where file_0003.txt is d2/file3.txt
+
+All of the files must have the same extension. The default filename format is file_NUMBER.extension. file_ can be changed
+using the --prepend option.
+
+
+Order
+-----
+
+Adds a numerical prefix to sorted input files. Example:
+
+chname --order filea.mp3 fileb.mp3
+
+becomes:
+
+01 - filea.mp3 02 - fileb.mp3
+
+Random
+------
+
+Randomly names files. --prepend can be use to specify the base filename (defaults to file)
+
+"""
+    )
+    sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()