rhythmsync 1.0.0__tar.gz → 1.1.0__tar.gz

rhythmsync-1.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KON/NOS R
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rhythmsync-1.1.0/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: rhythmsync
+Version: 1.1.0
+Summary: CLI music player with synchronized lyrics (LRC) support
+Author: KON/NOS R
+License: MIT
+Keywords: music,cli,audio,lrc,player,terminal
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Environment :: Console
+Classifier: Operating System :: Unix
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: MacOS
+Classifier: Topic :: Multimedia :: Sound/Audio :: Players
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pygame
+Requires-Dist: rich
+Requires-Dist: mutagen
+Dynamic: license-file
+
+# RhythmSync
+
+CLI audio player that plays music while displaying synchronized lyrics (LRC).
+
+---
+
+## Features
+
+- Play audio files in various modes
+- Display synchronized lyrics during playback
+- Show song metadata tags
+- Styled terminal music player UI
+- Convert audio files to other formats using FFmpeg
+- Player controls
+  - Pause (`SPACE`)
+  - Next (`RIGHT Arrow`)
+  - Previous (`LEFT Arrow`)
+
+---
+
+## Requirements
+
+- Python 3.8+
+- FFmpeg (optional, for conversion feature)
+
+---
+
+## Compatibility
+
+RhythmSync is currently intended for UNIX-based systems (Linux/macOS).
+All versions after **1.0.0** don't work with non-UNIX systems
+
+---
+
+## Installation and Usage
+
+- PyPI page: [Click here](https://pypi.org/project/rhythmsync/)
+
+<br>
+
+- Install the CLI application
+```
+pip install rhythmsync
+```
+
+- Launch the CLI application:
+```
+rhythmsync
+```
+
+---
+
+## Supported Audio Formats
+
+- `.mp3`
+- `.flac`
+- `.wav`
+- `.ogg`
+
+### Notes
+
+- Other audio formats might work, but full functionality is not guaranteed.
+
+---
+
+## Lyrics Sync
+
+RhythmSync reads embedded lyric metadata from audio files.
+
+Supported tags include:
+- `SYLT`, `SYLT::eng`
+- `LYRICS`, `LYRICS:eng`
+- `LYRICS-ENG`, `LYRICS_EN`
+- `LYRICS_SYNCED`, `SYNCEDLYRICS`
+
+### LRC Format
+
+```
+[00:12.34] First line
+[00:15.67] Second line
+[00:18.90] Third line
+```
+
+- Format: `[mm:ss.xx] Line`
+
+### Notes
+
+- If no lyrics are found, a placeholder message is shown.
+
+---
+
+## Commands
+
+### General
+
+- `help` - Lists all available commands.
+- `ls` - Lists all files and directories in the current working directory.
+- `ls {path}` - Lists all files and directories in the specified directory.
+- `cd {path}` - Changes the current working directory to the specified directory.
+- `clear` - Clears the terminal.
+
+### Playback
+
+- `play {path}` - Plays a single audio file once.
+- `play -r {path}` - Plays a single audio file in a loop until stopped (Ctrl+C).
+- `play -d {directory}` - Plays all supported audio files in the specified directory (non-recursive) in alphabetical order.
+- `play -dr {directory}` - Plays all supported audio files in the specified directory (non-recursive) in alphabetical order and loops until stopped (Ctrl+C).
+- `play -ds {directory}` - Plays all supported audio files in the specified directory (non-recursive) in shuffled order and loops until stopped (Ctrl+C).
+- `play -D {path}` - Plays all supported audio files in the specified directory (recursive) in alphabetical order.
+- `play -Dr {path}` - Plays all supported audio files in the specified directory (recursive) in alphabetical order and loops until stopped (Ctrl+C).
+- `play -Ds {path}` - Plays all supported audio files in the specified directory (recursive) in shuffled order and loops until stopped (Ctrl+C).
+
+### Metadata
+
+- `info {path}` - Displays all available metadata.
+- `info {path} [tags]` - Displays only given metadata tags.
+
+### Converter
+
+- `convert {input path} {output path}` - Converts an audio file to another format (FFmpeg required).
+
+---
+
+## Notes
+
+- Paths containing spaces must be wrapped in quotes or escaped with backslashes:
+
+```
+play "My Music/song.mp3"
+play My\ Music/song.mp3
+```
+
+- The **convert** command uses FFmpeg and may alter or corrupt metadata
+
+- Use `Ctrl+C` to stop playback or exit the app

rhythmsync-1.1.0/README.md

@@ -0,0 +1,135 @@
+# RhythmSync
+
+CLI audio player that plays music while displaying synchronized lyrics (LRC).
+
+---
+
+## Features
+
+- Play audio files in various modes
+- Display synchronized lyrics during playback
+- Show song metadata tags
+- Styled terminal music player UI
+- Convert audio files to other formats using FFmpeg
+- Player controls
+  - Pause (`SPACE`)
+  - Next (`RIGHT Arrow`)
+  - Previous (`LEFT Arrow`)
+
+---
+
+## Requirements
+
+- Python 3.8+
+- FFmpeg (optional, for conversion feature)
+
+---
+
+## Compatibility
+
+RhythmSync is currently intended for UNIX-based systems (Linux/macOS).
+All versions after **1.0.0** don't work with non-UNIX systems
+
+---
+
+## Installation and Usage
+
+- PyPI page: [Click here](https://pypi.org/project/rhythmsync/)
+
+<br>
+
+- Install the CLI application
+```
+pip install rhythmsync
+```
+
+- Launch the CLI application:
+```
+rhythmsync
+```
+
+---
+
+## Supported Audio Formats
+
+- `.mp3`
+- `.flac`
+- `.wav`
+- `.ogg`
+
+### Notes
+
+- Other audio formats might work, but full functionality is not guaranteed.
+
+---
+
+## Lyrics Sync
+
+RhythmSync reads embedded lyric metadata from audio files.
+
+Supported tags include:
+- `SYLT`, `SYLT::eng`
+- `LYRICS`, `LYRICS:eng`
+- `LYRICS-ENG`, `LYRICS_EN`
+- `LYRICS_SYNCED`, `SYNCEDLYRICS`
+
+### LRC Format
+
+```
+[00:12.34] First line
+[00:15.67] Second line
+[00:18.90] Third line
+```
+
+- Format: `[mm:ss.xx] Line`
+
+### Notes
+
+- If no lyrics are found, a placeholder message is shown.
+
+---
+
+## Commands
+
+### General
+
+- `help` - Lists all available commands.
+- `ls` - Lists all files and directories in the current working directory.
+- `ls {path}` - Lists all files and directories in the specified directory.
+- `cd {path}` - Changes the current working directory to the specified directory.
+- `clear` - Clears the terminal.
+
+### Playback
+
+- `play {path}` - Plays a single audio file once.
+- `play -r {path}` - Plays a single audio file in a loop until stopped (Ctrl+C).
+- `play -d {directory}` - Plays all supported audio files in the specified directory (non-recursive) in alphabetical order.
+- `play -dr {directory}` - Plays all supported audio files in the specified directory (non-recursive) in alphabetical order and loops until stopped (Ctrl+C).
+- `play -ds {directory}` - Plays all supported audio files in the specified directory (non-recursive) in shuffled order and loops until stopped (Ctrl+C).
+- `play -D {path}` - Plays all supported audio files in the specified directory (recursive) in alphabetical order.
+- `play -Dr {path}` - Plays all supported audio files in the specified directory (recursive) in alphabetical order and loops until stopped (Ctrl+C).
+- `play -Ds {path}` - Plays all supported audio files in the specified directory (recursive) in shuffled order and loops until stopped (Ctrl+C).
+
+### Metadata
+
+- `info {path}` - Displays all available metadata.
+- `info {path} [tags]` - Displays only given metadata tags.
+
+### Converter
+
+- `convert {input path} {output path}` - Converts an audio file to another format (FFmpeg required).
+
+---
+
+## Notes
+
+- Paths containing spaces must be wrapped in quotes or escaped with backslashes:
+
+```
+play "My Music/song.mp3"
+play My\ Music/song.mp3
+```
+
+- The **convert** command uses FFmpeg and may alter or corrupt metadata
+
+- Use `Ctrl+C` to stop playback or exit the app

{rhythmsync-1.0.0 → rhythmsync-1.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rhythmsync"
-version = "1.0.0"
+version = "1.1.0"
 description = "CLI music player with synchronized lyrics (LRC) support"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -21,5 +21,19 @@ dependencies = [
   "mutagen"
 ]
 
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Environment :: Console",
+  "Operating System :: Unix",
+  "Operating System :: POSIX",
+  "Operating System :: MacOS",
+  "Topic :: Multimedia :: Sound/Audio :: Players",
+  "Topic :: Utilities"
+]
+
 [project.scripts]
-rhythmsync = "rhythmsync.main:main"
+rhythmsync = "rhythmsync.main:main"
+
+[tool.setuptools]
+packages = ["rhythmsync"]

rhythmsync-1.1.0/rhythmsync/command_parser.py

@@ -0,0 +1,217 @@
+import os
+from rich.console import Console
+console = Console()
+from pathlib import Path
+from random import shuffle
+import shlex
+
+import rhythmsync.player as player
+import rhythmsync.metadata as metadata
+import rhythmsync.converter as converter
+import rhythmsync.terminal_disp as terminal_disp
+
+
+def parse_command(raw_command):
+    if raw_command.strip():
+        command = shlex.split(raw_command)
+        command_parts = len(command)
+    
+        #help command
+        if command[0] == "help" and command_parts == 1:
+            terminal_disp.help_msg()
+        
+        #list command
+        elif command[0] == "ls":
+            if command_parts == 1:
+                console.print(f"[blue]{"   ".join(os.listdir())}", highlight=False)
+            elif command_parts == 2:
+                directory = str(Path(command[1]).expanduser().resolve())
+                if os.path.exists(directory):
+                    console.print(f"[blue]{"   ".join(os.listdir(directory))}", highlight=False)
+            else:
+                print("Please enter valid parameters.")
+
+        #change directory command
+        elif command[0] == "cd" and command_parts == 2:
+            directory = str(Path(command[1]).expanduser().resolve())
+            if os.path.exists(directory):
+                os.chdir(directory)
+            else:
+                print("Please enter a valid file path.")
+
+        #clear command
+        elif command[0] == "clear" and command_parts == 1:
+            terminal_disp.clear_screen()
+            terminal_disp.logo()
+        
+        #play command
+        elif command[0] == "play":
+            if command_parts == 2: #single
+                file_path = str(Path(command[1]).expanduser().resolve())
+                if os.path.exists(file_path):
+                    repeat = True
+                    while repeat:
+                        repeat = player.run_player(file_path, "single")[0]
+                    terminal_disp.clear_screen()
+                    terminal_disp.logo()
+                else:
+                    print("Please enter a valid file path.")
+
+            elif command_parts == 3:
+                par = command[1]
+                file_path = str(Path(command[2]).expanduser().resolve())
+                if os.path.exists(file_path):
+                    if par == "-r": #single repeat
+                        repeat = True
+                        while repeat:
+                            repeat = player.run_player(file_path, "repeat")[0]
+                        terminal_disp.clear_screen()
+                        terminal_disp.logo()
+
+                    elif par[:2] == "-d": #directory modes
+                        extensions = (".mp3", ".flac", ".wav", ".ogg")
+                        audio_files = [
+                        f for f in Path(file_path).iterdir()
+                        if f.suffix.lower() in extensions
+                        ]
+
+                        if par == "-d": #dir
+                            if audio_files:
+                                audio_files.sort()
+                                repeat = True
+                                i = 1
+                                while i-1 < len(audio_files) and i >= 1 and repeat:
+                                    for j in range(i-1, len(audio_files)):
+                                        repeat, i = player.run_player(audio_files[j], f"directory {i} {len(audio_files)}")
+                                        if i < 1:
+                                            i = 1
+                                        break
+                                terminal_disp.clear_screen()
+                                terminal_disp.logo()
+                            else:
+                                print("No audio files found.")
+
+                        elif par == "-dr": #dir repeat
+                            if audio_files:
+                                audio_files.sort()
+                                repeat = True
+                                i = 1
+                                while repeat:
+                                    for j in range(i-1, len(audio_files)):
+                                        repeat, i = player.run_player(audio_files[j], f"directory {i} {len(audio_files)}")
+                                        if i < 1:
+                                            i = len(audio_files)
+                                        elif i > len(audio_files):
+                                            i = 1
+                                        break
+                                terminal_disp.clear_screen()
+                                terminal_disp.logo()
+                            else:
+                                print("No audio files found.")
+
+                        elif par == "-ds": #dir shuffle
+                            if audio_files:
+                                shuffle(audio_files)
+                                repeat = True
+                                i = 1
+                                while repeat:
+                                    for j in range(i-1, len(audio_files)):
+                                        repeat, i = player.run_player(audio_files[j], f"directory {i} {len(audio_files)}")
+                                        if i < 1:
+                                            i = len(audio_files)
+                                        elif i > len(audio_files):
+                                            i = 1
+                                        break
+                                terminal_disp.clear_screen()
+                                terminal_disp.logo()
+                            else:
+                                print("No audio files found.")
+                    
+                    elif par[:2] == "-D": #recursive modes
+                        extensions = (".mp3", ".flac", ".wav", ".ogg")
+                        audio_files = [
+                            f for f in Path(file_path).rglob("*")
+                            if f.suffix.lower() in extensions
+                        ]
+
+                        if par == "-D": #dirs
+                            if audio_files:
+                                audio_files.sort()
+                                repeat = True
+                                i = 1
+                                while i-1 < len(audio_files) and i >= 1 and repeat:
+                                    for j in range(i-1, len(audio_files)):
+                                        repeat, i = player.run_player(audio_files[j], f"directory {i} {len(audio_files)}")
+                                        if i < 1:
+                                            i = 1
+                                        break
+                                terminal_disp.clear_screen()
+                                terminal_disp.logo()
+                            else:
+                                print("No audio files found.")
+
+                        elif par == "-Dr": #dir repeat
+                            if audio_files:
+                                audio_files.sort()
+                                repeat = True
+                                i = 1
+                                while repeat:
+                                    for j in range(i-1, len(audio_files)):
+                                        repeat, i = player.run_player(audio_files[j], f"directory {i} {len(audio_files)}")
+                                        if i < 1:
+                                            i = len(audio_files)
+                                        elif i > len(audio_files):
+                                            i = 1
+                                        break
+                                terminal_disp.clear_screen()
+                                terminal_disp.logo()
+                            else:
+                                print("No audio files found.")
+
+                        elif par == "-Ds": #dir shuffle
+                            if audio_files:
+                                shuffle(audio_files)
+                                repeat = True
+                                i = 1
+                                while repeat:
+                                    for j in range(i-1, len(audio_files)):
+                                        repeat, i = player.run_player(audio_files[j], f"directory {i} {len(audio_files)}")
+                                        if i < 1:
+                                            i = len(audio_files)
+                                        elif i > len(audio_files):
+                                            i = 1
+                                        break
+                                terminal_disp.clear_screen()
+                                terminal_disp.logo()
+                            else:
+                                print("No audio files found.")
+                else:
+                    print("Please enter a valid file path.") 
+            else:
+                print("Please enter a valid file path and parameters.")
+        
+        #info command
+        elif command[0] == "info":
+            if command_parts >= 2:
+               file_path = Path(command[1]).expanduser().resolve()
+               par = tuple(command[2:]) or None
+               if os.path.exists(file_path):
+                   console.print(metadata.get_metadata(file_path, par), highlight=False)
+               else:
+                   print("Please enter a valid file path.")
+            else:
+                print("Please enter a valid file path and parameters.")
+
+        #convert command
+        elif command[0] == "convert" and command_parts == 3:
+            input_path = Path(command[1]).expanduser().resolve()
+            output_path = Path(command[2]).expanduser().resolve()
+            output_dir = Path("/".join(command[2].split("/")[:-1])).expanduser().resolve()
+            if os.path.exists(input_path) and os.path.exists(output_dir):
+                converter.convert(input_path, output_path)
+            else:
+                print("Please enter valid file paths.")
+
+        #invalid command
+        else:
+            print("Invalid command! Enter 'help' to display command list.")

rhythmsync-1.1.0/rhythmsync/converter.py

@@ -0,0 +1,21 @@
+import subprocess
+
+
+#converts audio file to other formats
+def convert(input_file, output_file):
+    try:
+        subprocess.run([
+            "ffmpeg",
+            "-y",
+            "-i", input_file,
+            output_file
+        ], check=True)
+
+        print(f"Converted successfully:")
+        print(f"{input_file} -> {output_file}")
+
+    except FileNotFoundError:
+        print("FFmpeg is not installed.")
+
+    except subprocess.CalledProcessError:
+        print("Conversion failed.")