fix command line output, bump version to 0.1.1

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.1] - 2024-06-14
+### Fixed
+ - command line help output 
+
 ## [0.1.0] - 2024-06-14
 ### Added
  - new dependency for openpyxl to read xlsx-files out of the box
@@ -22,7 +26,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
  - Initial release 
 
-[unreleased]: https://github.com/upb-lea/KiClearance/compare/0.1.0...HEAD
+[unreleased]: https://github.com/upb-lea/KiClearance/compare/0.1.1...HEAD
+[0.1.1]: https://github.com/upb-lea/KiClearance/compare/0.1.0...0.1.1
 [0.1.0]: https://github.com/upb-lea/KiClearance/compare/0.0.2...0.1.0
 [0.0.2]: https://github.com/upb-lea/KiClearance/compare/0.0.1...0.0.2
 [0.0.1]: https://github.com/upb-lea/KiClearance/releases/tag/0.0.1

README.rst

@@ -55,12 +55,30 @@ Now a file ``yourprojectname.kicad_dru`` is generated, which contains the rule s
 
 Open your KiCad project, the rule sets are now stored and you can start the routing.
 
+As the inner layers are exposed to less dirt and no air, the distance in the inner layers is halved by default.
+If this factor is to be set differently, this can be set with the following command (in the example: distance to 75%):
+
+::
+
+    python -m kiclearance -i 0.75
+
 To see help and options, run
 
 ::
 
     python -m kiclearance --help
 
+::
+
+    The following arguments are possible:
+    -h, --help: Prints this information,
+    -f, --project_folder (Optional): Path to the folder in which the project is located. Default: Folder in which this python script is located.
+    -n, --project_name (Optional): Name of the kicad project (file prefix). Default: Script will look for a file with .kicad_pro in the set folder.
+    -t, --table_file (Optional): Name (and ending) of the file containing the distance values. Default name: 'clearance'.
+    -i, --factor_inner_layers (Optional): Reduced factor for the inner layers. Default: 0.5
+    -d, --min_track_distance (Optional): minimum track distance between two tracks on the same potential. Default: 0.15 mm.
+
+
 Tips and tricks
 ---------------------------------------
 If two network classes are assigned to a connection by mistake, this is displayed as an error in the Electrical Rules Checker (``Inspect`` -> ``Electrical Rules Checker``).

docs/source/conf.py

@@ -20,7 +20,7 @@
 project = 'kiclearance'
 copyright = '2024, UPB-LEA'
 author = 'UPB-LEA'
-release = '0.1.0'
+release = '0.1.1'
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 

kiclearance/__main__.py

@@ -10,7 +10,8 @@
 
 # Parse command line arguments
 try:
-    opts, args = getopt.getopt(sys.argv[1:], "hf:n:t:i:d:", ["help", "project_folder=", "project_name=", "table_file=, 'factor_inner_layers=", "min_track_distance="])
+    opts, args = getopt.getopt(sys.argv[1:], "hf:n:t:i:d:",
+                               ["help", "project_folder=", "project_name=", "table_file=, 'factor_inner_layers=", "min_track_distance="])
 except getopt.GetoptError as err:
     print(err)
     usage()

kiclearance/kiclearance.py

@@ -2,8 +2,6 @@
 import pandas as pd
 import os
 import importlib.util
-import getopt
-import sys
 import numpy as np
 
 
@@ -207,11 +205,11 @@ def usage():
             -f, --project_folder (Optional): Path to the folder in which the project is located. Default: Folder in which this python script is located.\n\
             -n, --project_name (Optional): Name of the kicad project (file prefix). Default: Script will look for a file with .kicad_pro in the set folder.\n\
             -t, --table_file (Optional): Name (and ending) of the file containing the distance values. Default name: 'clearance'.\n\
-            -fi, --factor_inner_layers (Optional): Reduced factor for the inner layers. Default: 0.5\n\
-            -td, --min_track_distance (Optional): minimum track distance between two tracks on the same potential. Default: 0.15 mm."
+            -i, --factor_inner_layers (Optional): Reduced factor for the inner layers. Default: 0.5\n\
+            -d, --min_track_distance (Optional): minimum track distance between two tracks on the same potential. Default: 0.15 mm."
 
     print(text)
 
 
 if __name__ == "__main__":
-    pass
+    pass

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kiclearance"
-version = "0.1.0"
+version = "0.1.1"
 authors = [
     { name = "UPB-LEA" },
 ]