Initial upload

LICENSE.md

@@ -0,0 +1,27 @@
+# License
+
+***Nomen*** - Multi-purpose rename tool
+
+Copyright © 2018 by Ralf Kilian
+
+Distributed under the *MIT License*:
+
+```
+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.
+```

README.md

@@ -0,0 +1,61 @@
+# *Nomen* <img src="nomen.png" alt="Nomen logo" height="48px" width="48px" align="right"/>
+
+**Table of contents**
+*   [Definition](#definition)
+*   [Details](#details)
+*   [Requirements](#requirements)
+*   [Documentation](#documentation)
+*   [Useless facts](#useless-facts)
+
+----
+
+## Definition
+
+The *Nomen* project is a multi-purpose rename tool to consistently rename the base name as well as the extension of files in a variety of ways and also to remove unnecessary whitespaces from directory names.
+
+[Top](#nomen-)
+
+## Details
+
+Basically, *Nomen* allows to consistently rename the base name as well as the extension of files and to remove unnecessary whitespaces from directory names.
+
+For now, it is capable of the following, briefly stated:
+
+*   Convert the case of the base name (prefix or stem) of files.
+*   Convert the case of the extension (suffix) of files.
+*   Adjust differently spelled extensions from files of the same file type.
+*   Rename base names based on the name of the directory where the files are stored in.
+*   Modify base names by adding, removing or replacing certain strings.
+*   Remove leading, trailing and duplicate whitespaces from directory names.
+
+It also comes with an integrated simulation mode that simulates the rename process and writes the details into a report file. This allows checking which files would have been renamed.
+
+The project also consists of [multiple components](../../wiki#components).
+
+Please be sure to read [this](../../wiki#important-notice) before using *Nomen*.
+
+[Top](#nomen-)
+
+## Requirements
+
+In order to use *Nomen*, the *Python* framework must be installed on the system.
+
+Depending on which version of the framework you are using:
+
+*   *Python* 2.x (version 2.7 or higher is recommended, may also work with earlier versions)
+*   *Python* 3.x (version 3.2 or higher is recommended, may also work with earlier versions)
+
+[Top](#nomen-)
+
+## Documentation
+
+In the corresponding `docs` sub-directories, there are plain text files containing a detailed documentation for each component with further information and usage examples.
+
+[Top](#nomen-)
+
+## Useless facts
+
+Whoever cares can find them [here](../../wiki#useless-facts).
+
+[Top](#nomen-)
+

python2/cfg/sample_lower.cfg

@@ -0,0 +1,67 @@
+##############################################################################
+#                                                                            #
+#  Nomen sample configuration file for strings that should ALWAYS be         #
+#  LOWERCASE when converting the case of file names.                         #
+#                                                                            #
+#  This will NOT convert the case of the file extension. For renaming the    #
+#  extension, you may use the Nomen Extention Case Converter script.         #
+#                                                                            #
+#  One string per line, empty and commented out lines (like this header)     #
+#  will be ignored.                                                          #
+#                                                                            #
+#  Please read the documentation before using any component of Nomen.        #
+#                                                                            #
+##############################################################################
+
+# Example 1:
+#
+#   The word "foo" shall always be lowercase in file names.
+#
+#       FOOBAR.TXT      =>  file will NOT be renamed (because "FOO" is not a
+#                           separate word)
+#       FOO BAR.TXT     =>  file will be renamed to "foo BAR.txt"
+#
+foo
+
+# Example 2:
+#
+#   The string "foo" shall always be lowercase in file names.
+#
+#       FOOBAR.TXT      =>  file will be renamed to "fooBAR.txt"
+#       FOO BAR.TXT     =>  file will be renamed to "foo BAR.txt"
+#
+$(foo)
+
+# Example 3:
+#
+#   The string "bar" shall always be lowercase in file names.
+#
+#       FOOBAR.TXT      =>  file will be renamed to "FOObar.txt"
+#       FOO BAR.TXT     =>  file will be renamed to "FOO bar.txt"
+#
+$(bar)
+
+# Example 4:
+#
+#   When converting the case of the files
+#
+#       FOOBAR'S ADVENTURE.TXT
+#       MARTIN O'SULLIVAN.TXT
+#
+#   using title case, the file will be renamed as follows:
+#
+#       Foobar'S Adventure.TXT
+#       Martin O'Sullivan.TXT
+#
+#   So, if you want to convert the "'S" to lowercase, you could use
+#
+#       $('s)
+#
+#   but this will also rename "O'Sullivan" to "O'sullivan". To avoid this you
+#   may use the following statement. It only converts "'S" to lowercase if a
+#   whitespace follows.
+#
+$('s )
+
+# EOF
+

python2/cfg/sample_mixed.cfg

@@ -0,0 +1,67 @@
+##############################################################################
+#                                                                            #
+#  Nomen sample configuration file for strings that should ALWAYS be MIXED   #
+#  CASE when converting the case of file names.                              #
+#                                                                            #
+#  This will NOT convert the case of the file extension. For renaming the    #
+#  extension, you may use the Nomen Extention Case Converter script.         #
+#                                                                            #
+#  One string per line, empty and commented out lines (like this header)     #
+#  will be ignored.                                                          #
+#                                                                            #
+#  Please read the documentation before using any component of Nomen.        #
+#                                                                            #
+##############################################################################
+
+# Example 1:
+#
+#   The word "FoO" shall always be mixed case in file names.
+#
+#       FOOBAR.TXT      =>  file will NOT be renamed (because "FOO" is not a
+#                           separate word)
+#       FOO BAR.TXT     =>  file will be renamed to "FoO BAR.txt"
+#
+FoO
+
+# Example 2:
+#
+#   The string "FoO" shall always be mixed case in file names.
+#
+#       FOOBAR.TXT      =>  file will be renamed to "FoOBAR.txt"
+#       FOO BAR.TXT     =>  file will be renamed to "FoO BAR.txt"
+#
+$(FoO)
+
+# Example 3:
+#
+#   The string "bAr" shall always be mixed case in file names.
+#
+#       FOOBAR.TXT      =>  file will be renamed to "FOObAr.txt"
+#       FOO BAR.TXT     =>  file will be renamed to "FOO bAr.txt"
+#
+$(bAr)
+
+# Example 4:
+#
+#   When converting the case of the files
+#
+#       FOOBAR'S ADVENTURE.TXT
+#       MARTIN O'SULLIVAN.TXT
+#
+#   using title case, the file will be renamed as follows:
+#
+#       Foobar'S Adventure.TXT
+#       Martin O'Sullivan.TXT
+#
+#   So, if you want to convert the "'S" to lowercase, you could use
+#
+#       $('s)
+#
+#   but this will also rename "O'Sullivan" to "O'sullivan". To avoid this you
+#   may use the following statement. It only converts "'S" to lowercase if a
+#   whitespace follows.
+#
+$('s )
+
+# EOF
+

python2/cfg/sample_title.cfg

@@ -0,0 +1,45 @@
+##############################################################################
+#                                                                            #
+#  Nomen sample configuration file for strings that should ALWAYS be TITLE   #
+#  CASE when converting the case of file names.                              #
+#                                                                            #
+#  This will NOT convert the case of the file extension. For renaming the    #
+#  extension, you may use the Nomen Extention Case Converter script.         #
+#                                                                            #
+#  One string per line, empty and commented out lines (like this header)     #
+#  will be ignored.                                                          #
+#                                                                            #
+#  Please read the documentation before using any component of Nomen.        #
+#                                                                            #
+##############################################################################
+
+# Example 1:
+#
+#   The word "Foo" shall always be title case in file names.
+#
+#       FOOBAR.TXT      =>  file will NOT be renamed (because "FOO" is not a
+#                           separate word)
+#       FOO BAR.TXT     =>  file will be renamed to "Foo BAR.txt"
+#
+Foo
+
+# Example 2:
+#
+#   The string "Foo" shall always be title case in file names.
+#
+#       FOOBAR.TXT      =>  file will be renamed to "FooBAR.txt"
+#       FOO BAR.TXT     =>  file will be renamed to "Foo BAR.txt"
+#
+$(Foo)
+
+# Example 3:
+#
+#   The string "Foo" shall always be title case in file names.
+#
+#       FOOBAR.TXT      =>  file will be renamed to "FOOBar.txt"
+#       FOO BAR.TXT     =>  file will be renamed to "FOO Bar.txt"
+#
+$(Bar)
+
+# EOF
+

python2/cfg/sample_upper.cfg

@@ -0,0 +1,45 @@
+##############################################################################
+#                                                                            #
+#  Nomen sample configuration file for strings that should ALWAYS be         #
+#  UPPERCASE when converting the case of file names.                         #
+#                                                                            #
+#  This will NOT convert the case of the file extension. For renaming the    #
+#  extension, you may use the Nomen Extention Case Converter script.         #
+#                                                                            #
+#  One string per line, empty and commented out lines (like this header)     #
+#  will be ignored.                                                          #
+#                                                                            #
+#  Please read the documentation before using any component of Nomen.        #
+#                                                                            #
+##############################################################################
+
+# Example 1:
+#
+#   The word "FOO" shall always be uppercase in file names.
+#
+#       foobar.txt      =>  file will NOT be renamed (because "foo" is not a
+#                           separate word)
+#       foo bar.txt     =>  file will be renamed to "FOO bar.txt"
+#
+FOO
+
+# Example 2:
+#
+#   The string "FOO" shall always be uppercase in file names.
+#
+#       foobar.txt      =>  file will be renamed to "FOObar.txt"
+#       foo bar.txt     =>  file will be renamed to "FOO bar.txt"
+#
+$(FOO)
+
+# Example 3:
+#
+#   The string "BAR" shall always be uppercase in file names.
+#
+#       foobar.txt      =>  file will be renamed to "fooBAR.txt"
+#       foo bar.txt     =>  file will be renamed to "foo BAR.txt"
+#
+$(BAR)
+
+# EOF
+