Release 2.1.2

.gitignore

@@ -1,6 +1,6 @@
 /.idea/
-/D2F.egg-info/
+/d2f2.egg-info/
 /build/
 /dist/
 /Pipfile
-/Pipfile.lock
+/Pipfile.lock

CHANGELOG.md

@@ -13,6 +13,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Modify names of output files
 * Standalone GUI client
 
+## [2.1.2] - 2021-09-20
+
+### Changed
+
+* Command can now only be invoked with ``d2f2``
+* Option flags are now all lowercase
+
 ## [2.1.0] - 2021-04-16
 
 ### Changed
@@ -100,7 +107,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Core functionality: convert image folders into PDF files over CLI
 * "Multiple" mode for converting batches of folders more easily
 
-[Unreleased]: https://github.com/DomCie/D2F2/compare/v2.1.0...HEAD
+[Unreleased]: https://github.com/DomCie/D2F2/compare/v2.1.2...HEAD
+[2.1.2]: https://github.com/DomCie/D2F2/compare/v2.1.0...v2.1.2
 [2.1.0]: https://github.com/DomCie/D2F2/compare/v2.0.3...v2.1.0
 [2.0.3]: https://github.com/DomCie/D2F2/compare/v2.0.2...v2.0.3
 [2.0.2]: https://github.com/DomCie/D2F2/compare/v2.0.1...v2.0.2

README.md

@@ -1,4 +1,4 @@
-# d2f2 2.1.0
+# d2f2 2.1.2
 
 *d2f2* is a tool written in Python to convert image folders into files.
 
@@ -28,18 +28,18 @@ d2f2 /a/path /another/path ...
 
 #### Batch mode
 
-Useful for converting big batches of folders, this mode converts each subdirectory within the given directories into a file. To use it, add the ``-B``/``--batch`` option to the command:
+Useful for converting big batches of folders, this mode converts each subdirectory within the given directories into a file. To use it, add the ``-b``/``--batch`` option to the command:
 
 ```commandline
-d2f2 -B /a/path /another/path ...
+d2f2 -b /a/path /another/path ...
 ```
 
 ### Output format
 
-By default, *d2f2* saves files in the PDF format. If you want to use another supported format, use the ``-F``/``--format`` option:
+By default, *d2f2* saves files in the PDF format. If you want to use another supported format, use the ``-f``/``--format`` option:
 
 ```commandline
-d2f2 /a/path ... -F FORMAT
+d2f2 /a/path ... -f FORMAT
 ```
 
 Currently, there are 2 supported formats (with more to be added in the future). Use the appropriate format as the FORMAT parameter:
@@ -49,18 +49,18 @@ Currently, there are 2 supported formats (with more to be added in the future).
 
 ### Output path
 
-By standard, *d2f2* saves files to the current directory. If you want another output path, use the ``-O``/``--output`` option:
+By standard, *d2f2* saves files to the current directory. If you want another output path, use the ``-o``/``--output`` option:
 
 ```commandline
-d2f2 /a/path ... -O /an/output/path 
+d2f2 /a/path ... -o /an/output/path 
 ```
 
 ### Sorting mode
 
-By default, *d2f2* sorts the images in alphanumeric, ascending order (A-Z). If you want to use another sorting mode you can specify one by using the ``-S``/``--sort`` option:
+By default, *d2f2* sorts the images in alphanumeric, ascending order (A-Z). If you want to use another sorting mode you can specify one by using the ``-s``/``--sort`` option:
 
 ```commandline
-d2f2 /a/path ... -S MODE
+d2f2 /a/path ... -s MODE
 ```
 
 Currently, there are 6 sorting modes available. Use the corresponding number from the following list as the MODE parameter:
@@ -93,4 +93,4 @@ d2f2 --shell
 
 ## Disclaimer
 
