karaoke-lyrics-processor 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

karaoke_lyrics_processor/cli.py

@@ -20,6 +20,14 @@ def main():
     package_version = pkg_resources.get_distribution("karaoke-lyrics-processor").version
     parser.add_argument("-v", "--version", action="version", version=f"%(prog)s {package_version}")
     parser.add_argument("-d", "--debug", action="store_true", help="Enable debug mode, setting log level to DEBUG.")
+    parser.add_argument("-o", "--output", type=str, help="Optional: Specify the output filename for the processed lyrics.")
+    parser.add_argument(
+        "-l",
+        "--line_length",
+        type=int,
+        default=36,
+        help="Optional: Specify the maximum line length for the processed lyrics. Default is 36.",
+    )
     parser.add_argument("filename", type=str, help="The path to the file containing the song lyrics to process.")
 
     args = parser.parse_args()
@@ -37,10 +45,17 @@ def main():
     logger.info(f"Karaoke Lyrics processor beginning with input file: {args.filename}")
 
     filename_parts = args.filename.rsplit(".", 1)
-    output_filename = f"{filename_parts[0]} (Lyrics Processed).{filename_parts[1]}"
+    if args.output:
+        output_filename = args.output
+    else:
+        output_filename = f"{filename_parts[0]} (Lyrics Processed).{filename_parts[1]}"
 
     processor = KaraokeLyricsProcessor(
-        log_level=log_level, log_formatter=log_formatter, input_filename=args.filename, output_filename=output_filename
+        log_level=log_level,
+        log_formatter=log_formatter,
+        input_filename=args.filename,
+        output_filename=output_filename,
+        max_line_length=args.line_length,
     )
     processor.process()
     processor.write_to_output_file()

karaoke_lyrics_processor-0.1.1.dist-info/METADATA

@@ -0,0 +1,88 @@
+Metadata-Version: 2.1
+Name: karaoke-lyrics-processor
+Version: 0.1.1
+Summary: Process song lyrics to prepare them for karaoke video production, e.g. by splitting long lines
+Home-page: https://github.com/karaokenerds/karaoke-lyrics-processor
+License: MIT
+Author: Andrew Beveridge
+Author-email: andrew@beveridge.uk
+Requires-Python: >=3.9,<3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pyperclip (>=1.8)
+Project-URL: Documentation, https://github.com/karaokenerds/karaoke-lyrics-processor/blob/main/README.md
+Project-URL: Repository, https://github.com/karaokenerds/karaoke-lyrics-processor
+Description-Content-Type: text/markdown
+
+# Karaoke Lyrics Processor 🎶 ✍️
+
+Karaoke Lyrics Processor is a tool to prepare song lyrics for karaoke video production. 
+
+It processes lyrics by splitting long lines, handling parentheses, and ensuring that each line fits within a specified maximum length. 
+This tool is especially useful for creating karaoke tracks where timing and line length are crucial for readability.
+
+## Features
+
+- **Line Splitting**: Automatically splits long lines of lyrics to ensure they fit within a specified maximum length, making them more readable and suitable for karaoke display.
+- **Intelligent Splitting**: Finds the best split points in lines, considering punctuation and logical breaks in the lyrics.
+- **Parentheses Handling**: Processes lines containing parentheses appropriately, ensuring that the lyrical flow is maintained.
+- **Clipboard Support**: Copies the processed lyrics to the clipboard for easy pasting into video production software or other applications.
+- **Debug Mode**: Offers a debug mode for detailed logging, helping with troubleshooting and fine-tuning the processing.
+
+## Installation
+
+To install the Karaoke Lyrics Processor, ensure you have Python 3.9 or newer in your environment. 
+
+This package is available on PyPI and can be installed using pip. Run the following command in your terminal:
+
+```bash
+pip install karaoke-lyrics-processor
+```
+
+## Usage (CLI)
+
+To process a file containing song lyrics, use the following command:
+
+```bash
+karaoke-lyrics-processor <path_to_lyrics_file>
+```
+
+By default, this will create a new file in your current directory with `(Lyrics Processed)` in the filename containing the processed lyrics.
+
+### Command line options
+
+```bash
+usage: karaoke-lyrics-processor [-h] [-v] [-d] [-o OUTPUT] [-l LINE_LENGTH] filename
+
+Process song lyrics to prepare them for karaoke video production, e.g. by splitting long lines
+
+positional arguments:
+  filename                                   The path to the file containing the song lyrics to process.
+
+options:
+  -h, --help                                 show this help message and exit
+  -v, --version                              show program's version number and exit
+  -d, --debug                                Enable debug mode, setting log level to DEBUG.
+  -o OUTPUT, --output OUTPUT                 Optional: Specify the output filename for the processed lyrics.
+  -l LINE_LENGTH, --line_length LINE_LENGTH  Optional: Specify the maximum line length for the processed lyrics. Default is 36.
+```
+
+## Contributing 🤝
+
+Contributions are very much welcome! Please fork the repository and submit a pull request with your changes, and I'll try to review, merge and publish promptly!
+
+- This project is 100% open-source and free for anyone to use and modify as they wish. 
+- If the maintenance workload for this repo somehow becomes too much for me I'll ask for volunteers to share maintainership of the repo, though I don't think that is very likely
+
+## License 📄
+
+This project is licensed under the MIT [License](LICENSE).
+
+## Contact 💌
+
+For questions or feedback, please raise an issue or reach out to @beveradb ([Andrew Beveridge](mailto:andrew@beveridge.uk)) directly.
+

