Document all the things! (#117)

Add lots of docstrings everywhere

.github/workflows/pyinstaller.yml

@@ -0,0 +1,17 @@
+name: Create Executable (Windows)
+            
+on:
+  workflow_dispatch:
+  release:
+
+jobs:
+  pyinstaller-build:
+    runs-on: windows-latest
+    steps:
+      - name: Create Executable (Windows)
+        uses: sayyid5416/pyinstaller@v1
+        with:
+          python_ver: '3.11'
+          spec: 'main.spec'
+          requirements: 'requirements.txt'
+          upload_exe_with_name: 'Zordon'

.github/workflows/pylint.yml

@@ -1,23 +0,0 @@
-name: Pylint
-
-on: [push]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.10", "3.11", "3.12"]
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install pylint
-    - name: Analysing the code with pylint
-      run: |
-        pylint $(git ls-files '*.py')

README.md

@@ -2,6 +2,8 @@
 
 A tool designed for small render farms, such as those used in home studios or small businesses, to efficiently manage and run render jobs for Blender, FFMPEG, and other video renderers. It simplifies the process of distributing rendering tasks across multiple available machines, optimizing the rendering workflow for artists, animators, and video professionals.
 
+Notice: This should be considered a beta and is meant for casual / hobbiest use. Do not use in mission critical environments!
+
 ## Supported Renderers
 
 Zordon supports or plans to support the following renderers:

requirements.txt

@@ -34,4 +34,5 @@ kiwisolver>=1.4.5
 attrs>=23.2.0
 lxml>=5.1.0
 click>=8.1.7
-requests_toolbelt>=1.0.0
+requests_toolbelt>=1.0.0
+pyinstaller_versionfile>=2.1.1