Feature/support linux (#11)

* added linux

* add libjack0 for linux - attempt to fix missing audacity libs

* updated linux requirements for audacity

* attempt to fix libjackd installation

* added portaudio for linux

* portaudio shared libs only

* added tmate session

* fixed audacity config path

* increased timeout

* added portaudio

* attempt to install audacity with ubuntu packages

* print processes before killing

* attempt to wait for audacity

* keep audacity running

* removed ubuntu build for now

* run linux on my machine

* fixed audacity start for windows

* skip python installation for self hosted runner

* keep audacity running

* do not fail fast

* removed the need in pyperclip

* attempt to use xvfb

* added github actions ubuntu

* attempt to fix xvfb for github runner

* removed self hosted runner

* updated docs

* removed grep before kill

Author: unfor19

.github/workflows/test.yml

@@ -2,6 +2,21 @@ name: Tests
 
 on:
   workflow_dispatch:
+    inputs:
+      tmate_session:
+        type: boolean
+        description: "tmate session"
+        required: false
+        default: false
+      tmate_os:
+        type: choice
+        description: "tmate os"
+        required: false
+        default: "ubuntu-22.04"
+        options:
+          - "ubuntu-22.04"
+          - "windows-2022"
+          - "macos-12"
   push:
     paths-ignore:
       - "README.md"
@@ -17,12 +32,14 @@ env:
 jobs:
   tests:
     name: Tests
-    timeout-minutes: 10
+    timeout-minutes: 20
     strategy:
+      fail-fast: false
       matrix:
         include:
           - OS: windows-2022
-          - OS: macos-latest
+          - OS: macos-12
+          - OS: ubuntu-22.04
     runs-on: ${{ matrix.OS }}
     steps:
       - uses: actions/checkout@v4.1.1
@@ -40,8 +57,23 @@ jobs:
       - name: Download Audacity
         if: matrix.OS == 'windows-2022'
         run: make audacity-download
+      - name: Install Linux Requirements
+        if: matrix.OS == 'ubuntu-22.04'
+        run: |
+          sudo apt-get update && \
+          sudo apt-get install -y xvfb
       - name: Install Audacity
         run: make audacity-install
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        with:
+          limit-access-to-actor: true
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.tmate_os == matrix.OS && inputs.tmate_session && github.actor == 'unfor19' }}
+      - name: Start Xvfb - For Running GUI Apps on Linux
+        if: matrix.OS == 'ubuntu-22.04'
+        run: |
+          Xvfb :99 -ac &
+          echo "DISPLAY=:99" >> $GITHUB_ENV
       - name: Start Audacity for the first time
         run: make audacity-start
       - name: Kill Audacity

.gitignore

@@ -8,6 +8,10 @@
 *.exe
 *.zip
 
+# linux
+*.appimage
+*.AppImage
+
 # python
 *__pycache__
 ENV/

Makefile

@@ -44,6 +44,15 @@ AUDACITY_KILL_COMMAND:=killall Audacity
 AUDACITY_INSTALL_COMMAND:=brew reinstall --no-quarantine --cask audacity
 VENV_BIN_ACTIVATE:=${VENV_DIR_PATH}/bin/activate
 endif
+
+ifneq (,$(findstring Linux, $(UNAME)))
+_OS:=linux
+AUDACITY_PREFERENCES_PATH:=${HOME}/.config/audacity/audacity.cfg
+AUDACITY_KILL_COMMAND:=killall audacity
+VENV_BIN_ACTIVATE:=${VENV_DIR_PATH}/bin/activate
+AUDACITY_BIN_PATH:=/usr/bin/audacity
+AUDACITY_INSTALL_COMMAND:=sudo add-apt-repository -y ppa:ubuntuhandbook1/audacity && sudo apt-get update && sudo apt-get install -y audacity audacity-data
+endif
 # --- OS Settings --- END --------------------------------------------------------------
 
 SHELL:=${BASH_PATH}
@@ -158,14 +167,14 @@ audacity-start: validate-AUDACITY_BIN_PATH ## Start Audacity GUI app
 	@if [[ "${CI}" = "true" ]]; then \
 		echo "Sleeping 10 seconds to allow Audacity to start the pipes ..." ; \
 		sleep 10 ; \
-		echo "Hopefully Audacity is up" ; \
+		echo "Completed sleeping" ; \
 	fi
 
 audacity-test-pipe: ## Test Audacity pipe
 	python ${ROOT_DIR}/scripts/audacity_pipetest.py
 
 audacity-kill: validate-AUDACITY_KILL_COMMAND ## Kill Audacity
-	${AUDACITY_KILL_COMMAND}
+	@${AUDACITY_KILL_COMMAND}
 
 audacity-restart: audacity-kill audacity-start
 

README.md