karaoke_lyrics_processor-0.1.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+karaoke_lyrics_processor/__init__.py,sha256=rLRkJQi61qkRiNXdlTleE3ahJ1oBKcghYVkz64x7IIg,62
+karaoke_lyrics_processor/cli.py,sha256=yCbmQBTRHvSV0tjRf2WmWmYHXjYzlsPXd_EfZIRYm_c,2427
+karaoke_lyrics_processor/karaoke_lyrics_processor.py,sha256=M8CE5l_aIyzjWwiu1lOqFkOkBB7R38JV8oqHFS-wklQ,6615
+karaoke_lyrics_processor-0.1.1.dist-info/LICENSE,sha256=BiPihPDxhxIPEx6yAxVfAljD5Bhm_XG2teCbPEj_m0Y,1069
+karaoke_lyrics_processor-0.1.1.dist-info/METADATA,sha256=Yi8rovwQ9alrNvFYQeOxvGD5z7v6Lde85hk5sJ_Q1Wc,4089
+karaoke_lyrics_processor-0.1.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+karaoke_lyrics_processor-0.1.1.dist-info/entry_points.txt,sha256=hjFp6CUxl1p-1WJYfB6TbNcI_DHEnVzX3BXAs4y_0O8,78
+karaoke_lyrics_processor-0.1.1.dist-info/RECORD,,

karaoke_lyrics_processor-0.1.0.dist-info/METADATA

@@ -1,23 +0,0 @@
-Metadata-Version: 2.1
-Name: karaoke-lyrics-processor
-Version: 0.1.0
-Summary: Process song lyrics to prepare them for karaoke video production, e.g. by splitting long lines
-Home-page: https://github.com/karaokenerds/karaoke-lyrics-processor
-License: MIT
-Author: Andrew Beveridge
-Author-email: andrew@beveridge.uk
-Requires-Python: >=3.9,<3.13
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: pyperclip (>=1.8)
-Project-URL: Documentation, https://github.com/karaokenerds/karaoke-lyrics-processor/blob/main/README.md
-Project-URL: Repository, https://github.com/karaokenerds/karaoke-lyrics-processor
-Description-Content-Type: text/markdown
-
-# karaoke-lyrics-processor
-Process song lyrics to prepare them for karaoke video production, e.g. by splitting long lines
-

karaoke_lyrics_processor-0.1.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-karaoke_lyrics_processor/__init__.py,sha256=rLRkJQi61qkRiNXdlTleE3ahJ1oBKcghYVkz64x7IIg,62
-karaoke_lyrics_processor/cli.py,sha256=ZBIZsZoxjofJJljIzLn0vtQpTt3nQ0x2CMe5QLDIEtY,1957
-karaoke_lyrics_processor/karaoke_lyrics_processor.py,sha256=M8CE5l_aIyzjWwiu1lOqFkOkBB7R38JV8oqHFS-wklQ,6615
-karaoke_lyrics_processor-0.1.0.dist-info/LICENSE,sha256=BiPihPDxhxIPEx6yAxVfAljD5Bhm_XG2teCbPEj_m0Y,1069
-karaoke_lyrics_processor-0.1.0.dist-info/METADATA,sha256=UJ5w1ZoOOt1-2MdDN1gOGRtfQwRqOtyr19t6_oeuJIc,1027
-karaoke_lyrics_processor-0.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-karaoke_lyrics_processor-0.1.0.dist-info/entry_points.txt,sha256=hjFp6CUxl1p-1WJYfB6TbNcI_DHEnVzX3BXAs4y_0O8,78
-karaoke_lyrics_processor-0.1.0.dist-info/RECORD,,