updating documentation

README.rst

@@ -10,7 +10,6 @@ Introduction
 .. image:: https://img.shields.io/github/languages/code-size/dtomlinson91/musicbrainzapi-cv-airelogic?style=for-the-badge
 .. image:: https://img.shields.io/github/languages/top/dtomlinson91/musicbrainzapi-cv-airelogic?style=for-the-badge
 .. image:: https://img.shields.io/requires/github/dtomlinson91/musicbrainzapi-cv-airelogic?style=for-the-badge
-.. image:: https://img.shields.io/codacy/grade/f9517450400d48b0a7222a383c2e8fe2?style=for-the-badge
 
 Summary
 ========

docs/source/comments.rst

@@ -53,7 +53,7 @@ Code restructure
 
 The :class:`musicbrainzapi.api.lyrics.concrete_builder.LyricsConcreteBuilder` class could be improved. Many of the methods defined in here no longer need to be present. Some of the functionality (url checking for example) could be removed and implemented in other ways (a Mixin is one solution).
 
-If other ways of filtering were to be added (as opposed to the current default of just Albums) this class would be useful in constructing our :class:`musicbrainzapi.api.lyrics.Lyrics` objects consistently.
+If other ways of filtering were to be added (as opposed to the current default of just Albums) then this class would be useful to build our :class:`musicbrainzapi.api.lyrics.Lyrics` objects consistently.
 
 Additional functionality to the lyrics command
 -----------------------------------------------
@@ -68,7 +68,7 @@ The ability for the user to specify something other than album or year to group
 Multiple artists
 ^^^^^^^^^^^^^^^^
 
-Searching for multiple artists and comparing is certainly possible in the current iteration (click provides a nice way to accept multiple artists and then we create our ``Lyrics`` objects from these) this wasn't implemented. There are rate limiting factors which may slow down the program and increase runtime considerably.
+Searching for multiple artists and comparing is certainly possible in the current iteration (click provides a nice way to accept multiple artists and then we create our ``Lyrics`` objects from these) this wasn't implemented. There are rate limiting factors which may slow down the program and in the current implementation it could increase runtime considerably.
   
 Speed improvements
 -------------------
@@ -79,7 +79,7 @@ One solution would be to implement threading - as we are waiting on HTTP request
 
 This wasn't implemented primarily because of time - but threading could be implemented on each call we make to the API.
 
-An alternative, and I beleive an interesting solution, would be to use AWS Lambda (serverless).
+An alternative, and I believe an interesting solution, would be to use AWS Lambda (serverless).
 
 There is a caveat to this solution and it is cost - threading is free but adds development time and increases complexity. AWS isn't free but allows you to scale the requests out.
 
@@ -98,4 +98,20 @@ If more control was needed one solution could be:
 
 This requires the user to have an internet connection - which is a current requirement. Requests to the api could be made simultaneously - without adding the complexity that comes with threading. This would not solve any API rate limiting - we are required to provide an application user_agent to the api to identify the app.
 
+An interesting solution, and one I did consider, was to have the program run entirely in lambda, requiring no depdencies and just a simple front end that sends requests, and uses ``boto3`` to retrieve. The simplicity of this, and the fact that AWS provide an SDK for many languages, means the cient code could run in any language.
+
+An interface to AWS API Gateway would provide the entry point to the lambda.
+
+Writing it in this manner (with an api backend) would mean a webapp of the program could be possible, with the frontend served with something like ``Vuejs`` or ``React``.
+
 .. _Zappa: https://github.com/Miserlou/Zappa
+
+Error catching
+--------------
+
+Handling missing data from both APIs is done with error catching (namely ``ValueError`` and ``TypeError``).
+
+Although inelegant, and not guaranteed to capture the specific behaviour we want to catch (missing data etc.) it is a solution and appears to work quite well.
+
+Musicbrainz provides a schema for their api. If this were to be placed in a production environment then readdressing this should be a priority - we should be checking the values returned, using the schema as a guide, and replacing missing values accordingly. We should not rely on ``try except`` blocks to do this as it can be unreliable and is prone to raise other errors.
+

setup.py

