harnice 0.3.0__tar.gz → 0.3.2__tar.gz

{harnice-0.3.0 → harnice-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: harnice
-Version: 0.3.0
+Version: 0.3.2
 Summary: Electrical System CAD
 Author-email: Kenyon Shutt <harnice.io@gmail.com>
 Project-URL: Documentation, https://harnice.io/
@@ -18,6 +18,7 @@ Requires-Dist: Pillow
 Requires-Dist: PyYAML
 Requires-Dist: xlwt
 Requires-Dist: webcolors
+Requires-Dist: prompt_toolkit
 Dynamic: license-file
 
 Harnice is a free, open source electrical system CAD tool. 

{harnice-0.3.0 → harnice-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "harnice"
-version = "0.3.0"
+version = "0.3.2"
 authors = [
   { name="Kenyon Shutt", email="harnice.io@gmail.com" },
 ]
@@ -19,7 +19,8 @@ dependencies = [
     "Pillow",
     "PyYAML",
     "xlwt",
-    "webcolors"
+    "webcolors",
+    "prompt_toolkit"
 ]
 
 [project.urls]

{harnice-0.3.0 → harnice-0.3.2}/src/harnice/fileio.py

@@ -41,13 +41,15 @@ def path(target_value, structure_dict=None, base_directory=None):
 
     # returns the filepath/filename of a filekey.
     """
-    Recursively searches for a value in a nested JSON structure and returns the path to the element containing that value.
+Recursively searches for a value in a nested JSON structure and returns the path to the element containing that value.
 
-    Args:
-        target_value (str): The value to search for.
+It's complicated ... check out https://harnice.io/commands/fileio/ for more information.
+
+Args:
+    target_value (str): The value to search for.
 
-    Returns:
-        list: A list of container names leading to the element containing the target value, or None if not found.
+Returns:
+    list: A list of container names leading to the element containing the target value, or None if not found.
     """
 
     # FILES NOT DEPENDENT ON PRODUCT TYPE
@@ -65,7 +67,20 @@ def path(target_value, structure_dict=None, base_directory=None):
         harnice_root = os.path.dirname(
             os.path.dirname(os.path.dirname(harnice.__file__))
         )
-        return os.path.join(harnice_root, "library_locations.csv")
+
+        library_locations_path = os.path.join(harnice_root, "library_locations.csv")
+
+        if not os.path.exists(library_locations_path):
+            from harnice import cli
+            answer = cli.prompt(f"Library locations file not found at {library_locations_path}. Create it?", default="y")
+            if answer.lower() not in ("y", "yes", ""):
+                exit()
+
+            with open(library_locations_path, "w") as f:
+                f.write("repo_url,local_path\n")
+                f.write(f"https://github.com/harnice/harnice,{os.path.join(harnice_root, 'library_public')}\n")
+
+        return library_locations_path
 
     if target_value == "project locations":
         import harnice
@@ -73,6 +88,17 @@ def path(target_value, structure_dict=None, base_directory=None):
         harnice_root = os.path.dirname(
             os.path.dirname(os.path.dirname(harnice.__file__))
         )
+        project_locations_path = os.path.join(harnice_root, "project_locations.csv")
+        if not os.path.exists(project_locations_path):
+            from harnice import cli
+            answer = cli.prompt(f"Project locations file not found at {project_locations_path}. Create it?", default="y")
+            if answer.lower() not in ("y", "yes", ""):
+                exit()
+
+            with open(project_locations_path, "w") as f:
+                f.write("traceable_key,local_path\n")
+                f.write("your project part number,local path to your project\n")
+
         return os.path.join(harnice_root, "project_locations.csv")
 
     if target_value == "drawnby":
@@ -81,7 +107,24 @@ def path(target_value, structure_dict=None, base_directory=None):
         harnice_root = os.path.dirname(
             os.path.dirname(os.path.dirname(harnice.__file__))
         )
-        return os.path.join(harnice_root, "drawnby.json")
+
+        drawnby_path = os.path.join(harnice_root, "drawnby.json")
+        if not os.path.exists(drawnby_path):
+            from harnice import cli
+            answer = cli.prompt(f"Drawnby file not found at {drawnby_path}. Create it?", default="y")
+            if answer.lower() not in ("y", "yes", ""):
+                exit()
+
+            name = cli.prompt("Enter your name: (recommended: first inital, last name, all caps: K SHUTT)")
+
+            while not name:
+                print("Name cannot be empty. Please try again.")
+                name = cli.prompt("Enter your name")
+
+            with open(drawnby_path, "w") as f:
+                f.write(f"{name}\n")
+
+        return drawnby_path
 
     # FILES INSIDE OF A STRUCURE DEFINED BY FILEIO
     # look up from default structure state if not provided
@@ -209,12 +252,13 @@ def verify_revision_structure():
             f"Harnice only renders revisions with a blank status."
         )
 
-    print(f"Working on PN: {state.pn}, Rev: {state.rev}")
+    print(f"Rendering PN: {state.pn}, Rev: {state.rev}")
     rev_history.update_datemodified()
 
 
 def today():
-    return datetime.date.today().strftime("%-m/%-d/%y")
+    d = datetime.date.today()
+    return f"{d.month}/{d.day}/{d.year % 100}"
 
 
 def get_git_hash_of_harnice_src():

{harnice-0.3.0 → harnice-0.3.2}/src/harnice/lists/instances_list.py

@@ -5,23 +5,25 @@ from threading import Lock
 from harnice import fileio, state
 
 COLUMNS = [
-    "net", #documentation needed
-    "instance_name", #documentation needed
-    "print_name", #documentation needed
-    "bom_line_number", #documentation needed
-    "mfg", #documentation needed
-    "mpn",  # unique part identifier (manufacturer + part number concatenated)
+    "net", # the physical harness (represented by a net in Kicad) that this instance is part of
+    "instance_name", # the unique name of this instance
+    "print_name", # the non-unique, human-readable name of this instance, used for printing on output documents
+    "bom_line_number", # if this instance represents a physical procurable good, it gets assigned a line number on a bill of materials
+    "mfg", # manufacturer of this instance
+    "mpn",  # manufacturer part number
     "item_type",  # connector, backshell, whatever
     "parent_instance",  # general purpose reference
     "location_type",  # each instance is either better represented by one or ther other
     "segment_group",  # the group of segments that this instance is part of
     "segment_order",  # the sequential id of this item in its segment group
     "connector_group",  # a group of co-located parts (connectors, backshells, nodes)
-    "channel_group", #documentation needed
+    "channel_group", # other instances associated with this one because they are part of the same channel will share this value
     "circuit_id",  # which signal this component is electrically connected to
     "circuit_port_number",  # the sequential id of this item in its signal chain
     "node_at_end_a",  # derived from formboard definition
     "node_at_end_b",  # derived from formboard definition
+    "print_name_at_end_a", # human-readable name of this instance if needed, associated with 'node_at_end_a'
+    "print_name_at_end_b", # human-readable name of this instance if needed, associated with 'node_at_end_b'
     "parent_csys_instance_name",  # the other instance upon which this instance's location is based
     "parent_csys_outputcsys_name",  # the specific output coordinate system of the parent that this instance's location is based
     "translate_x",  # derived from parent_csys and parent_csys_name
@@ -29,9 +31,9 @@ COLUMNS = [
     "rotate_csys",  # derived from parent_csys and parent_csys_name
     "absolute_rotation",  # manual add, not nominally used unless it's a flagnote, segment, or node
     "csys_children",  # imported csys children from library attributes file
-    "cable_group", #documentation needed
-    "cable_container", #documentation needed
-    "cable_identifier", #documentation needed
+    "cable_group", # other instances associated with this one because they are part of the same cable will share this value
+    "cable_container", # which cable is this instance physically bundled inside of
+    "cable_identifier", # cable unique identifier
     "length",  # derived from formboard definition, the length of a segment
     "diameter",  # apparent diameter of a segment <---------- change to print_diameter
     "appearance",  # see harnice.utils.appearance for details
@@ -40,39 +42,39 @@ COLUMNS = [
     "note_parent",  # the instance the note applies to. typically don't use this in the instances list, just note_utils
     "note_text",  # the content of the note
     "note_affected_instances",  # list of instances that are affected by the note
-    "lib_repo", #documentation needed
-    "lib_subpath", #documentation needed
-    "lib_desc", #documentation needed
-    "lib_latest_rev", #documentation needed
-    "lib_rev_used_here", #documentation needed
-    "lib_status", #documentation needed
+    "lib_repo", # publically-traceable URL of the library this instance is from
+    "lib_subpath", # path to the instance within the library (directories between the product type and the part number)
+    "lib_desc", # description of the instance per the library's revision history
+    "lib_latest_rev", # the latest revision of the instance that exists in the remote library
+    "lib_rev_used_here", # the revision of the instance that is currently used in this project
+    "lib_status", # the status of the instance per the library's revision history
     "lib_releaseticket", #documentation needed
-    "lib_datestarted", #documentation needed
-    "lib_datemodified", #documentation needed
-    "lib_datereleased", #documentation needed
-    "lib_drawnby", #documentation needed
-    "lib_checkedby", #documentation needed
-    "project_editable_lib_modified", #documentation needed
-    "lib_build_notes", #documentation needed
-    "lib_tools", #documentation needed
+    "lib_datestarted", # the date this instance was first added to the library
+    "lib_datemodified", # the date this instance was last modified in the library
+    "lib_datereleased", # the date this instance was released in the library, if applicable, per the library's revision history
+    "lib_drawnby", # the name of the person who drew the instance, per the library's revision history
+    "lib_checkedby", # the name of the person who checked the instance, per the library's revision history
+    "project_editable_lib_modified", # a flag to indicate if the imported contents do not match the library's version (it's been locally modified)
+    "lib_build_notes", # recommended build notes that come with the instance from the library
+    "lib_tools", # recommended tools that come with the instance from the library
     "this_instance_mating_device_refdes",  # if connector, refdes of the device it plugs into
     "this_instance_mating_device_connector",  # if connector, name of the connector it plugs into
     "this_instance_mating_device_connector_mpn",  # if connector, mpn of the connector it plugs into
-    "this_net_from_device_refdes", #documentation needed
-    "this_net_from_device_channel_id", #documentation needed
-    "this_net_from_device_connector_name", #documentation needed
-    "this_net_to_device_refdes", #documentation needed
-    "this_net_to_device_channel_id", #documentation needed
-    "this_net_to_device_connector_name", #documentation needed
-    "this_channel_from_device_refdes",  # if channel, refdes of the device on one side of the channel
-    "this_channel_from_device_channel_id", #documentation needed
-    "this_channel_to_device_refdes",  # if channel, refdes of the device on the other side of the channel
-    "this_channel_to_device_channel_id", #documentation needed
-    "this_channel_from_channel_type", #documentation needed
-    "this_channel_to_channel_type", #documentation needed
-    "signal_of_channel_type", #documentation needed
-    "debug", #documentation needed
-    "debug_cutoff", #documentation needed
+    "this_net_from_device_refdes", # if this instance is a channel, circuit, conductor, etc, the refdes of the device it interfaces with, just within this net
+    "this_net_from_device_channel_id", # if this instance is a channel, circuit, conductor, etc, the channel id in the device it interfaces with, just within this net
+    "this_net_from_device_connector_name", # if this instance is a channel, circuit, conductor, etc, the name of the connector it interfaces with, just within this net
+    "this_net_to_device_refdes", # if this instance is a channel, circuit, conductor, etc, the refdes of the device it plugs into just within this net
+    "this_net_to_device_channel_id", # if this instance is a channel, circuit, conductor, etc, the channel id in the device it plugs into, just within this net
+    "this_net_to_device_connector_name", # if this instance is a channel, circuit, conductor, etc, the name of the connector it plugs into, just within this net
+    "this_channel_from_device_refdes",  # if this instance is a channel, circuit, conductor, etc, the refdes of the device it interfaces with, at the very end of the channel
+    "this_channel_from_device_channel_id", # if this instance is a channel, circuit, conductor, etc, the channel id in the device it interfaces with, at the very end of the channel
+    "this_channel_to_device_refdes",  # if this instance is a channel, circuit, conductor, etc, the refdes of the device it plugs into, at the very end of the channel
+    "this_channel_to_device_channel_id", # if this instance is a channel, circuit, conductor, etc, the channel id in the device it plugs into, at the very end of the channel
+    "this_channel_from_channel_type", # if this instance is a channel, circuit, conductor, etc, the type of the channel it interfaces with, at the very end of the channel
+    "this_channel_to_channel_type", # if this instance is a channel, circuit, conductor, etc, the type of the channel it plugs into, at the very end of the channel
+    "signal_of_channel_type", # if this instance is a channel, circuit, conductor, etc, the signal of the channel it interfaces with, at the very end of the channel
+    "debug", # the call chain of the function that last modified this instance row
+    "debug_cutoff", # blank cell to visually cut off the previous column
 ]