feat(pip): improvements before the release

Author: Mte90

SyntaxAutoFix/.gitignore renamed to .gitignore

@@ -4,32 +4,44 @@ An easy solution to fix typos!
 
 Check the `words` folder for the languages available.
 
-## Required Installation
+## Installation
 ```
 pip3 install keyboard
+pip3 install syntaxautofix
 ```
 For the UI is required PyQt5.
 
 ## How to use with Target Language(s)
 - For English only
 ```
-syntaxalert.py -words ./words/en.json
+syntaxautofix -words ./words/en.json
 ```
 
 - For Italian/English/Spanish (or without parameters is the same):  
 ```
-syntaxalert.py -words ./words/en.json -words2 ./words/it.json
+syntaxautofix -words ./words/en.json -words2 ./words/it.json
 ```
-<br>
-  
+
+- Otherwise with the `configini` parameter you can specify a settings file (sample in the package/repo):  
+```
+syntaxautofix -configini /path/config.ini
+```
+
+
 ## Adding New Terms
+
+This require the git repo or the right path to the pip package folder.
+
 ```
 manageterms.py -wrong="wdiget" -right="widget" -lang=en
 ```
 
 You can use also an ui for that: `manageterms-gui.py`
 
 ## Adding New Terms using CSV File
+
+This require the git repo or the right path to the pip package folder.
+
 Directly upload new terms using a CSV file with row format:
 ```
 <correct-term>, <wrong-term>

README.md

@@ -1,2 +1,2 @@
-from . import syntaxalert
+from . import syntaxautofix
 from .utils import *

SyntaxAutoFix/__main__.py

@@ -1,6 +1,7 @@
 #!/usr/bin/python3
 import keyboard
-import argparse, os.path
+import argparse
+import os.path
 from threading import Thread
 from time import sleep
 from SyntaxAutoFix.utils import open_typo_file
@@ -10,12 +11,7 @@
 import json
 
 script_path = os.path.dirname(os.path.realpath(__file__))
-
 config_parser = ConfigParser()
-config_parser.read(os.path.join(script_path, 'filepath.ini'))
-
-LIST_OF_FILES = json.loads(config_parser.get('DEFAULT', 'words_file'))
-WORDS_FILE_DEFAULT_LOCATION = [os.path.join(script_path, file_path) for file_path in LIST_OF_FILES]
 
 
 # Load words
@@ -24,17 +20,22 @@ def loadWord(filename):
         words = open_typo_file(json_file)
         return words
 
+
 # Parse argument
 parser = argparse.ArgumentParser(description='Scan your digited letter for wrong words and alert you!')
-parser.add_argument('-words', dest='words_file', nargs='?', default=WORDS_FILE_DEFAULT_LOCATION[0], type=str)
-parser.add_argument('-words2', dest='words_file2', nargs='?', default=WORDS_FILE_DEFAULT_LOCATION[1], type=str)
+parser.add_argument('-config', dest='configini', nargs='?', default=os.path.join(script_path, 'config.ini'), type=str)
+parser.add_argument('-words', dest='words_file', nargs='?', default=os.path.join(script_path, 'words/en.json'), type=str)
+parser.add_argument('-words2', dest='words_file2', nargs='?', default=os.path.join(script_path, 'words/it.json'), type=str)
 args = parser.parse_args()
 
+config_parser.read(args.configini)
+LIST_OF_FILES = json.loads(config_parser.get('DEFAULT', 'words_file'))
+WORDS_FILE_DEFAULT_LOCATION = [os.path.join(script_path, file_path) for file_path in LIST_OF_FILES]
+
 # it holds the files name passed and the stat os file
 files = {}
 
 
-
 def mispell_callback():
     recorded_words = keyboard.stop_recording()
     recorded_words_list = list(keyboard.get_typed_strings(recorded_words))

SyntaxAutoFix/filepath.ini renamed to SyntaxAutoFix/config.ini

@@ -594,9 +594,6 @@
     "Turkey": [
         "Turky"
     ],
-    "Twitter": [
-        "twitter"
-    ],
     "Ukraine": [
         "Ukrane"
     ],
@@ -2006,10 +2003,6 @@
         "behavour",
         "behaviour"
     ],
-    "behaviour": [
-        "behavour",
-        "bheaviour"
-    ],
     "being": [
         "bieng"
     ],
@@ -13464,4 +13457,4 @@
     "learning": [
         "lerning"
     ]
-}
+}

SyntaxAutoFix/syntaxalert.py renamed to SyntaxAutoFix/syntaxautofix.py

@@ -486,9 +486,6 @@
         "hannio",
         "hano"
     ],
-    "regolmaneto": [
-        "regolamento"
-    ],
     "produzione": [
         "produzioen"
     ],
@@ -1501,4 +1498,4 @@
     "accesso": [
         "acecsso"
     ]
-}
+}

SyntaxAutoFix/words/en.json

@@ -0,0 +1,3 @@
+; Default values.
+[DEFAULT]
+words_file = [ "words/en.json", "words/it.json" ]

SyntaxAutoFix/words/it.json

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
-import argparse, os.path, csv
+import argparse
+import os.path
+import csv
 from SyntaxAutoFix.utils import open_typo_file, save_typo_data
 
 # Parse argument
@@ -9,7 +11,8 @@
 parser.add_argument('-lang', dest="lang", type=str, required=True)
 args = parser.parse_args()
 
-script_path = os.path.dirname(os.path.realpath(__file__)) + '/words/' + args.lang + '.json'
+script_path = os.path.dirname(os.path.realpath(__file__))
+script_path = os.path.join(script_path, 'SyntaxAutoFix/words/' + args.lang + '.json')
 
 typo_data = open_typo_file(script_path)
 with open(args.file) as csv_file:

config-sample.ini

@@ -0,0 +1,6 @@
+#!/usr/bin/env python3
+# This script can be used for who use the git version
+
+import SyntaxAutoFix.syntaxautofix
+
+SyntaxAutoFix.syntaxautofix.main()