Fix installer build script

.github/workflows/build-installer.yml

@@ -19,15 +19,9 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: dyn2py.exe
-          path: dist/dyn2py.exe
-      - name: Update version number
+      - name: Build
         run: |
-          $regex = Select-String -Path pyproject.toml -Pattern '^version = "((?:\d\.){2}\d)"$'
-          $version = $regex.Matches.Groups[1].Value
-          (Get-Content dyn2py-installer.iss).Replace("x.x.x",$version) | Set-Content dyn2py-installer.iss
-      - name: Build installer
-        run: |
-          & "C:\Program Files (x86)\Inno Setup 6\ISCC.exe" -Qp $(Join-Path $PWD.Path dyn2py-installer.iss)
+          .\dyn2py-installer.ps1
       - uses: actions/upload-artifact@v3
         name: Upload artifact
         with:

.gitignore

@@ -7,3 +7,4 @@ dist
 docs
 tests/output_files
 Output
+dyn2py.exe

README.md

@@ -53,7 +53,7 @@ options:
   -h, --help            show this help message and exit
   -v, --version         show program's version number and exit
   -l LOGLEVEL, --loglevel LOGLEVEL
-                        set log level, possible options: CRITICAL, ERROR, WARNING, INFO, DEBUG
+                        set log level, possible options: HEADLESS, CRITICAL, ERROR, WARNING, INFO, DEBUG
   -n, --dry-run         do not modify files, only show log
   -F, --force           overwrite even if the files are older
   -b, --backup          create a backup for updated files
@@ -68,36 +68,37 @@ dynamo options, only for processing Dynamo graphs:
 The script by default overwrites older files with newer files.
 Do not move the source Dynamo graphs, or update won't work with them later.
 Multiple sources are supported, separate them by spaces.
+HEADLESS loglevel only prints modified filenames.
 ```
 
 #### Examples
 
 *Notes: In Windows cmd use backward slashes as path separators, in any other shells use forward slashes. Powershell accepts both of them. Wrap paths with spaces in double quotes.*
 
-Extract all nodes next to a Dynamo file:
-
-```
+```shell
+# Extract all nodes next to a Dynamo file:
 dyn2py path/to/dynamofile.dyn
-```
 
-Update a Dynamo file from previously exported and modified python files:
-
-```
+# Update a Dynamo file from previously exported and modified python files:
 dyn2py --update path/to/dynamofile.dyn
-```
 
-Extract python nodes to a specific folder, process multiple Dynamo files:
-
-```
+# Extract python nodes to a specific folder, process multiple Dynamo files:
 dyn2py --python-folder path/to/pythonfiles path/to/dynamofile1.dyn path/to/dynamofile2.dyn
-```
 
-Update Dynamo files from python files from a folder. Only check python files, create backups:
-
-```
+# Update Dynamo files from python files from a folder. Only check python files, create backups:
 dyn2py --filter py --backup path/to/pythonfiles
 ```
 
+#### Git hooks
+
+Git Hooks are a built-in feature of Git that allow developers to automate tasks throughout the Git workflow. Read more here: https://githooks.com/
+
+With the `pre-commit` hook it's possible to add more files to the currently initialized commit.
+
+You can find an example pre-commit hook here: [pre-commit](pre-commit). Copy this file to the `.git/hooks` folder of your repo of Dynamo graph. This folder is hidden by default, but it should exist in all initialized git repo. Do not rename this file.
+
+This script will go through staged `.dyn` files and export python scripts from them, and add them to the current commit. Now you can check check changed lines in a diff tool!
+
 ### As a python module
 
 Full API documentation available here: https://infeeeee.github.io/dyn2py
@@ -180,17 +181,9 @@ pyinstaller dyn2py.spec
 ### Create installer for Windows
 
 - Install Inno Setup: https://jrsoftware.org/isdl.php
-- The already built exe should be in `dist\dyn2py.exe`
-- Run this in powershell:
+- Build an exe
+- Run `dyn2py-installer.ps1` in powershell
 