@@ -22,6 +22,8 @@ https://github.com/unfor19/audacity-scripting/assets/15122452/080e772c-3e40-424b
 
 ## Installation
 
+Supported OS: Windows, Linux, and macOS
+
 ```
 python -m pip install audacity-scripting
 ```
@@ -34,11 +36,15 @@ python -m pip install audacity-scripting
 - [ ] Normalize audio
 - [ ] End Goal - Prepare videos for voice-clone-finetuning-vits
 
-## Known Issues
+<!-- available_commands_end -->
 
-- macOS prints Audacity's server logs (`Server sending`, `Read failed on fifo, quitting`, etc.) - documented in [JOURNEY.md](./JOURNEY.md)
+## Getting Started
 
-## Available Commands
+All the commands assume that the _Audacity_ application is up and running; That is mandatory as we communicate with [_Audacity_'s pipe](https://manual.audacityteam.org/man/scripting.html) to execute all the commands.
+
+> **NOTE**: See the [GitHub Actions Tests Workflow](https://github.com/unfor19/audacity-scripting/actions/workflows/test.yml) to check it in action.
+
+### Available Commands
 
 Auto-generated by [unfor19/replacer-action](https://github.com/marketplace/actions/replacer-action), see [readme.yml](https://github.com/unfor19/frigga/blob/master/.github/workflows/readme.yml)
 
@@ -61,20 +67,12 @@ Commands:
   version-print  Get the version from the version file.
 ```
 
-<!-- available_commands_end -->
-
-## Getting Started
-
-All the commands assume that the _Audacity_ application is up and running; That is mandatory as we communicate with [_Audacity_'s pipe](https://manual.audacityteam.org/man/scripting.html) to execute all the commands.
-
-> **NOTE**: See the [GitHub Actions Tests Workflow](https://github.com/unfor19/audacity-scripting/actions/workflows/test.yml) to check it in action.
-
 ### Remove spaces between clips
 
 This command copies the original file and removes spaces (gaps) between audio clips from the copied file.
 
 ```bash
-audacity_scripting clean-spaces --path "/path/to/my_project.aup3"
+audacity_scripting clean-spaces --file_path "/path/to/my_project.aup3"
 ```
 
 ### Send a command to Audacity
@@ -85,6 +83,10 @@ Send a command to Audacity according to [Audacity's Scripting Reference](https:/
 audacity_scripting do-command --command "Select: Tracks=0.0 Start=0.0 End=0.0"
 ```
 
+## Known Issues
+
+- macOS prints Audacity's server logs (`Server sending`, `Read failed on fifo, quitting`, etc.) - documented in [JOURNEY.md](./JOURNEY.md)
+
 ## References
 
 - [GitHub Issue - Audacity Remove spaces between clips](https://github.com/audacity/audacity/issues/3924)

requirements.txt

@@ -1,34 +1,7 @@
-build==1.0.3
-certifi==2023.11.17
-charset-normalizer==3.3.2
 click==8.1.7
 dill==0.3.7
-docutils==0.20.1
-idna==3.6
-importlib-metadata==7.0.0
-jaraco.classes==3.3.0
-keyring==24.3.0
 lib-detect-testenv==2.0.8
-markdown-it-py==3.0.0
-mdurl==0.1.2
-more-itertools==10.1.0
 multiprocess==0.70.15
-nh3==0.2.15
-packaging==23.2
-pkginfo==1.9.6
 psutil==5.9.7
-Pygments==2.17.2
-pyperclip==1.8.2
-pyproject_hooks==1.0.0
-readme-renderer==42.0
-requests==2.31.0
-requests-toolbelt==1.0.0
-rfc3986==2.0.0
-rich==13.7.0
-tomli==2.0.1
-tqdm==4.66.1
-twine==4.0.2
-urllib3==2.1.0
 wrapt==1.16.0
 wrapt-timeout-decorator==1.4.0
-zipp==3.17.0

setup.cfg

@@ -7,7 +7,6 @@ setup_requires =
 install_requires =
     click>=7.1.2
     wrapt_timeout_decorator>=1.4.0
-    pyperclip>=1.8.2
     pywin32 >= 1.0;platform_system=='Windows'
 ### ------------------------------------------------------------------
 

src/audacity_scripting/bridge/wrappers.py

@@ -1,5 +1,4 @@
 from typing import List
-import pyperclip
 from ..utils.logger import logger
 from .pipe import do_command
 from .clip import Clip
@@ -87,8 +86,7 @@ def copy_and_paste_clip(source_track_index, target_track_index, clip):
 
 def add_label_to_clip(label_iterator, sleep_seconds=0.01):
     do_command('AddLabel:')
-    pyperclip.copy(label_iterator)
-    do_command('Paste:')
+    do_command(f'SetLabel: Label="{label_iterator}" Text="{label_iterator}"')
     sleep(sleep_seconds)
     return label_iterator + 1