Merge pull request #7 from Bitfroest/feature/fix-module-import

Fix order of includes and modules folder path, Format with yapf, Closes #5
FabianSchurig · Jul 25, 2020 · e740e3f · e740e3f
2 parents b4e784d + 167bebc
commit e740e3f
Show file tree

Hide file tree

Showing 7 changed files with 364 additions and 183 deletions.
diff --git a/.style.yapf b/.style.yapf
@@ -0,0 +1,6 @@
+[style]
+# YAPF uses the google style
+based_on_style = google
+spaces_before_comment = 4
+split_before_named_assigns = False
+column_limit = 100
diff --git a/CustomScrews.manifest b/CustomScrews.manifest
@@ -6,7 +6,7 @@
 	"description":	{
 		"":	""
 	},
-	"version":	"1.3",
+	"version":	"1.3.1",
 	"runOnStartup":	true,
 	"supportedOS":	"windows|mac",
 	"editEnabled":	true

diff --git a/CustomScrews.py b/CustomScrews.py
diff --git a/README.md b/README.md
@@ -1,18 +1,30 @@
 # CustomScrews  
+
 Fusion 360 App which creates custom screws by different parameters.  
 
 ### Installation
-- Download the project as zip file and extract it to `C:\Users\YOURNAME\AppData\Roaming\Autodesk\Autodesk Fusion 360\API\AddIns`
-- (Instead of downloading the zip, you could also fork this project directly into the given folder)
-- Open Fusion 360 and then click on 'Scripts and Add-Ins'
-- Create new Add-In from existing file and select `CustomScrews.py`
-- Start your new script and I hope you are happy with it.
+
+* Download the project as zip file and extract it to `C:\Users\YOURNAME\AppData\Roaming\Autodesk\Autodesk Fusion 360\API\AddIns`
+* (Instead of downloading the zip, you could also fork this project directly into the given folder)
+* Open Fusion 360 and then click on 'Scripts and Add-Ins'
+* Go to the Add-In tab and open (green plus) existing projects and select the `CustomScrews` folder
+* Start your new script and I hope you are happy with it.
+
+### Requirements
+
+Install the requirements into the `./modules` folder.
+
+``` 
+pip install -r requirements.txt -t ./modules/
+```
 
 ### Deinstallation
-- Stop the Add-In in Fusion 360
-- Delete the extracted files in the previous given folder
+
+* Stop the Add-In in Fusion 360
+* Delete the extracted files in the previous given folder
 
 ### Parameters
+
 The following technical drawing is showing the changeable parameters of the screw. 
 <img src="./resources/technical.png" width="400">  
 
@@ -28,8 +40,10 @@ __Thread Length:__ length of the thread
 __Chamfer Distance:__ distance of the 45degree chamfer on the body shaft  
 
 ### Screenshots
+
 ![Screenshot2](./resources/screenshot2.png)
 
 ### Future Features
-- auto-placement of a kind of screws to selectable joint origins
-- verification of depending parameters
+
+* auto-placement of a kind of screws to selectable joint origins
+* verification of depending parameters
diff --git a/help.html b/help.html
@@ -1,11 +1,15 @@
 <!DOCTYPE html>
 <html>
 <style>
-h2{font-family:Arial;}
+    h2 {
+        font-family: Arial;
+    }
 </style>
+
 <body>
-<h2>Custom Screw Generator</h2>
-<p>You can manipulate the whole parameter set of the screw in the following technical drawing.</p>
-<img src="resources/technical.png">
+    <h2>Custom Screw Generator</h2>
+    <p>You can manipulate the whole parameter set of the screw in the following technical drawing.</p>
+    <img src="resources/technical.png">
 </body>
+
 </html>
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+requests==2.18.4