-This tool uses the [PyMuPDF](https://github.com/pymupdf/PyMuPDF) library, which provides the core functionality of inserting images into PDF files. According to its licensing terms, this project is released under the AGPLv3 license (for more information, see LICENSE)
+This tool uses the [PyMuPDF](https://github.com/pymupdf/PyMuPDF) library, which provides the core functionality of inserting images into PDF files. According to its licensing terms, this project is released under the AGPLv3 license (for more information, see LICENSE)

d2f2/CONFIGURATIONS.py

@@ -1,3 +1,3 @@
 MODULE_NAME = "d2f2"
-VERSION = "2.1.0"
+VERSION = "2.1.2"
 AUTHOR = "DomCie"

d2f2/__main__.py

@@ -1,3 +1,4 @@
+from d2f2.CONFIGURATIONS import *
 from d2f2.convert import *
 
 import d2f2.shell as shell
@@ -9,18 +10,18 @@
 def main() -> int:
     argv = sys.argv
 
-    help_msg = f"{argv[0]} [OPTIONS] PATH [PATH...]\nConvert image folders into files\n\nOPTIONS:\n-H, " \
-               f"--help\t\t\t\tShow this help\n-B, --batch\t\t\t\tConvert each subfolder of PATH to a " \
-               f"file\n-F, --format FORMAT\t\t\tSpecify an output format\n\t\t\t\t\tAVAILABLE FORMATS:\t[PDF] " \
+    help_msg = f"{MODULE_NAME} [OPTIONS] PATH [PATH...]\nConvert image folders into files\n\nOPTIONS:\n-h, " \
+               f"--help\t\t\t\tShow this help\n-b, --batch\t\t\t\tConvert each subfolder of PATH to a " \
+               f"file\n-f, --format FORMAT\t\t\tSpecify an output format\n\t\t\t\t\tAVAILABLE FORMATS:\t[PDF] " \
                f"Portable Document Format (default)\n\t\t\t\t\t\t\t\t[CBZ] Comic Book Format, " \
-               f"ZIP-compressed\n--shell\t\t\t\t\tOpen interactive shell\n-S, --sort MODE\t\t\t\tSpecify a sorting " \
+               f"ZIP-compressed\n--shell\t\t\t\t\tOpen interactive shell\n-s, --sort MODE\t\t\t\tSpecify a sorting " \
                f"mode\n\t\t\t\t\tAVAILABLE MODES:\t[ 1] A-Z (default)\n\t\t\t\t\t\t\t\t[-1] Z-A\n\t\t\t\t\t\t\t\t" \
                f"[ 2] Last time modified, oldest first\n\t\t\t\t\t\t\t\t[-2] Last time modified, " \
                f"newest first\n\t\t\t\t\t\t\t\t[ 3] Time of creation / metadata change, " \
-               f"oldest first\n\t\t\t\t\t\t\t\t[-3] Time of creation / metadata change, newest first\n-O, --output " \
+               f"oldest first\n\t\t\t\t\t\t\t\t[-3] Time of creation / metadata change, newest first\n-o, --output " \
                f"OUTPUT_PATH\t\tSave files to OUTPUT_PATH (default: current directory)"
     try:
-        opts, args = getopt.getopt(argv[1:], 'BF:HO:S:', ['batch', 'format=', 'help', 'output=', 'shell', 'sort='])
+        opts, args = getopt.getopt(argv[1:], 'bf:ho:s:', ['batch', 'format=', 'help', 'output=', 'shell', 'sort='])
     except getopt.GetoptError:
         print(help_msg)
         return 2
@@ -31,9 +32,9 @@ def main() -> int:
     sorting_mode = 1
 
     for opt, par in opts:
-        if opt in ('-B', '--batch'):
+        if opt in ('-b', '--batch'):
             is_batch = True
-        elif opt in ('-F', '--format'):
+        elif opt in ('-f', '--format'):
             if par in ('PDF', 'CBZ'):
                 converter = ConverterFactory.create(par)
             elif par == '':
@@ -42,10 +43,10 @@ def main() -> int:
             else:
                 print(f"error: {par} isn't a valid output format", file=sys.stderr)
                 return 2
-        elif opt in ('-H', '--help'):
+        elif opt in ('-h', '--help'):
             print(help_msg)
             return 0
-        elif opt in ('-O', '--output'):
+        elif opt in ('-o', '--output'):
             if os.path.exists(par):
                 output_path = par
             elif par == '':
@@ -57,7 +58,7 @@ def main() -> int:
         elif opt == '--shell':
             shell.start()
             return 0
-        elif opt in ('-S', '--sort'):
+        elif opt in ('-s', '--sort'):
             if par in ('1', '-1', '2', '-2', '3', '-3'):
                 sorting_mode = int(par)
             elif par == '':

d2f2/convert.py

@@ -53,15 +53,16 @@ def single(self, input_path: str, output_path=os.getcwd(), sorting_mode=1) -> No
         """
 
         entries = list(filter(lambda x: x.is_file(), self.sorted_entries(os.scandir(input_path), sorting_mode)))
+        len_entries = len(entries)
 
         if input_path[-1] in ('/', '\\'):
             input_path = input_path[:-1]
 
-        if len(entries) > 0:
+        if len_entries > 0:
             doc_name = os.path.basename(input_path) + self.file_extension
             self.convert(entries, doc_name, output_path)
         else:
-            print(f"\nskipping {os.path.basename(input_path)}, empty directory...")
+            print(f"skipping {os.path.basename(input_path)}, empty directory...")
 
     def batch(self, input_path: str, output_path=os.getcwd(), sorting_mode=1) -> None:
         """Converts each subdirectory of a directory into a file.
@@ -113,7 +114,7 @@ def convert(self, entries: list, doc_name: str, output_path: str) -> None:
 
             doc.save(os.path.join(output_path, doc_name))
 
-        print(f"\n\"{doc_name}\" saved to {output_path}")
+        print(f"\"{doc_name}\" saved to {output_path}")
 
 
 class CBZConverter(Converter):
@@ -128,7 +129,7 @@ def convert(self, entries: list, doc_name: str, output_path: str) -> None:
                 suffix = pathlib.Path(e.path).suffix
                 zf.write(e.path, f"{i + 1}{suffix}", compress_type=zipfile.ZIP_DEFLATED)
 
-        print(f"\n\"{doc_name}\" saved to {output_path}")
+        print(f"\"{doc_name}\" saved to {output_path}")
 
 
 class ConverterFactory:

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = d2f2
-version = 2.1.0
+version = 2.1.2
 author = DomCie
 author_email = dev@domcie.net
 description = Tool to convert image folders into files
@@ -20,4 +20,4 @@ install_requires =
 
 [options.entry_points]
 console_scripts =
-    d2f2 = D2F2:main
+    d2f2 = d2f2:main