commit 8fbaf50552dc3144f50fb20c919921677f7efa9e
parent 28665441c9cd73f9ee0a91491a2be77d1646bb7f
Author: gearsix <gearsix@tuta.io>
Date: Mon, 7 Nov 2022 13:29:20 +0000
updated docs
Diffstat:
3 files changed, 42 insertions(+), 41 deletions(-)
diff --git a/BUGS.txt b/BUGS.txt
@@ -14,6 +14,7 @@
#regex-improvement
+
**2021-06-22** [*] handle multiple timestamp regex matches
When there are multiple matches for the timestamp regex in a line, the last match is used as the timestamp.
diff --git a/BUILDING.txt b/BUILDING.txt
@@ -0,0 +1,32 @@
+BUILDING SYA-PYQT
+
+ Being a Python script, building a binary from it can be a pain.
+
+ This guide is intended for anyone looking to build 'sya-pyqt.py' as the
+ portable, distributed 'sya-pyqt' binary. Providing a portable binary
+ provides the advantages of bundling all the resources used, making it
+ easier to distribute.
+
+ The following guide expects you to download ffmpeg (ffmpeg.org) and
+ yt-dlp (github.com/yt-dlp/yt-dlp) binaries for your system, which
+ 'sya-pyqt' uses the bundled versions of.
+
+ To do this, PyInstaller is used (pyinstaller.org/), which can be
+ installed using pip: ("pip install pyinstaller").
+
+ The following command will build the binary:
+
+ pyinstaller ./sya-pyqt.py -F --windowed --add-data "folder.png:." --add-data "./file.png:." --add-data "./sya.png:." --add-data "./ffmpeg:." --add-data "./yt-dlp:."
+
+ On Windows, you'll need to use slightly different syntax:
+
+ pyinstaller sya-pyqt.py -F --windowed --add-data ".\folder.png;." --add-data ".\file.png;." --add-data ".\sya.png;." --add-data ".\ffmpeg.exe;." --add-data ".\yt-dlp.exe;."
+
+ Both 'ffmpeg' and 'yt-dlp' should be the filepath of previously downloaded binaries.
+
+
+NOTES
+
+ I found on windows that I had to provide the following argument to bundle the PyQt5 dependency.
+
+ --paths C:\Programs\Python311\Lib\site-packages\PyQt5\Qt5\
diff --git a/README.txt b/README.txt
@@ -1,13 +1,16 @@
NAME
sya - split youtube audio
+
SYNOPSIS
sya.py [OPTIONS] TRACKLIST
+
DESCRIPTION
sya downloads, converts and splits youtube videos into multiple audio
tracks using `youtube-dl` and `ffmpeg`.
+
OPTIONS
-h --help displays help message
-k, --keep
@@ -21,9 +24,10 @@ OPTIONS
-q, --quality [QUALITY]
specify the --audio-quality argument to pass (default: 320K)
--youtube-dl [PATH]
- path of the youtube-dl binary to use
+ path of the youtube-dl binary to use. Not available in 'sya-pyqt' binary.
--ffmpeg [PATH]
- path of the ffmpeg binary to use
+ path of the ffmpeg binary to use. Not available in 'sya-pyqt' binary.
+
TRACKLIST
TRACKLIST files should be text file that has the URL/v=code of the youtube video to
@@ -67,51 +71,15 @@ TRACKLIST
Spazzmatica Polka (1:26:01)
-BUILDING
- It's more convenient to build sya-pyqt into a single binary (bundled
- with assets & libraries).
- To do this 'pyinstaller' seems most convenient (installed via "pip
- install pyinstaller"):
-
- pyinstaller sya-pyqt.py -F --windowed --add-data "folder.png:." --add-data "file.png:."
-
- On Windows, you'll need to use the following:
-
- pyinstaller sya-pyqt.py -F --windowed --add-data "folder.png;." --add-data "file.png;."
-
- This process also works to create binaries for the terminal version
- of the tool (sya.py). When building that version, the "--windowed"
- and "--add-data "folder.png:."" arguments don't need to be included.
-
-INSTALL
- There are a lot of ways to install this tool.
-
- For most cases, you can just download and run the distribution binaries.
-
- FROM SOURCE
- This method should work on all platforms to install it for the current
- user.
- Note that there are a lot of ways to install a python package from
- source, this is just one.
-
- python3 ./setup.py install --user --record install.txt
-
- The "--user" argument will only install sya for the current user. Remove
- it to install the tool to the system, although note that this will require
- admin permissions.
-
- This will create a 'install.txt' file in the current directory. This file
- contains all the files installed to your system. To uninstall using just
- remove all of these files.
-
THANKS
These two tools do all the heavy lifting:
- youtube-dl (https://ytdl-org.github.io/youtube-dl/)
- ffmpeg (https://ffmpeg.org)
- And the cool icons used are from the MicroMoon theme for Palemoon:
+ And the cool folder & file icons used are from the Palemoon MicroMoon theme:
https://repo.palemoon.org/Lootyhoof/micromoon
+
DISCLAIMER
It should go without saying, don't use this for pirating music.
If you do, you're a dick and you're working against whatever band/label you
@@ -121,6 +89,6 @@ DISCLAIMER
audio files of the albums you've bought, properly tagged and available for
re-download whenever you need.
+
AUTHORS
- gearsix (gearsix@tuta.io)
-
