Update docs, workflows

.github/workflows/release.yml

@@ -9,12 +9,14 @@ permissions:
   contents: write
 
 jobs:
-  build-and-release:
+  build:
     runs-on: windows-latest
 
     steps:
       - uses: actions/checkout@v3
+        name: Checkout
       - uses: actions/setup-python@v4
+        name: Setup Python
         with:
           python-version: "3.11"
 
@@ -27,11 +29,30 @@ jobs:
         run: pyinstaller dyn2py.spec
 
       - uses: actions/upload-artifact@v3
+        name: Upload artifact
         with:
           name: dyn2py.exe
           path: dist/dyn2py.exe
 
+  release:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/checkout@v3
+        name: Checkout
+      - name: Generate changelog
+        id: changelog
+        uses: metcalfc/changelog-generator@v4.1.0
+        with:
+          myToken: ${{ secrets.GITHUB_TOKEN }}
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: dyn2py.exe
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
-          files: dist/dyn2py.exe
+          files: dyn2py.exe
+          body: ${{ steps.modified.outputs.log }}
+
+  # TODO: pip

.github/workflows/website.yml

@@ -2,9 +2,8 @@ name: Deploy website
 
 on:
   push:
-    # Only build for tags.
-    tags:
-      - "*"
+    branches:
+      - main
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

README.md

@@ -9,6 +9,14 @@ Use cases:
 
 ## Installation
 
+### Windows portable
+
+Prebuilt exe available from github releases.
+
+No requirements, just download `dyn2py.exe` from release assets:
+
+https://github.com/infeeeee/dyn2py/releases/latest
+
 ### With pip from Github
 
 Requirements: git, python, pip

dyn2py/files.py

@@ -371,7 +371,7 @@ class PythonFile(File):
     """A Python file, subclass of File()"""
 
     code: list[str]
-    """The python code."""
+    """The python code. Lines as list items, without newlines."""
     header_data: dict
     """Parsed dict from the header of a python file."""
     text: str
@@ -564,7 +564,7 @@ class PythonNode():
     engine: str
     """The engine of the node, IronPython2 or CPython3"""
     code: list[str]
-    """The full code"""
+    """The full code. Lines as list items, without newlines."""
     checksum: str
     """The checksum of the code, for checking changes"""
     name: str
@@ -572,7 +572,7 @@ class PythonNode():
     filename: pathlib.Path | str
     """The filename the node should be saved as, including the .py extension"""
     filepath: pathlib.Path
-    """The path is shoul"""
+    """The full path the node should be saved as"""
 
     def __init__(self,
                  node_dict_from_dyn: dict = {},