diff --git a/.Github/Banners/ConfigInfo.png b/.Github/Banners/ConfigInfo.png deleted file mode 100644 index 64f4365..0000000 Binary files a/.Github/Banners/ConfigInfo.png and /dev/null differ diff --git a/.Github/Banners/Dependencies.png b/.Github/Banners/Dependencies.png deleted file mode 100644 index f57b957..0000000 Binary files a/.Github/Banners/Dependencies.png and /dev/null differ diff --git a/.Github/Banners/Donation.png b/.Github/Banners/Donation.png deleted file mode 100644 index 0001d98..0000000 Binary files a/.Github/Banners/Donation.png and /dev/null differ diff --git a/.Github/Banners/GlobalConf.png b/.Github/Banners/GlobalConf.png deleted file mode 100644 index daa2e41..0000000 Binary files a/.Github/Banners/GlobalConf.png and /dev/null differ diff --git a/.Github/Banners/InputDirConf.png b/.Github/Banners/InputDirConf.png deleted file mode 100644 index 71d15a5..0000000 Binary files a/.Github/Banners/InputDirConf.png and /dev/null differ diff --git a/.Github/Banners/Installation.png b/.Github/Banners/Installation.png deleted file mode 100644 index b4632ab..0000000 Binary files a/.Github/Banners/Installation.png and /dev/null differ diff --git a/.Github/Banners/Main.png b/.Github/Banners/Main.png deleted file mode 100644 index ee35f5c..0000000 Binary files a/.Github/Banners/Main.png and /dev/null differ diff --git a/.Github/Banners/OutputDirConf.png b/.Github/Banners/OutputDirConf.png deleted file mode 100644 index 3e489a5..0000000 Binary files a/.Github/Banners/OutputDirConf.png and /dev/null differ diff --git a/.Github/Banners/SaraSortd.png b/.Github/Banners/SaraSortd.png deleted file mode 100644 index 294ed5b..0000000 Binary files a/.Github/Banners/SaraSortd.png and /dev/null differ diff --git a/.Github/Banners/Usage.png b/.Github/Banners/Usage.png deleted file mode 100644 index 9c2d447..0000000 Binary files a/.Github/Banners/Usage.png and /dev/null differ diff --git a/.Github/Icons/Main.png b/.Github/Icons/Main.png deleted file mode 100755 index 389a60a..0000000 Binary files a/.Github/Icons/Main.png and /dev/null differ diff --git a/.Github/Icons/Small.png b/.Github/Icons/Small.png deleted file mode 100755 index af8b9de..0000000 Binary files a/.Github/Icons/Small.png and /dev/null differ diff --git a/GlobalConf.toml b/GlobalConf.toml index 37229f1..f4dfd59 100644 --- a/GlobalConf.toml +++ b/GlobalConf.toml @@ -1,5 +1,5 @@ Title = "SaraSortd Config" -Version = "6.2" +Version = "6.3" SafeMode = 1 SilentMode = 0 CheckInput = 5 @@ -22,7 +22,7 @@ Second = "[s]" VarCall = "%%" [DirectoryPaths] -RootDir = "C:/Users/StigOscarAadalen-Aas/OneDrive - Telemark fylkeskommune/Desktop/Testdir" +RootDir = "Unset" InputDir = [ "%RootDir%/Input" ] OutputDir = [ "%RootDir%/Output" ] LogDir = "%RootDir%/.Logs" diff --git a/InputDirConf.toml b/InputDirConf.toml index 0b51cfa..5567027 100644 --- a/InputDirConf.toml +++ b/InputDirConf.toml @@ -1,5 +1,5 @@ Title = "Unset" -Version = "6.2" +Version = "6.3" ParentDir = "Unset" SortDirs = 0 diff --git a/.Github/LICENSE b/LICENSE similarity index 100% rename from .Github/LICENSE rename to LICENSE diff --git a/OutputDirConf.toml b/OutputDirConf.toml index 8685716..9354b09 100644 --- a/OutputDirConf.toml +++ b/OutputDirConf.toml @@ -1,5 +1,5 @@ Title = "Unset" -Version = "6.2" +Version = "6.3" LastFile = "Unset" ParentDir = "Unset" ValidInputDirs = ["*"] diff --git a/.Github/README.md b/README.md similarity index 83% rename from .Github/README.md rename to README.md index e4fd0af..b395749 100644 --- a/.Github/README.md +++ b/README.md @@ -1,17 +1,17 @@ -SaraSortd: a file and directory sorting daemon built with python. +SaraSortd: a file and directory sorting daemon built with python. ---- - -(Version = "6.2") +(Version = "6.3") It's made by Sarah, hence the name. :3 If the first number in the version goes up, it means that old config files will not work with the new SaraSortd.py. - If the second number in the version goes up, something new got added, but your old config files will still work just fine. -Usage +--- + +Usage + SaraSortd is for people who don't want to manually sort files, people who want to organise files, and people who want an automatic naming standard for their files. @@ -23,33 +23,42 @@ Example use-cases: - Regularly cloning important files into a backup directory. -Dependencies +--- + +Dependencies + python toml: Use ```pip install toml``` to install toml. +--- -Installation +Installation + + +Here's an [installation video](https://youtu.be/QkMZVSJ-PLQ?si=Nd20jDyHT7CN6Ztb) on Linux. -Here's an [installation video](https://youtu.be/ZMIaOhZA0kE). Here's a step-by-step tutorial (in case you don't want to watch the video). -1. Install ZIP-file. +1. Install ZIP-file by clicking the green "Code" button on the top right, then clicking "Download Zip". 2. Unzip ZIP-file wherever you want the program to live. -3. Navigate to the new SaraSortd directory in your terminal. -4. Edit your config files to your liking. +3. Edit your config files to your liking. Make sure to edit your paths! (E.G. RootDir = "/home/janedoe/Programs/SaraSortd") +4. Navigate to the new SaraSortd directory in your terminal (CMD / PowerShell on Windows). 5. Run ```python SaraSortd.py``` to run the program. (This will make new directories for you.) -6. Edit your output directories' configs. +6. Edit your new output directories' configs. -Config Info +--- + +Config Info + +GlobalConf -GlobalConf ``` Title = "SaraSortd Config" # NOTE: Do not change the title. This is so that the program knows which config file is which. -Version = "6.2" # Just the version number for the config file. +Version = "6.3" # Just the version number for the config file. SafeMode = 1 # If SaraSortd should stop if an error with the config appears. 1 is stop, 0 is continue. @@ -139,16 +148,17 @@ Unzipping = "Unzipping: %%." # When a directory gets unzipped. NoPermission = "Error: No permission to %%." # When SaraSortd lacks permission to do something. # %% is the action that the program had no permission to do. E.G. "remove directory /home/bob/exampledir". ``` +--- +OutputDirConf -OutputDirConf The output directory config references the SaraSortd config (GlobalConf.toml). This means that you can, for example, use the character assigned to "NextNum" in GlobalConf.toml in this config (OutputDirConf.toml). This applies to all Variables in the SaraSortd config (GlobalConf.toml). ``` Title = "Unset" # NOTE: Do not change the title. This is so that the program knows which config file is which. -Version = "6.2" # The version number of the config. +Version = "6.3" # The version number of the config. LastFile = "Unset" # The last file that was sorted to this directory. It gets automatically updated whenever a file gets sorted to this directory. @@ -191,16 +201,19 @@ CaseSensitive = 0 # Whether this "Pattern" is case-sensitive or not. 1 is yes, 0 Overwrite = 1 # Whether this specific file type can be overwritten by others of the same type. 0 is no, 1 is yes. ``` -InputDirConf +--- + +InputDirConf + ``` Title = "Unset" # NOTE: Do not change the title. This is so that the program knows which config file is which. -Version = "6.2" +Version = "6.3" ParentDir = "Unset" # The name of this directory. It gets automatically updated when this config gets copied to an output directory. -SortDirs = 0 +SortDirs = 0 # If the input directory should be allowed to sort directories within it. (Currently needs admin privileges to delete the original directory after sorting it). [[Files]] # The double brackets means that you can add multiple types of files to be sorted here. Just copy [[Files]] and all the parameters under it, and paste it under or over this section, then you may change the values of the new parameters. @@ -208,3 +221,5 @@ Pattern = "*" # A pattern used to decide if a file should be sorted or not. * is CaseSensitive = 0 # Whether Pattern is case-sensitive or not. If CaseSensitive = 1 and your pattern is "*.PNG", then a file named "example.png" won't be sorted. ``` + +--- diff --git a/SaraSortd.py b/SaraSortd.py index 9e66d28..8251f42 100644 --- a/SaraSortd.py +++ b/SaraSortd.py @@ -6,7 +6,7 @@ import shutil import time import toml -# Version = "6.2" +# Version = "6.3" ConfPath = "./GlobalConf.toml"