@@ -33,10 +33,8 @@ entry_points = \
 setup_kwargs = {
     'name': 'musicbrainzapi',
     'version': '1.0.0',
-    'description': '',
     'long_description': None,
     'description': 'Python module to calculate statistics and generate a wordcloud for a given artist. Uses the Musicbrainz API and the lyrics.ovh API.',
-    'long_description': '',
     'author': 'dtomlinson',
     'author_email': 'dtomlinson@panaetius.co.uk',
     'maintainer': None,

src/musicbrainzapi/__init__.py

@@ -1,6 +1,6 @@
 """
-musicbrainzapi: A CLI lyrics searcher
+musicbrainzapi: A CLI lyrics searcher.
-=====================================
+======================================
 
 This module was written by dtomlinson <dtomlinson@panaetius.co.uk> for Aire Logic
 

src/musicbrainzapi/api/lyrics/__init__.py

@@ -1,3 +1,7 @@
+"""
+Lyrics object with statistics.
+===============================
+"""
 from __future__ import annotations
 from typing import Union, Dict, List
 from dataclasses import dataclass
@@ -10,8 +14,7 @@ import numpy as np
 
 @dataclass
 class Lyrics:
-    """Lyrics object for an artist.
+    """Lyrics object for an artist."""
-    """
 
     artist_id: str
     artist: str

src/musicbrainzapi/api/lyrics/builder.py

@@ -106,6 +106,7 @@ class LyricsBuilder(LyricsConcreteBuilder):
         -------
         str
             URL for lyrics from the lyrics api.
+
         """
         lyrics_api_base = 'https://api.lyrics.ovh/v1'
         lyrics_api_url = html.escape(f'{lyrics_api_base}/{artist}/{song}')
@@ -123,7 +124,8 @@ class LyricsBuilder(LyricsConcreteBuilder):
         Returns
         -------
         str
-            Lyrics of the trakc
+            Lyrics of the track.
+
         """
         resp = requests.get(url)
 
@@ -192,6 +194,7 @@ class LyricsBuilder(LyricsConcreteBuilder):
         return _d
 
     def __init__(self) -> None:
+        """Create a builder instance to build a Lyrics object."""
         self.reset()
 
     def reset(self) -> None:
@@ -208,8 +211,7 @@ class LyricsBuilder(LyricsConcreteBuilder):
         return self
 
     def sort_artists(self) -> None:
-        """Sort the artists from the Musicbrainzapi
+        """Sort the artists from the Musicbrainzapi."""
-        """
         self._sort_names = dict(
             (i.get('id'), f'{i.get("name")} | {i.get("disambiguation")}')
             if i.get('disambiguation') is not None
@@ -241,8 +243,7 @@ class LyricsBuilder(LyricsConcreteBuilder):
         return self
 
     def find_all_albums(self) -> None:
-        """Find all albums for the chosen artist
+        """Find all albums for the chosen artist."""
-        """
         limit, offset, page = (100, 0, 1)
 
         resp_0 = addict.Dict(
@@ -365,8 +366,7 @@ class LyricsBuilder(LyricsConcreteBuilder):
         return self
 
     def find_lyrics_urls(self) -> None:
-        """Construct the URL for the lyrics api.
+        """Construct the URL for the lyrics api."""
-        """
         self.all_albums_lyrics_url = list()
         for x in self.all_albums:
             for alb, tracks in x.items():

src/musicbrainzapi/api/lyrics/director.py

@@ -10,6 +10,7 @@ class LyricsClickDirector:
     """Director for Lyrics builder."""
 
     def __init__(self) -> None:
+        """Create a Director to orchestrate the builder."""
         self._builder = None
 
     @staticmethod
@@ -62,6 +63,7 @@ class LyricsClickDirector:
         ------
         SystemExit
             If no artist is found will cleanly quit.
+
         """
         artist_meta = None
         for i, j in self.builder._top_five_results.items():
@@ -111,8 +113,7 @@ class LyricsClickDirector:
         return self
 
     def _query_for_data(self) -> None:
-        """Query Musicbrainz api for albums + track data.
+        """Query Musicbrainz api for albums + track data."""
-        """
         self.builder.find_all_albums()
         self.builder.find_all_tracks()
         self.builder._product.all_albums_with_tracks = self.builder.all_albums

src/musicbrainzapi/wordcloud/__init__.py

@@ -1,3 +1,7 @@
+"""
+Wordcloud from lyrics.
+"""
+
 from __future__ import annotations
 import collections
 from importlib import resources
@@ -41,6 +45,8 @@ class LyricsWordcloud:
         all_albums_lyrics_count: 'Lyrics.all_albums_lyrics_count',
     ):
         """
+        Create a worcloud object.
+
         Parameters
         ----------
         pillow_img : PIL.PngImagePlugin.PngImageFile
@@ -55,12 +61,14 @@ class LyricsWordcloud:
     def use_microphone(
         cls, all_albums_lyrics_count: 'Lyrics.all_albums_lyrics_count',
     ) -> LyricsWordcloud:
-        """Class method to instantiate with a microphone base image.
+        """
+        Class method to instantiate with a microphone base image.
 
         Parameters
         ----------
         all_albums_lyrics_count : Lyrics.all_albums_lyrics_count
             List of all albums + track lyrics counted by each word
+
         """
         mic_resource = resources.path(
             'musicbrainzapi.wordcloud.resources', 'mic.png'
@@ -78,7 +86,7 @@ class LyricsWordcloud:
         *args,
         **kwargs,
     ) -> str:
-        """Static method to generate a random grey colour"""
+        """Static method to generate a random grey colour."""
         colour = f'hsl(0, 0%, {random.randint(60, 100)}%)'
         return colour