Readme update

ivantitov-zd · Mar 3, 2021 · a9df1ae · a9df1ae
1 parent 0251e21
commit a9df1ae
Show file tree

Hide file tree

Showing 16 changed files with 51 additions and 48 deletions.
diff --git a/OPmenu.xml b/OPmenu.xml
@@ -30,10 +30,9 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
             <scriptItem id="opmenu.tdk_generate_code">
                 <label>Generate Code...</label>
                 <scriptCode>
-import houdini_tdk
-reload(houdini_tdk)
+import houdini_tdk as tdk
 
-houdini_tdk.showGenerateCode(**kwargs)
+tdk.showGenerateCode(**kwargs)
                 </scriptCode>
             </scriptItem>
 
@@ -49,19 +48,18 @@ houdini_tdk.showNodeUserData(cached=kwargs['shiftclick'], **kwargs)
 
             <separatorItem/>
 
-            <scriptItem id="opmenu.tdk_make_hda_from_template">
-                <label>Make HDA from Template...</label>
+            <scriptItem id="opmenu.tdk_make_hda_by_template">
+                <label>Make HDA by Template...</label>
                 <context>
                     <expression>
                         node = kwargs['node']
                         return node.type().name().startswith('tdk::template')
                     </expression>
                 </context>
                 <scriptCode>
-import houdini_tdk
-reload(houdini_tdk)
+import houdini_tdk as tdk
 
-houdini_tdk.showMakeHDAFromTemplateDialog(**kwargs)
+tdk.showMakeHDAByTemplateDialog(**kwargs)
                 </scriptCode>
             </scriptItem>
 
@@ -82,19 +80,18 @@ openFileLocation(path)
                 </scriptCode>
             </scriptItem>
 
-            <scriptItem id="opmenu.tdk_increment_hda_version">
-                <label>Increment HDA Version...</label>
+            <scriptItem id="opmenu.tdk_new_hda_version">
+                <label>New HDA Version...</label>
                 <context>
                     <expression>
                         node = kwargs['node']
                         return node.type().definition() is not None
                     </expression>
                 </context>
                 <scriptCode>
-import houdini_tdk
-reload(houdini_tdk)
+import houdini_tdk as tdk
 
-houdini_tdk.showNewVersionDialog(**kwargs)
+tdk.showNewVersionDialog(**kwargs)
                 </scriptCode>
             </scriptItem>
 

diff --git a/README.md b/README.md
@@ -2,11 +2,17 @@
 
 ## Tools
 
+#### HDA Doctor *Beta*
+
+Tool that allows you to test your HDA with a set of inspections that check for compliance with high standards of HDA development.
+
+![HDA Doctor](/images/hda_doctor.png)
+
 #### Templates
 
-Template HDAs that allows you to quickly create your own HDAs based on them.
+Template HDAs that allows you to quickly create new HDAs based on them.
 
-![Make HDA from Template](/images/make_hda_from_template.png)
+![Make HDA by Template](/images/make_hda_by_template.gif)
 
 #### Find Icon
 
@@ -19,30 +25,31 @@ Allows you to quickly find an icon for your tool.
 Applies `.asCode()` to selected nodes. Then copies the resulting code to the clipboard or shows in code editor.
 
 ![Generate Code](/images/generate_code.png)
+![Generate Code Settings](/images/generate_code_settings.png)
 
-#### Increment HDA Version
+#### New HDA Version
 
-Increments the HDA version of the selected node. You can select the version type (major, minor, build, etc.).
+Increments an HDA version of the selected node. You can select the version type (major, minor, build, etc.).
 
-![Increment HDA Version](/images/increment_hda_version.png)
+![New HDA Version](/images/new_hda_version.png)
 
 #### Show Node User Data
 
 Shows user data and cached user data of the selected node.
 
 ![Show Node User Data](/images/show_node_user_data.png)
 
-## Installation (todo)
+## Installation
 
