Merge branch 'nathom:dev' into dev

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -49,7 +49,7 @@ body:
     attributes:
       label: Config File
       description: |
-        Find the config file using `rip config --open` and paste the contents here. 
+        Find the config file using `rip config open` and paste the contents here. 
         Make sure you REMOVE YOUR CREDENTIALS!
       render: toml
       placeholder: Contents of config.toml

.github/workflows/pytest.yml

@@ -0,0 +1,41 @@
+name: Python Poetry Test
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      name: Check out repository code
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'  # Specify the Python version
+
+    - name: Install and configure Poetry
+      uses: snok/install-poetry@v1
+      with:
+        version: 1.5.1
+        virtualenvs-create: false
+        virtualenvs-in-project: true
+        installer-parallel: true
+
+    - name: Install dependencies
+      run: poetry install
+
+    - name: Run tests
+      run: poetry run pytest
+
+    - name: Success message
+      if: success()
+      run: echo "Tests passed successfully!"

.github/workflows/ruff.yml

@@ -0,0 +1,11 @@
+name: Ruff
+on: [push, pull_request]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1
+      - uses: chartboost/ruff-action@v1
+        with:
+          args: 'format --check'

README.md

@@ -33,9 +33,9 @@ When you type
 rip
 ```
 
-it should show the main help page. If you have no idea what these mean, or are having other issues installing, check out the [detailed installation instructions](https://github.com/nathom/streamrip/wiki#detailed-installation-instructions).  
+it should show the main help page. If you have no idea what these mean, or are having other issues installing, check out the [detailed installation instructions](https://github.com/nathom/streamrip/wiki#detailed-installation-instructions).
 
-For Arch Linux users, an AUR package exists. Make sure to install required packages from the AUR before using `makepkg` or use an AUR helper to automatically resolve them.  
+For Arch Linux users, an AUR package exists. Make sure to install required packages from the AUR before using `makepkg` or use an AUR helper to automatically resolve them.
 ```
 git clone https://aur.archlinux.org/streamrip.git
 cd streamrip
@@ -46,7 +46,6 @@ makepkg -si
 paru -S streamrip
 ```
 
-
 ### Streamrip beta
 
 If you want to get access to the latest and greatest features without waiting for a new release, install
@@ -72,17 +71,13 @@ Download multiple albums from Qobuz
 rip url https://www.qobuz.com/us-en/album/back-in-black-ac-dc/0886444889841 https://www.qobuz.com/us-en/album/blue-train-john-coltrane/0060253764852
 ```
 
-
-
 Download the album and convert it to `mp3`
 
 ```bash
-rip url --codec mp3 https://open.qobuz.com/album/0060253780968
+rip --codec mp3 url https://open.qobuz.com/album/0060253780968
 ```
 
-
-
-To set the maximum quality, use the `--max-quality` option to `0, 1, 2, 3, 4`:
+To set the maximum quality, use the `--quality` option to `0, 1, 2, 3, 4`:
 
 | Quality ID | Audio Quality         | Available Sources                            |
 | ---------- | --------------------- | -------------------------------------------- |
@@ -92,14 +87,13 @@ To set the maximum quality, use the `--max-quality` option to `0, 1, 2, 3, 4`:
 | 3          | 24 bit, ≤ 96 kHz      | Tidal (MQA), Qobuz, SoundCloud (rarely)      |
 | 4          | 24 bit, ≤ 192 kHz     | Qobuz                                        |
 
-
 ```bash
-rip url --quality 3 https://tidal.com/browse/album/147569387
+rip --quality 3 url https://tidal.com/browse/album/147569387
 ```
 
-> Using `4` is generally a waste of space. It is impossible for humans to perceive the between sampling rates higher than 44.1 kHz. It may be useful if you're processing/slowing down the audio.
+> Using `4` is generally a waste of space. It is impossible for humans to perceive the difference between sampling rates higher than 44.1 kHz. It may be useful if you're processing/slowing down the audio.
 
-Search for albums matching `lil uzi vert` on SoundCloud
+Search for playlists matching `rap` on Tidal
 
 ```bash
 rip search tidal playlist 'rap'
@@ -125,9 +119,7 @@ For more customization, see the config file
 rip config open
 ```
 
-
-
-If you're confused about anything, see the help pages. The main help pages can be accessed by typing `rip` by itself in the command line. The help pages for each command can be accessed with the `-help` flag. For example, to see the help page for the `url` command, type
+If you're confused about anything, see the help pages. The main help pages can be accessed by typing `rip` by itself in the command line. The help pages for each command can be accessed with the `--help` flag. For example, to see the help page for the `url` command, type
 
 ```
 rip url --help
@@ -139,7 +131,6 @@ rip url --help
 
 For more in-depth information about `streamrip`, see the help pages and the [wiki](https://github.com/nathom/streamrip/wiki/).
 
-
 ## Contributions
 
 All contributions are appreciated! You can help out the project by opening an issue
@@ -164,7 +155,7 @@ Please document any functions or obscure lines of code.
 
 ### The Wiki
 
-To help out `streamrip` users that may be having trouble, consider contributing some information to the wiki. 
+To help out `streamrip` users that may be having trouble, consider contributing some information to the wiki.
 Nothing is too obvious and everything is appreciated.
 
 ## Acknowledgements
@@ -178,8 +169,6 @@ Thanks to Vitiko98, Sorrow446, and DashLt for their contributions to this projec
 - [Tidal-Media-Downloader](https://github.com/yaronzz/Tidal-Media-Downloader)
 - [scdl](https://github.com/flyingrub/scdl)
 
-
-
 ## Disclaimer
 
 I will not be responsible for how **you** use `streamrip`. By using `streamrip`, you agree to the terms and conditions of the Qobuz, Tidal, and Deezer APIs.