Adjust release names

.github/workflows/package.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:
     - uses: actions/checkout@v2
@@ -28,6 +28,9 @@ jobs:
     - name: "Install sync_url.py"
       run: "pyinstaller sync_url.py -F"
 
+    - name: "Move artifact"
+      run: "mv dist/sync_url* dist/sync_url-${{ matrix.os }}"
+
     - uses: actions/upload-artifact@v2
       with:
         name: "Pferd Sync URL"
@@ -55,13 +58,17 @@ jobs:
     - name: "look at folder structure"
       run: "ls -lah"
 
+    - name: "Rename releases"
+      run: "mv sync_url-macos-latest pferd_sync_url_mac && mv sync_url-ubuntu-latest pferd_sync_url_linux && mv sync_url-windows-latest pferd_sync_url.exe"
+
     - name: "Create release"
       uses: softprops/action-gh-release@v1
 
     - name: "Upload release artifacts"
       uses: softprops/action-gh-release@v1
       with:
-        body: "Download sync_url (or sync_url.exe on Windows) and run it in the terminal or CMD."
+        body: "Download the correct sync_url for your platform and run it in the terminal or CMD. You might need to make it executable on Linux/Mac with `chmod +x <file>`."
         files: |
-          sync_url
-          sync_url.exe
+          pferd_sync_url_mac
+          pferd_sync_url_linux
+          pferd_sync_url.exe

README.md

@@ -25,7 +25,9 @@ use, but doesn't expose all the configuration options and tweaks a full install
 does.
 
 1. Download the `sync_url` binary from the [latest release](https://github.com/Garmelon/PFERD/releases/latest).
-2. Run the binary in your terminal (`./sync_url` or `sync_url.exe` in the CMD) to see the help and use it
+2. Run the binary in your terminal (`./sync_url` or `sync_url.exe` in the CMD) to see the help and use it. I'd recommend using the `--cookies` option.  
+  If you are on **Linux/Mac**, you need to *make the file executable* using `chmod +x <file>`.  
+  If you are on **Mac**, you need to allow this unverified program to run (see e.g. [here](https://www.switchingtomac.com/tutorials/osx/how-to-run-unverified-apps-on-macos/))
 
 ## Installation
 
@@ -34,7 +36,7 @@ Ensure that you have at least Python 3.8 installed.
 To install PFERD or update your installation to the latest version, run this
 wherever you want to install or have already installed PFERD:
 ```
-$ pip install git+https://github.com/Garmelon/PFERD@v2.4.0
+$ pip install git+https://github.com/Garmelon/PFERD@v2.4.1
 ```
 
 The use of [venv] is recommended.
@@ -57,8 +59,8 @@ $ mkdir Vorlesungen
 $ cd Vorlesungen
 $ python3 -m venv .venv
 $ .venv/bin/activate
-$ pip install git+https://github.com/Garmelon/PFERD@v2.4.0
-$ curl -O https://raw.githubusercontent.com/Garmelon/PFERD/v2.4.0/example_config.py
+$ pip install git+https://github.com/Garmelon/PFERD@v2.4.1
+$ curl -O https://raw.githubusercontent.com/Garmelon/PFERD/v2.4.1/example_config.py
 $ python3 example_config.py
 $ deactivate
 ```

setup.py

@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="PFERD",
-    version="2.4.0",
+    version="2.4.1",
     packages=find_packages(),
     install_requires=[
         "requests>=2.21.0",

sync_url.py

@@ -19,7 +19,7 @@ def main() -> None:
     parser = argparse.ArgumentParser()
     parser.add_argument("--test-run", action="store_true")
     parser.add_argument('-c', '--cookies', nargs='?', default=None, help="File to store cookies in")
-    parser.add_argument('-f', '--no-videos', nargs='?', default=None, help="Don't download videos")
+    parser.add_argument('--no-videos', nargs='?', default=None, help="Don't download videos")
     parser.add_argument('url', help="URL to the course page")
     parser.add_argument('folder', nargs='?', default=None, help="Folder to put stuff into")
     args = parser.parse_args()