chname 2.1.5__tar.gz → 2.1.6__tar.gz

{chname-2.1.5 → chname-2.1.6}/PKG-INFO

@@ -1,16 +1,22 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: chname
-Version: 2.1.5
+Version: 2.1.6
 Summary: Renames files in powerful ways
-License: MIT
+License-Expression: MIT
+License-File: LICENSE
+Keywords: rename,file,batch,bulk,utility,command-line,cli
 Author: Steve Scholnick
 Author-email: scholnicks@gmail.com
 Requires-Python: >=3.13
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Utilities
 Requires-Dist: docopt-ng (>=0.9.0,<0.10.0)
-Project-URL: Repository, https://github.com/scholnicks/chname
+Project-URL: Homepage, https://pypi.org/project/chname/
+Project-URL: Issues, https://github.com/scholnicks/chname/issues
+Project-URL: Repository, https://github.com/scholnicks/chname/
 Description-Content-Type: text/markdown
 
 # chname

{chname-2.1.5 → chname-2.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "chname"
-version = "2.1.5"
+version = "2.1.6"
 description = "Renames files in powerful ways"
 authors = [
     {name = "Steve Scholnick",email = "scholnicks@gmail.com"}
@@ -12,14 +12,23 @@ requires-python = ">=3.13"
 dependencies = [
     "docopt-ng (>=0.9.0,<0.10.0)"
 ]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: MIT License",
+    "Topic :: Utilities"
+]
+keywords = ["rename", "file", "batch", "bulk", "utility", "command-line", "cli"]
 
 [project.urls]
-repository="https://github.com/scholnicks/chname"
+homepage="https://pypi.org/project/chname/"
+repository="https://github.com/scholnicks/chname/"
+Issues = "https://github.com/scholnicks/chname/issues"
 
 [tool.poetry]
 packages = [{include = "chname", from = "src"}]
 
-
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"

{chname-2.1.5 → chname-2.1.6}/src/chname/__main__.py

@@ -38,12 +38,13 @@ import sys
 
 from docopt import docopt
 
-arguments = {}
+arguments: dict = {}
 
-def main():
+
+def main() -> None:
     """Main Method"""
     global arguments
-    arguments = docopt(__doc__, version="chname 2.1.5")
+    arguments = docopt(__doc__, version="chname 2.1.6")
 
     if arguments["--test"]:
         arguments["--verbose"] = True
@@ -51,7 +52,7 @@ def main():
     flux(arguments["<files>"])
 
 
-def flux(files):
+def flux(files: list[str]) -> None:
     """Renames the specified files"""
 
     if arguments["--usage"] or not files:
@@ -76,9 +77,9 @@ def flux(files):
     sys.exit(0)
 
 
-def nameFilesByInputFile(files):
+def nameFilesByInputFile(files) -> None:
     """Names files by using an input text file"""
-    extension = calculateExtension(files)
+    extension: str = calculateExtension(files)
 
     with open(arguments["--titles"], "r") as fp:
         exportFileNames = [line.strip() for line in fp if line.strip()]
@@ -90,12 +91,12 @@ def nameFilesByInputFile(files):
             )
         )
 
-    filenameTemplate = (
+    filenameTemplate: str = (
         r"{num:02d} - {filename}{extension}" if len(files) < 100 else r"{num:04d} - {filename}{extension}"
     )
-    index = 1
+    index: int = 1
     for currentFilePath, newFileName in zip(files, exportFileNames):
-        newFilePath = os.path.join(
+        newFilePath: str = os.path.join(
             os.path.dirname(currentFilePath),
             filenameTemplate.format(num=index, filename=newFileName, extension=extension),
         )
@@ -103,48 +104,48 @@ def nameFilesByInputFile(files):
         index += 1
 
 
-def orderFiles(files):
+def orderFiles(files) -> None:
     """Orders the files"""
-    filenameTemplate = r"{num:02d} - {filename}" if len(files) < 100 else r"{num:04d} - {filename}"
+    filenameTemplate: str = 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(
+        newFilePath: str = os.path.join(
             os.path.dirname(currentFilePath),
             filenameTemplate.format(num=index, filename=os.path.basename(currentFilePath)),
         )
         rename_file(currentFilePath, newFilePath)
 
 
-def randomizeFiles(files):
+def randomizeFiles(files) -> None:
     """randomly shuffles a list of files with the same extension"""
 
     # determine the extension
-    extension = calculateExtension(files)
+    extension: str = calculateExtension(files)
 
     # do the shuffle
     random.shuffle(files)
 
-    prefix = arguments["--prepend"] if arguments["--prepend"] else "file"
+    prefix: str = 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(
+        new_file_name: str = 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):
+def mergeFiles(files) -> None:
     """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)
+    extension: str = calculateExtension(files)
 
-    prefix = arguments["--prepend"] if arguments["--prepend"] else "file"
+    prefix: str = arguments["--prepend"] if arguments["--prepend"] else "file"
 
     # rename the files in argument specified order
     for index, filename in enumerate(files, 1):
@@ -154,23 +155,23 @@ def mergeFiles(files):
         rename_file(filename, new_file_name)
 
 
-def calculateExtension(files):
+def calculateExtension(files) -> str:
     """determines a single extension"""
-    extensions = set((os.path.splitext(f)[1].lower() for f in files))
+    extensions: set[str] = 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):
+def performRenameOperation(fileName) -> None:
     """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
+    newFileName: str = fileName
 
     if arguments["--lower"]:
         newFileName = newFileName.lower()
@@ -196,7 +197,7 @@ def performRenameOperation(fileName):
         rename_file(fileName, newFileName)
 
 
-def rename_file(oldName, newName):
+def rename_file(oldName, newName) -> None:
     """Performs the actual file rename"""
     if arguments["--verbose"]:
         print("Renaming {} to {}".format(oldName, newName))
@@ -205,7 +206,7 @@ def rename_file(oldName, newName):
         os.rename(oldName, newName)
 
 
-def substitute(fileName, pattern):
+def substitute(fileName, pattern) -> str:
     """Performs the pattern substitution"""
     try:
         (old, new) = re.match(r"^(.*)/(.*)$", pattern).groups()
@@ -214,7 +215,7 @@ def substitute(fileName, pattern):
         raise SystemExit("chname: Illegal substitute pattern. Pattern must be old/new")
 
 
-def fixNumbers(fileName, delimiter, numberLength):
+def fixNumbers(fileName, delimiter, numberLength) -> str:
     """Fixes the numeric part of a filename"""
     if delimiter not in fileName:
         return fileName
@@ -222,7 +223,7 @@ def fixNumbers(fileName, delimiter, numberLength):
     (base, extension) = os.path.splitext(fileName)
     (prefix, number) = base.split(delimiter, 2)
 
-    sequenceValue = number
+    sequenceValue: str = number
 
     for i in range(len(number), int(numberLength)):
         sequenceValue = "0" + sequenceValue
@@ -230,7 +231,7 @@ def fixNumbers(fileName, delimiter, numberLength):
     return prefix + delimiter + sequenceValue + extension
 
 
-def usage():
+def usage() -> None:
     print(
         __doc__
         + """