Release 2.0.3: command name change used to be undocumented

Author: DomCie

CHANGELOG.md

@@ -13,6 +13,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Modify names of output files
 * Standalone GUI client
 
+## [2.0.3] - 2021-03-27
+
+### Added
+
+* Command can now be invoked with either ``d2f2`` or ``D2F2``
+
+### Fixed
+
+* Command name change was undocumented
+
 ## [2.0.2] - 2021-03-26
 
 ### Removed
@@ -84,7 +94,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.0.2...HEAD
+[Unreleased]: https://github.com/DomCie/D2F2/compare/v2.0.3...HEAD
+[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
 [2.0.1]: https://github.com/DomCie/D2F2/compare/v2.0.0...v2.0.1
 [2.0.0]: https://github.com/DomCie/D2F2/compare/v1.2.1...v2.0.0

D2F2/CONFIGURATIONS.py

@@ -1,3 +1,3 @@
 MODULE_NAME = "D2F2"
-VERSION = "2.0.2"
+VERSION = "2.0.3"
 AUTHOR = "DomCie"

D2F2/__main__.py

@@ -1,4 +1,3 @@
-from D2F2.CONFIGURATIONS import *
 from D2F2.convert import *
 
 import D2F2.shell as shell
@@ -7,11 +6,10 @@
 import sys
 
 
-def main(argv=None) -> int:
-    if argv is None:
-        argv = sys.argv[1:]
+def main() -> int:
+    argv = sys.argv
 
-    help_msg = f"{MODULE_NAME} [OPTIONS] PATH [PATH...]\nConvert image folders into files\n\nOPTIONS:\n-H, " \
+    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] " \
                f"Portable Document Format (default)\n\t\t\t\t\t\t\t\t[CBZ] Comic Book Format, " \
@@ -22,7 +20,7 @@ def main(argv=None) -> int:
                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, '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
@@ -89,4 +87,4 @@ def main(argv=None) -> int:
 
 
 if __name__ == "__main__":
-    sys.exit(main(sys.argv[1:]))
+    sys.exit(main())

README.md

@@ -1,4 +1,4 @@
-# D2F2 2.0.2
+# D2F2 2.0.3
 
 D2F2 (formerly _DIRtoPDF_) is a tool written in Python to convert image folders into files.
 
@@ -14,6 +14,8 @@ or use one of the standalone versions (see below).
 
 ## Usage
 
+Please note: ``d2f2`` and ``D2F2`` are interchangeable.
+
 ### Operation modes
 
 D2F2 offers two modes of operation: "single" and "batch".
@@ -23,23 +25,23 @@ D2F2 offers two modes of operation: "single" and "batch".
 The standard mode, converts each given directory into a file.
 
 ```commandline
-D2F2 /a/path /another/path ...
+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:
 
 ```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:
 
 ```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:
@@ -52,15 +54,15 @@ Currently, there are 2 supported formats (with more to be added in the future).
 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:
 
 ```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:
@@ -81,7 +83,7 @@ Standalone versions for the shell are available for Windows and Linux (see [Rele
 You can also start the shell from the command line:
 
 ```commandline
-D2F2 --shell
+d2f2 --shell
 ```
 
 ## TODO

setup.cfg

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