Refactor as a script (#4)

* Refactor with src directory * Setup pyproject.toml as a runnable script * prefix all env vars with CS_ * lint with black * update README install instructions * Fix ms translator key env vars
patkub · Nov 2, 2024 · 4cfcf1a · 4cfcf1a
1 parent 709fdf3
commit 4cfcf1a
Show file tree

Hide file tree

Showing 21 changed files with 102 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -14,49 +14,35 @@
 
 Enjoy listening to music and learning a new language!
 
-### Setup
-Requires Python 3.11+
+### Install
 
-Create an `.env` file with your API keys:
-```
-GENIUS_ACCESS_TOKEN=...
-MS_TRANSLATOR_KEY=...
-MS_TRANSLATOR_REGION=...
-```
-- [Genius API](https://docs.genius.com)
-- [Azure Translator Resource](https://learn.microsoft.com/en-us/azure/ai-services/translator/create-translator-resource)
+Requires [pipx](https://pipx.pypa.io/stable/)
 
-Setup a virtual environment:
+Install the `console-songs` script with pipx.
 ```
-python3 -m venv .
-source bin/activate
+pipx install .
 ```
 
-Install dependencies:
+Setup environment variables
 ```
-pip3 install -r requirements.txt
-```
-
-You should now be able to run `python3 songs.py --help` and see usage.
-
-When making code changes, remember to format code with black:
-```
-black .
+export "CS_GENIUS_ACCESS_TOKEN=..."
+export "CS_MS_TRANSLATOR_KEY=..."
+export "CS_MS_TRANSLATOR_REGION=..."
 ```
 
 ### Usage
 
 Provide the song and optionally the artist's name
 ```
-python3 songs.py song [artist]
+console-songs song [artist]
 ```
 <details>
 
 <summary>Full Usage</summary>
 
 ```
-(console-songs) patka@Patricks-MacBook-Air console-songs % python3 songs.py --help
-usage: songs.py [-h] [-r | --refresh | --no-refresh] [--genius-patch | --no-genius-patch] song [song ...]
+(console-songs) patka@Patricks-MacBook-Air console-songs % console-songs --help
+usage: console-songs [-h] [-r | --refresh | --no-refresh] [--genius-patch | --no-genius-patch] song [song ...]
 
 positional arguments:
   song
@@ -78,7 +64,7 @@ python3 songs.py "Ma ucide ea" "Mihail"
 
 ### Sample Output
 ```
-(console-songs) patka@Patricks-MacBook-Air console-songs % python3 songs.py "Ma ucide ea" "Mihail"
+(console-songs) patka@Patricks-MacBook-Air console-songs % console-songs "Ma ucide ea" "Mihail"
 Searching for "Ma ucide ea" by Mihail...
 Done.
 
@@ -178,6 +164,37 @@ Da, da...                                                        Yes, yes...
 </details>
 
 
+### Development Setup
+Requires Python 3.11+
+
+Create an `.env` file with your API keys:
+```
+CS_GENIUS_ACCESS_TOKEN=...
+CS_MS_TRANSLATOR_KEY=...
+CS_MS_TRANSLATOR_REGION=...
+```
+- [Genius API](https://docs.genius.com)
+- [Azure Translator Resource](https://learn.microsoft.com/en-us/azure/ai-services/translator/create-translator-resource)
+
+Setup a virtual environment:
+```
+python3 -m venv .
+source bin/activate
+```
+
+Install dependencies:
+```
+pip3 install -r requirements.txt
+```
+
+You should now be able to run `python3 songs.py --help` and see usage.
+
+When making code changes, remember to format code with black:
+```
+black .
+```
+
+
 ### Unit Tests
 
 Run unit tests with [pytest](https://docs.pytest.org/en/stable/) and report coverage.

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,36 @@
+[project]
+name = "console-songs"
+version = "2024.11.02"
+dependencies = [
+    "python-dotenv",
+    "requests",
+    "lyricsgenius",
+    "side-by-side",
+    "beautifulsoup4"
+]
+requires-python = ">=3.8"
+authors = [
+    {name = "Patrick Kubiak", email = "epicpatka@gmail.com"}
+]
+maintainers = [
+    {name = "Patrick Kubiak", email = "epicpatka@gmail.com"}
+]
+description = "Given a song and artist, fetches lyrics from Genius, translates them to English using Azure AI Translator, and displays original and translated lyrics side-by-side in the console."
+readme = "README.md"
+license = {file = "LICENSE"}
+keywords = ["console", "songs", "genius-lyrics-api", "azure-translator"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Programming Language :: Python",
+    "Environment :: Console"
+]
+
+[project.optional-dependencies]
+cli = [
+    "pytest",
+    "pytest-cov",
+    "black"
+]
+
+[project.scripts]
+console-songs = "songs:main"
diff --git a/src/__main__.py b/src/__main__.py
@@ -0,0 +1,4 @@
+if __name__ == "__main__":
+    from songs import main
+
+    main()
diff --git a/database_songs/MockSongDatabaseHandler.py → ...database_songs/MockSongDatabaseHandler.py b/database_songs/MockSongDatabaseHandler.py → ...database_songs/MockSongDatabaseHandler.py
diff --git a/database_songs/SongDatabaseHandler.py → src/database_songs/SongDatabaseHandler.py b/database_songs/SongDatabaseHandler.py → src/database_songs/SongDatabaseHandler.py
diff --git a/database_songs/__init__.py → src/database_songs/__init__.py b/database_songs/__init__.py → src/database_songs/__init__.py
diff --git a/display_lyrics/BaseDisplayLyrics.py → src/display_lyrics/BaseDisplayLyrics.py b/display_lyrics/BaseDisplayLyrics.py → src/display_lyrics/BaseDisplayLyrics.py
diff --git a/display_lyrics/ConsoleDisplayLyrics.py → src/display_lyrics/ConsoleDisplayLyrics.py b/display_lyrics/ConsoleDisplayLyrics.py → src/display_lyrics/ConsoleDisplayLyrics.py
diff --git a/display_lyrics/Lyrics.py → src/display_lyrics/Lyrics.py b/display_lyrics/Lyrics.py → src/display_lyrics/Lyrics.py
diff --git a/display_lyrics/__init__.py → src/display_lyrics/__init__.py b/display_lyrics/__init__.py → src/display_lyrics/__init__.py
diff --git a/...lay_lyrics/test_console_display_lyrics.py → ...lay_lyrics/test_console_display_lyrics.py b/...lay_lyrics/test_console_display_lyrics.py → ...lay_lyrics/test_console_display_lyrics.py
diff --git a/display_lyrics/test_lyrics.py → src/display_lyrics/test_lyrics.py b/display_lyrics/test_lyrics.py → src/display_lyrics/test_lyrics.py
diff --git a/fetch_lyrics/FetchLyrics.py → src/fetch_lyrics/FetchLyrics.py b/fetch_lyrics/FetchLyrics.py → src/fetch_lyrics/FetchLyrics.py
diff --git a/fetch_lyrics/PatchedGenius.py → src/fetch_lyrics/PatchedGenius.py b/fetch_lyrics/PatchedGenius.py → src/fetch_lyrics/PatchedGenius.py
diff --git a/fetch_lyrics/__init__.py → src/fetch_lyrics/__init__.py b/fetch_lyrics/__init__.py → src/fetch_lyrics/__init__.py
diff --git a/fetch_lyrics/test_fetch_lyrics.py → src/fetch_lyrics/test_fetch_lyrics.py b/fetch_lyrics/test_fetch_lyrics.py → src/fetch_lyrics/test_fetch_lyrics.py
diff --git a/songs.py → src/songs.py b/songs.py → src/songs.py
@@ -39,7 +39,7 @@ def process_song(song, artist, access_keys, refresh, genius_patch):
     # Fetch song lyrics from Genius
     #
     patched_genius = PatchedGenius if genius_patch else None
-    lyrics_fetcher = FetchLyrics(access_keys["GENIUS_ACCESS_TOKEN"], patched_genius)
+    lyrics_fetcher = FetchLyrics(access_keys["CS_GENIUS_ACCESS_TOKEN"], patched_genius)
     song_info = lyrics_fetcher.fetch_lyrics(song, artist)
     if song_info is None:
         # song not found, end
@@ -72,7 +72,7 @@ def process_song(song, artist, access_keys, refresh, genius_patch):
     # Translate lyrics to English using Microsoft Azure AI Translator
     #
     lyrics_translator = TranslateLyrics(
-        access_keys["MS_TRANSLATOR_KEY"], access_keys["MS_TRANSLATOR_REGION"]
+        access_keys["CS_MS_TRANSLATOR_KEY"], access_keys["CS_MS_TRANSLATOR_REGION"]
     )
     english_translation = lyrics_translator.translate_lyrics(song_lyrics)
 
@@ -85,7 +85,7 @@ def process_song(song, artist, access_keys, refresh, genius_patch):
     ConsoleDisplayLyrics.display_lyrics(song_info, song_lyrics, english_translation)
 
 
-if __name__ == "__main__":  # pragma: no cover
+def main():  # pragma: no cover
     #
     # Parse arguments
     #
@@ -113,13 +113,17 @@ def process_song(song, artist, access_keys, refresh, genius_patch):
     artist = args.song[1] if len(args.song) > 1 else None
 
     access_keys = {
-        "GENIUS_ACCESS_TOKEN": os.getenv("GENIUS_ACCESS_TOKEN"),
-        "MS_TRANSLATOR_KEY": os.getenv("MS_TRANSLATOR_KEY"),
-        "MS_TRANSLATOR_REGION": os.getenv("MS_TRANSLATOR_REGION"),
+        "CS_GENIUS_ACCESS_TOKEN": os.getenv("CS_GENIUS_ACCESS_TOKEN"),
+        "CS_MS_TRANSLATOR_KEY": os.getenv("CS_MS_TRANSLATOR_KEY"),
+        "CS_MS_TRANSLATOR_REGION": os.getenv("CS_MS_TRANSLATOR_REGION"),
     }
 
     #
     # Fetch song lyrics, translate to English, and display original and English side-by-side lyrics.
     #
 
     process_song(song, artist, access_keys, args.refresh, args.genius_patch)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()
diff --git a/test_songs.py → src/test_songs.py b/test_songs.py → src/test_songs.py
@@ -27,9 +27,9 @@ def test_process_song(
     song = "test_song_name"
     artist = "test_artist_name"
     access_keys = {
-        "GENIUS_ACCESS_TOKEN": "fake_token_1",
-        "MS_TRANSLATOR_KEY": "fake_token_2",
-        "MS_TRANSLATOR_REGION": "fake_token_3",
+        "CS_GENIUS_ACCESS_TOKEN": "fake_token_1",
+        "CS_MS_TRANSLATOR_KEY": "fake_token_2",
+        "CS_MS_TRANSLATOR_REGION": "fake_token_3",
     }
     refresh = False
     experimental = False
@@ -68,9 +68,9 @@ def test_process_song_exists(
     song = "test_song_name"
     artist = "test_artist_name"
     access_keys = {
-        "GENIUS_ACCESS_TOKEN": "fake_token_1",
-        "MS_TRANSLATOR_KEY": "fake_token_2",
-        "MS_TRANSLATOR_REGION": "fake_token_3",
+        "CS_GENIUS_ACCESS_TOKEN": "fake_token_1",
+        "CS_MS_TRANSLATOR_KEY": "fake_token_2",
+        "CS_MS_TRANSLATOR_REGION": "fake_token_3",
     }
     refresh = False
     experimental = False
@@ -107,9 +107,9 @@ def test_process_song_null(
     song = "test_song_name"
     artist = "test_artist_name"
     access_keys = {
-        "GENIUS_ACCESS_TOKEN": "fake_token_1",
-        "MS_TRANSLATOR_KEY": "fake_token_2",
-        "MS_TRANSLATOR_REGION": "fake_token_3",
+        "CS_GENIUS_ACCESS_TOKEN": "fake_token_1",
+        "CS_MS_TRANSLATOR_KEY": "fake_token_2",
+        "CS_MS_TRANSLATOR_REGION": "fake_token_3",
     }
     refresh = False
     experimental = False

diff --git a/translate_lyrics/TranslateLyrics.py → src/translate_lyrics/TranslateLyrics.py b/translate_lyrics/TranslateLyrics.py → src/translate_lyrics/TranslateLyrics.py
diff --git a/translate_lyrics/__init__.py → src/translate_lyrics/__init__.py b/translate_lyrics/__init__.py → src/translate_lyrics/__init__.py
diff --git a/translate_lyrics/test_translate_lyrics.py → ...translate_lyrics/test_translate_lyrics.py b/translate_lyrics/test_translate_lyrics.py → ...translate_lyrics/test_translate_lyrics.py