-```powershell
-# Read version number from pyproject.toml and update in innosetup:
-$regex = Select-String -Path pyproject.toml -Pattern '^version = "((?:\d\.){2}\d)"$'
-$version = $regex.Matches.Groups[1].Value
-(Get-Content dyn2py-installer.iss).Replace("x.x.x",$version) | Set-Content dyn2py-installer.iss
-# Build:
-& "C:\Program Files (x86)\Inno Setup 6\ISCC.exe" -Qp $(Join-Path $PWD.Path dyn2py-installer.iss)
-```
 ### Live module documentation
 
 ```

TODO.md

@@ -22,7 +22,7 @@
 - [x] API docs
 - [x] Installation in readme
 - [x] Terminal examples in readme
-- [ ] About git hooks in readme
+- [x] About git hooks in readme
 
 ## Extra features maybe later
 

dyn2py-installer.iss

@@ -20,7 +20,7 @@ ChangesEnvironment=yes
 Name: "english"; MessagesFile: "compiler:Default.isl"
 
 [Files]
-Source: "dist\dyn2py.exe"; DestDir: "{app}"; Flags: ignoreversion external
+Source: "dyn2py.exe"; DestDir: "{app}"; Flags: ignoreversion
 
 
 [Code]

dyn2py-installer.ps1

@@ -0,0 +1,24 @@
+$InnoSetupPath = "C:\Program Files (x86)\Inno Setup 6\ISCC.exe"
+
+# Check if innosetup installed
+if (-not (Test-Path -Path $InnoSetupPath -PathType Leaf)) {
+    throw "Innosetup not found!"    
+} 
+
+# Copy dyn2py.exe from default folder:
+if (Test-Path -Path ".\dist\dyn2py.exe" -PathType Leaf) {
+    Copy-Item ".\dist\dyn2py.exe" -Destination "." -Force
+} 
+
+# Check if dyn2py.exe exists at all
+if (-not(Test-Path -Path "dyn2py.exe" -PathType Leaf)) {
+    throw "dyn2py.exe not found!"    
+}
+
+# Read version number from pyproject.toml and update in innosetup:
+$regex = Select-String -Path pyproject.toml -Pattern '^version = "((?:\d\.){2}\d)"$'
+$version = $regex.Matches.Groups[1].Value
+(Get-Content dyn2py-installer.iss).Replace("x.x.x", $version) | Set-Content dyn2py-installer.iss
+
+# Build:
+& $InnoSetupPath -Qp $(Join-Path $PWD.Path dyn2py-installer.iss)

dyn2py/__init__.py

@@ -45,6 +45,7 @@ def __command_line() -> None:
             The script by default overwrites older files with newer files.
             Do not move the source Dynamo graphs, or update won't work with them later.
             Multiple sources are supported, separate them by spaces.
+            HEADLESS loglevel only prints modified filenames.
             """)
     )
 
@@ -117,8 +118,13 @@ def run(options: Options) -> None:
     from_command_line = bool(inspect.stack()[1].function == "__command_line")
 
     # Set up logging:
+    if options.loglevel == "HEADLESS":
+        loglevel = "CRITICAL"
+    else:
+        loglevel = options.loglevel
+
     logging.basicConfig(format='%(levelname)s: %(message)s',
-                        level=options.loglevel)
+                        level=loglevel)
     logging.debug(f"Run options: {vars(options)}")
 
     # Set up sources:
@@ -197,4 +203,7 @@ def run(options: Options) -> None:
 
     # Write files at the end:
     for f in DynamoFile.open_files | PythonFile.open_files:
+        try:
             f.write(options)
+        except FileNotFoundError:
+            logging.error(f"Cannot save file! {f.filepath}")

dyn2py/files.py

@@ -120,6 +120,7 @@ class File():
 
         Raises:
             TypeError: If called on a File object
+            FileNotFoundError: Target folder does not exist
         """
 
         if not options:
@@ -140,14 +141,20 @@ class File():
             backup_path = self.dirpath.joinpath(backup_filename)
             logging.info(f"Creating backup to {backup_path}")
             self.filepath.rename(backup_path)
+            if options.loglevel == "HEADLESS":
+                print(backup_path)
 
         # Call filetype specific methods:
         if options.dry_run:
             logging.info(
                 f"Should write file, but it's a dry-run: {self.filepath}")
         else:
+            if not self.dirpath.exists():
+                raise FileNotFoundError("File dir does not exist!")
             logging.info(f"Writing file: {self.filepath}")
             self._write_file()
+            if options.loglevel == "HEADLESS":
+                print(self.filepath)
 
     def _write_file(self):
         """Should be implemented in subclasses

dyn2py/options.py

@@ -3,7 +3,7 @@ import argparse
 import pathlib
 
 
-LOGLEVELS = ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"]
+LOGLEVELS = ["HEADLESS", "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"]
 DEFAULT_LOGLEVEL = "INFO"
 FILTERS = ["py", "dyn"]
 

pre-commit

@@ -0,0 +1,27 @@
+#!/bin/sh
+
+# Create a list of files from staged files:
+mapfile -t NEW_FILES <<<$(git diff --name-only --cached)
+
+# Go through staged files:
+for f in "${NEW_FILES[@]}"; do
+
+    # Export python files, only from Dynamo files.
+    # On Windows line ending is always CRLF, so remove CR with tr.
+    mapfile -t PY_FILES <<<$(dyn2py --force --filter dyn --loglevel HEADLESS "$f" | tr -d "\r")
+
+    # Check if something was exported:
+    if [[ "${PY_FILES[@]}" ]]; then
+
+        # Go through exported files:
+        for p in "${PY_FILES[@]}"; do
+
+            # Check if file exists:
+            if [ -f "$p" ]; then
+
+                # Stage file:
+                git add "$p"
+            fi
+        done
+    fi
+done

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dyn2py"
-version = "0.3.2"
+version = "0.3.3"
 description = "Extract python code from Dynamo graphs"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -34,3 +34,6 @@ dyn2py = "dyn2py:__command_line"
 
 [build-system]
 requires = ["setuptools", "wheel"]
+
+[tool.setuptools]
+packages = ["dyn2py"]