trackfetch 2.2.5__tar.gz → 2.2.6__tar.gz

{trackfetch-2.2.5/trackfetch.egg-info → trackfetch-2.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: trackfetch
-Version: 2.2.5
+Version: 2.2.6
 Summary: Turn a text file of songs into tagged MP3s: Spotify metadata and cover art, best-match YouTube audio via yt-dlp.
 Author: ByteMe6
 License-Expression: GPL-3.0-or-later
@@ -266,8 +266,9 @@ spotify_client_id = your-client-id
 spotify_client_secret = your-client-secret
 ```
 
-Every option above can be set there, under the `[trackfetch]` section. The
-precedence is always the same:
+Every option above can be set there, under the `[trackfetch]` section, except
+`--track`, which only makes sense on the command line. The precedence is
+always the same:
 
 1. the command-line flag,
 2. the config file,
@@ -275,8 +276,8 @@ precedence is always the same:
 
 trackfetch looks for the config file in this order: the path given with
 `--config`, the path in `$TRACKFETCH_CONFIG`, `trackfetch.ini` in the current
-directory, `$XDG_CONFIG_HOME/trackfetch/trackfetch.ini` (usually
-`~/.config/trackfetch/trackfetch.ini`) and `~/.trackfetch.ini`.
+directory, `$XDG_CONFIG_HOME/trackfetch/trackfetch.ini`,
+`~/.config/trackfetch/trackfetch.ini` and `~/.trackfetch.ini`.
 
 ### Spotify credentials
 
@@ -322,7 +323,8 @@ Daft Punk - One More Time
 Sufjan Stevens - Mystery of Love - Remastered   ← only the first " - " separates artist and title
 ```
 
-The separator is space, hyphen, space (` - `). Lines without it are skipped. See [`examples/songs.txt`](https://github.com/ByteMe6/trackfetch/blob/master/examples/songs.txt).
+The separator is space, hyphen, space (` - `). Lines without it are skipped,
+and trackfetch prints how many lines it skipped and which ones they were. See [`examples/songs.txt`](https://github.com/ByteMe6/trackfetch/blob/master/examples/songs.txt).
 
 ### Output folder
 

{trackfetch-2.2.5 → trackfetch-2.2.6}/README.md

@@ -235,8 +235,9 @@ spotify_client_id = your-client-id
 spotify_client_secret = your-client-secret
 ```
 
-Every option above can be set there, under the `[trackfetch]` section. The
-precedence is always the same:
+Every option above can be set there, under the `[trackfetch]` section, except
+`--track`, which only makes sense on the command line. The precedence is
+always the same:
 
 1. the command-line flag,
 2. the config file,
@@ -244,8 +245,8 @@ precedence is always the same:
 
 trackfetch looks for the config file in this order: the path given with
 `--config`, the path in `$TRACKFETCH_CONFIG`, `trackfetch.ini` in the current
-directory, `$XDG_CONFIG_HOME/trackfetch/trackfetch.ini` (usually
-`~/.config/trackfetch/trackfetch.ini`) and `~/.trackfetch.ini`.
+directory, `$XDG_CONFIG_HOME/trackfetch/trackfetch.ini`,
+`~/.config/trackfetch/trackfetch.ini` and `~/.trackfetch.ini`.
 
 ### Spotify credentials
 
@@ -291,7 +292,8 @@ Daft Punk - One More Time
 Sufjan Stevens - Mystery of Love - Remastered   ← only the first " - " separates artist and title
 ```
 
-The separator is space, hyphen, space (` - `). Lines without it are skipped. See [`examples/songs.txt`](https://github.com/ByteMe6/trackfetch/blob/master/examples/songs.txt).
+The separator is space, hyphen, space (` - `). Lines without it are skipped,
+and trackfetch prints how many lines it skipped and which ones they were. See [`examples/songs.txt`](https://github.com/ByteMe6/trackfetch/blob/master/examples/songs.txt).
 
 ### Output folder
 

{trackfetch-2.2.5 → trackfetch-2.2.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "trackfetch"
-version = "2.2.5"
+version = "2.2.6"
 description = "Turn a text file of songs into tagged MP3s: Spotify metadata and cover art, best-match YouTube audio via yt-dlp."
 readme = "README.md"
 license = "GPL-3.0-or-later"

{trackfetch-2.2.5 → trackfetch-2.2.6}/tests/test_inline.py

@@ -127,6 +127,44 @@ class TestInlineTracks:
         assert exc.value.code == 1
         assert "Could not parse track" in capsys.readouterr().out
 
+    def test_inline_track_without_artist_exits(self, pipeline, monkeypatch, tmp_path, capsys):
+        with pytest.raises(SystemExit) as exc:
+            run_cli(monkeypatch, " - One More Time", "-o", tmp_path / "o")
+
+        assert exc.value.code == 1
+        assert "Could not parse track" in capsys.readouterr().out
+
+    def test_inline_track_without_title_exits(self, pipeline, monkeypatch, tmp_path, capsys):
+        with pytest.raises(SystemExit) as exc:
+            run_cli(monkeypatch, "Daft Punk - ", "-o", tmp_path / "o")
+
+        assert exc.value.code == 1
+        assert "Could not parse track" in capsys.readouterr().out
+
+    def test_wrong_separator_hints_at_the_track_format(
+        self, pipeline, monkeypatch, tmp_path, capsys
+    ):
+        with pytest.raises(SystemExit) as exc:
+            run_cli(monkeypatch, "Daft Punk -One More Time", "-o", tmp_path / "o")
+
+        assert exc.value.code == 1
+        assert "Artist - Title" in capsys.readouterr().out
+
+    def test_unparsable_lines_in_a_file_are_reported(
+        self, pipeline, monkeypatch, tmp_path, capsys
+    ):
+        songs = tmp_path / "songs.txt"
+        songs.write_text(
+            "Daft Punk -One More Time\nRadiohead - Paranoid Android\n",
+            encoding="utf-8",
+        )
+
+        run_cli(monkeypatch, songs, "-o", tmp_path / "o")
+        log = capsys.readouterr().out
+
+        assert "WARNING: skipped 1 line(s)" in log
+        assert "Daft Punk -One More Time" in log
+
     def test_inline_track_uses_the_output_rules(self, pipeline, monkeypatch, tmp_path):
         out = tmp_path / "o"
         config = tmp_path / "cfg.ini"
@@ -164,4 +202,7 @@ class TestCollectSources:
         songs = tmp_path / "songs.txt"
         songs.write_text("# comment\n\nA - B\nbroken line\nC - D\n", encoding="utf-8")
 
-        assert m.read_song_file(songs) == [("A", "B"), ("C", "D")]
+        parsed, skipped = m.read_song_file(songs)
+
+        assert parsed == [("A", "B"), ("C", "D")]
+        assert skipped == ["broken line"]

{trackfetch-2.2.5 → trackfetch-2.2.6/trackfetch.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: trackfetch
-Version: 2.2.5
+Version: 2.2.6
 Summary: Turn a text file of songs into tagged MP3s: Spotify metadata and cover art, best-match YouTube audio via yt-dlp.
 Author: ByteMe6
 License-Expression: GPL-3.0-or-later
@@ -266,8 +266,9 @@ spotify_client_id = your-client-id
 spotify_client_secret = your-client-secret
 ```
 
-Every option above can be set there, under the `[trackfetch]` section. The
-precedence is always the same:
+Every option above can be set there, under the `[trackfetch]` section, except
+`--track`, which only makes sense on the command line. The precedence is
+always the same:
 
 1. the command-line flag,
 2. the config file,
@@ -275,8 +276,8 @@ precedence is always the same:
 
 trackfetch looks for the config file in this order: the path given with
 `--config`, the path in `$TRACKFETCH_CONFIG`, `trackfetch.ini` in the current
-directory, `$XDG_CONFIG_HOME/trackfetch/trackfetch.ini` (usually
-`~/.config/trackfetch/trackfetch.ini`) and `~/.trackfetch.ini`.
+directory, `$XDG_CONFIG_HOME/trackfetch/trackfetch.ini`,
+`~/.config/trackfetch/trackfetch.ini` and `~/.trackfetch.ini`.
 
 ### Spotify credentials
 
@@ -322,7 +323,8 @@ Daft Punk - One More Time
 Sufjan Stevens - Mystery of Love - Remastered   ← only the first " - " separates artist and title
 ```
 
-The separator is space, hyphen, space (` - `). Lines without it are skipped. See [`examples/songs.txt`](https://github.com/ByteMe6/trackfetch/blob/master/examples/songs.txt).
+The separator is space, hyphen, space (` - `). Lines without it are skipped,
+and trackfetch prints how many lines it skipped and which ones they were. See [`examples/songs.txt`](https://github.com/ByteMe6/trackfetch/blob/master/examples/songs.txt).
 
 ### Output folder
 

{trackfetch-2.2.5 → trackfetch-2.2.6}/trackfetch.py

@@ -226,7 +226,7 @@ def download_cover(url: str, destination: Path):
         url,
         timeout=30,
         headers={
-            "User-Agent": "trackfetch/2.2.5"
+            "User-Agent": "trackfetch/2.2.6"
         },
     )
 
@@ -875,8 +875,13 @@ def apply_config(args, parser, settings):
 
 
 def read_song_file(path: Path):
-    """Read Artist - Title pairs from a text file."""
+    """Read Artist - Title pairs from a text file.
+
+    Returns a (songs, skipped) tuple, where skipped holds the lines that
+    could not be parsed.
+    """
     songs = []
+    skipped = []
 
     for line in path.read_text(
         encoding="utf-8",
@@ -893,7 +898,10 @@ def read_song_file(path: Path):
         if song:
             songs.append(song)
 
-    return songs
+        else:
+            skipped.append(line)
+
+    return songs, skipped
 
 
 def collect_sources(args, settings):
@@ -921,10 +929,19 @@ def collect_sources(args, settings):
             sources.append(path)
 
         elif " - " in item:
+            if not parse_song(item):
+                raise ValueError(
+                    f"Could not parse track: {item} "
+                    f"(expected 'Artist - Title')"
+                )
+
             sources.append(item)
 
         else:
-            raise ValueError(f"Input file not found: {item}")
+            raise ValueError(
+                f"Input file not found: {item} "
+                f"(if this is a track, use the 'Artist - Title' format)"
+            )
 
     for group in args.track or []:
         for spec in group:
@@ -944,7 +961,16 @@ def main():
         description=(
             "Download music using Spotify metadata "
             "and YouTube audio"
-        )
+        ),
+        epilog=(
+            "A config file with the defaults can be used as well. It is "
+            "looked up in --config, $TRACKFETCH_CONFIG, ./trackfetch.ini, "
+            "$XDG_CONFIG_HOME/trackfetch/trackfetch.ini, "
+            "~/.config/trackfetch/trackfetch.ini and ~/.trackfetch.ini. "
+            "A command-line flag wins over the config file, and the config "
+            "file wins over the built-in default."
+        ),
+        formatter_class=argparse.RawDescriptionHelpFormatter,
     )
 
     parser.add_argument(
@@ -984,7 +1010,10 @@ def main():
         "--config",
         type=Path,
         default=None,
-        help="Path to a config file",
+        help=(
+            "Path to a config file "
+            "(default: auto-detected, see below)"
+        ),
     )
 
     parser.add_argument(
@@ -992,21 +1021,21 @@ def main():
         "--format",
         choices=list(AUDIO_FORMATS),
         default=None,
-        help="Audio format",
+        help="Audio format (default: m4a)",
     )
 
     parser.add_argument(
         "--title-only",
         action="store_true",
         default=None,
-        help="Use only title in filename",
+        help="Use only title in filename (default: off)",
     )
 
     parser.add_argument(
         "--delay",
         type=float,
         default=None,
-        help="Delay between songs in seconds",
+        help="Delay between songs in seconds (default: 1.0)",
     )
 
     parser.add_argument(
@@ -1077,10 +1106,17 @@ def main():
     failed_file = args.output / "failed.txt"
 
     songs = []
+    skipped = []
 
     for source in sources:
         if isinstance(source, Path):
-            songs.extend(read_song_file(source))
+            file_songs, file_skipped = read_song_file(source)
+
+            songs.extend(file_songs)
+
+            skipped.extend(
+                (source, line) for line in file_skipped
+            )
 
         else:
             song = parse_song(source)
@@ -1093,6 +1129,18 @@ def main():
     print(f"Found {len(songs)} songs")
     print(f"Already completed: {len(done)}")
 
+    if skipped:
+        print(
+            f"WARNING: skipped {len(skipped)} line(s) "
+            f"that are not 'Artist - Title':"
+        )
+
+        for path, line in skipped[:5]:
+            print(f"  {path}: {line}")
+
+        if len(skipped) > 5:
+            print(f"  ... and {len(skipped) - 5} more")
+
     if config_path:
         print(f"Config: {config_path}")