Merge pull request #25 from BugliL/main

Update client with argparse (#3)

.gitignore

@@ -252,3 +252,4 @@ cython_debug/
 #.idea/
 
 # End of https://www.toptal.com/developers/gitignore/api/python,pycharm+all
+nord.png

.vscode/settings.json

@@ -0,0 +1,27 @@
+{
+    "files.autoSave": "afterDelay",
+    "files.autoSaveDelay": 400,
+    "editor.formatOnSave": true,
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.formatOnSave": true,
+    },
+    "python.envFile": "${workspaceFolder}/.env",
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": true,
+    "python.testing.cwd": "${workspaceFolder}",
+    "python.testing.autoTestDiscoverOnSaveEnabled": true,
+    "terminal.integrated.env.osx": {
+        "PYTHONIOENCODING": "utf-8",
+        "PYTHONPATH": "${workspaceFolder}/src:${workspaceFolder}/tests"
+    },
+    "python.analysis.typeCheckingMode": "strict",
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "tests",
+        "-p",
+        "test*.py"
+    ],
+    "editor.rulers": [80, 120]
+}

README.md

@@ -15,20 +15,27 @@ Include any essential instructions for:
   ```
 
 - Install dependencies
-  ```
+  ```shell
   pip install -r requirements.txt
   ```
 - Running it
+  ```shell
+  export PYTHONPATH=$PYTHONPATH:$PWD/src:$PWD/tests
+  python src/image_go_nord_client --img='<path_to_your_image>' 
   ```
-  python src/cli.py --img='<path_to_your_image>' 
+  Or if you prefer
+  ```shell
+  export PYTHONPATH=$PYTHONPATH:$PWD/src:$PWD/tests
+  cd src
+  python image_go_nord_client --img='<path_to_your_image>' 
   ```
 
 The algorithm can take some time (we are working on improving it), you can find the result with the name *nord.png*.
 
 You can define some more configuration and use different palettes, find more using:
 
-```
-python src/cli.py --help
+```shell
+python src/image_go_nord_client --img='<path_to_your_image>' 
 ```
 
 ### Contributing

src/image_go_nord_client/VERSION

@@ -0,0 +1 @@
+1.0.0