-- [16.0+] Package Manager (Recommended)
-- [17.5+] Packages (template json file included)
+- [16.0+] [Package Manager](https://github.com/Houdini-Packages/Houdini-Package-Manager) *Recommended*
+- [17.5+] [Packages](https://www.sidefx.com/docs/houdini/ref/plugins.html) (template json file included)
 - Environment file
 
 ## License
 
 ```
 Tool Development Kit for SideFX Houdini
-Copyright (C) 2020  Ivan Titov
+Copyright (C) 2021  Ivan Titov
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

diff --git a/images/find_icon.png b/images/find_icon.png
diff --git a/images/generate_code.png b/images/generate_code.png
diff --git a/images/generate_code_settings.png b/images/generate_code_settings.png
diff --git a/images/hda_doctor.png b/images/hda_doctor.png
diff --git a/images/increment_hda_version.png b/images/increment_hda_version.png
diff --git a/images/make_hda_by_template.gif b/images/make_hda_by_template.gif
diff --git a/images/make_hda_from_template.png b/images/make_hda_from_template.png
diff --git a/images/new_hda_version.png b/images/new_hda_version.png
diff --git a/images/show_node_user_data.png b/images/show_node_user_data.png
diff --git a/python2.7libs/houdini_tdk/__init__.py b/python2.7libs/houdini_tdk/__init__.py
@@ -19,5 +19,6 @@
 from .find_icon import FindIconDialog, findIcon
 from .new_hda_version import NewVersionDialog, showNewVersionDialog
 from .show_node_user_data import UserDataWindow, showNodeUserData
-from .make_hda_from_template import MakeHDAFromTemplateDialog, showMakeHDAFromTemplateDialog
+from .make_hda_by_template import MakeHDAByTemplateDialog, showMakeHDAByTemplateDialog
 from .generate_code import showGenerateCode
+from .hda_doctor import HDADoctorWindow
diff --git a/python2.7libs/houdini_tdk/generate_code.py b/python2.7libs/houdini_tdk/generate_code.py
@@ -98,6 +98,7 @@ def __init__(self, node, parent=None):
 
         # UI
         self.setWindowTitle('Generate Code: Settings')
+        self.setWindowIcon(hou.qt.Icon('MISC_python', 32, 32))
         self.resize(400, 200)
 
         main_layout = QVBoxLayout(self)

diff --git a/python2.7libs/houdini_tdk/hda_doctor.py b/python2.7libs/houdini_tdk/hda_doctor.py
@@ -703,7 +703,7 @@ class HDADoctorWindow(QWidget):
     def __init__(self, parent=None):
         super(HDADoctorWindow, self).__init__(parent, Qt.Window)
 
-        self.setWindowTitle('HDA Doctor')
+        self.setWindowTitle('HDA Doctor Beta')
         self.setWindowIcon(hou.qt.Icon('SOP_polydoctor', 32, 32))
         self.resize(600, 600)
 

diff --git a/...ibs/houdini_tdk/make_hda_from_template.py → ...7libs/houdini_tdk/make_hda_by_template.py b/...ibs/houdini_tdk/make_hda_from_template.py → ...7libs/houdini_tdk/make_hda_by_template.py
@@ -152,14 +152,14 @@ def _pickLocation(self):
             self.edit.setText(path)
 
 
-class MakeHDAFromTemplateDialog(QDialog):
+class MakeHDAByTemplateDialog(QDialog):
     def __init__(self, node, parent=None):
-        super(MakeHDAFromTemplateDialog, self).__init__(parent)
+        super(MakeHDAByTemplateDialog, self).__init__(parent)
 
         # Data
         self.node = node
 
-        self.setWindowTitle('TDK: HDA from Template')
+        self.setWindowTitle('TDK: HDA by Template')
         self.setWindowIcon(hou.qt.Icon('NODEFLAGS_template', 32, 32))
         self.resize(400, 250)
 
@@ -294,7 +294,7 @@ def _onOk(self):
         self.accept()
 
 
-def showMakeHDAFromTemplateDialog(**kwargs):
+def showMakeHDAByTemplateDialog(**kwargs):
     if 'node' in kwargs:
         nodes = kwargs['node'],
     else:
@@ -308,5 +308,5 @@ def showMakeHDAFromTemplateDialog(**kwargs):
     elif not nodes[0].type().name().startswith('tdk::template'):
         notify('Node is not TDK Template', hou.severityType.Error)
         return
-    window = MakeHDAFromTemplateDialog(nodes[0], hou.qt.mainWindow())
+    window = MakeHDAByTemplateDialog(nodes[0], hou.qt.mainWindow())
     window.show()
diff --git a/toolbar/houdini_tdk.shelf b/toolbar/houdini_tdk.shelf
@@ -11,13 +11,15 @@
     <memberTool name="houdini_tdk::increment_hda_version::1.0"/>
     <memberTool name="houdini_tdk::show_node_user_data::1.0"/>
     <memberTool name="houdini_tdk::hda_from_template::1.0"/>
+    <memberTool name="show_hda_doc"/>
+    <memberTool name="Show Net Stats"/>
   </toolshelf>
 
   <tool name="houdini_tdk::find_icon::1.0" label="Find Icon" icon="MISC_m">
     <helpText><![CDATA["""Show Find Icon window"""]]></helpText>
     <script scriptType="python"><![CDATA["""
 Tool Development Kit for SideFX Houdini
-Copyright (C) 2020  Ivan Titov
+Copyright (C) 2021  Ivan Titov
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -33,18 +35,17 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-import houdini_tdk
-reload(houdini_tdk)
+import houdini_tdk as tdk
 
-houdini_tdk.findIcon(**kwargs)
+tdk.findIcon(**kwargs)
 ]]></script>
   </tool>
 
   <tool name="houdini_tdk::increment_hda_version::1.0" label="Increment HDA Version" icon="BUTTONS_list_add">
     <helpText><![CDATA["""Increment HDA version of the selected node"""]]></helpText>
     <script scriptType="python"><![CDATA["""
 Tool Development Kit for SideFX Houdini
-Copyright (C) 2020  Ivan Titov
+Copyright (C) 2021  Ivan Titov
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -60,10 +61,9 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-import houdini_tdk
-reload(houdini_tdk)
+import houdini_tdk as tdk
 
-houdini_tdk.showNewVersionDialog(**kwargs)
+tdk.showNewVersionDialog(**kwargs)
 ]]></script>
   </tool>
 
@@ -72,7 +72,7 @@ houdini_tdk.showNewVersionDialog(**kwargs)
 ]]></helpText>
     <script scriptType="python"><![CDATA["""
 Tool Development Kit for SideFX Houdini
-Copyright (C) 2020  Ivan Titov
+Copyright (C) 2021  Ivan Titov
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -88,17 +88,16 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-import houdini_tdk
-reload(houdini_tdk)
+import houdini_tdk as tdk
 
-houdini_tdk.showNodeUserData(cached=kwargs['shiftclick'])
+tdk.showNodeUserData(cached=kwargs['shiftclick'])
 ]]></script>
   </tool>
 
   <tool name="houdini_tdk::hda_from_template::1.0" label="Make HDA from Template" icon="NODEFLAGS_template">
     <script scriptType="python"><![CDATA["""
 Tool Development Kit for SideFX Houdini
-Copyright (C) 2020  Ivan Titov
+Copyright (C) 2021  Ivan Titov
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -114,10 +113,9 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-import houdini_tdk
-reload(houdini_tdk)
+import houdini_tdk as tdk
 
-houdini_tdk.showMakeHDAFromTemplateDialog(**kwargs)
+tdk.showMakeHDAFromTemplateDialog(**kwargs)
 ]]></script>
   </tool>
 
@@ -144,10 +142,9 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-import houdini_tdk
-reload(houdini_tdk)
+import houdini_tdk as tdk
 
-houdini_tdk.showGenerateCode(**kwargs)
+tdk.showGenerateCode(**kwargs)
 ]]></script>
   </tool>
 </shelfDocument>