Refactor minim.audio submodule

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: continuous-integration
+on: [push]
+jobs:
+  build:
+    name: continuous-integration-${{ matrix.python-version}}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -el {0}
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+    timeout-minutes: 60
+    steps:      
+      - uses: actions/checkout@v3
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+          channels: conda-forge
+          python-version: ${{ matrix.python-version}}
+      - name: install-dependencies
+        run: |
+          python3 -m pip install -r requirements_minimal.txt
+      - name: ruff-lint
+        run: |
+          python3 -m pip install ruff
+          ruff --format=github --target-version=py38 .
+        continue-on-error: true
+      - name: pytest-test
+        run: |
+          python3 -m pip install pytest
+          pytest

README.md

@@ -23,7 +23,7 @@ formats.
   Audio file handlers for reading and writing metadata and converting
   between audio formats.
 * [`minim.itunes`](https://github.com/bbye98/minim/blob/main/src/minim/itunes.py):
-  A client for the iTunes Store API.
+  A client for the iTunes Search API.
 * [`minim.qobuz`](https://github.com/bbye98/minim/blob/main/src/minim/qobuz.py):
   A client for the Qobuz API with support for the password grant type 
   for user authentication and user authentication token caching.
@@ -60,7 +60,7 @@ Clone the repository and install the package using pip:
 - Search for and retrieve information about an artist, such as the EDM 
   group Galantis:
 
-  **iTunes Store API**
+  **iTunes Search API**
 
       >>> client_itunes.search("Galantis", entity="musicArtist", 
       ...                      limit=1)["results"][0]
@@ -206,7 +206,7 @@ Clone the repository and install the package using pip:
 
 - Search for and retrieve information about a track, such as "Everybody Talks" by Neon Trees:
 
-  **iTunes Store API**
+  **iTunes Search API**
 
       >>> client_itunes.search("Everybody Talks", media="music", 
       ...                      limit=1)["results"][0]

docs/_modules/index.html

@@ -160,15 +160,15 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <ul>
 <li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../notebooks/start.html">Getting Started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks/getting_started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../guide.html">User Guide</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../api/minim.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2 has-children"><a class="reference internal" href="../api/minim.audio.html">audio</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of audio</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="../api/minim.audio.Audio.html">Audio</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../api/minim.audio.FLACAudio.html">FLACAudio</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../api/minim.audio.MP3Audio.html">MP3Audio</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../api/minim.audio.MP4Audio.html">MP4Audio</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../api/minim.audio.OGGAudio.html">OGGAudio</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../api/minim.audio.OggAudio.html">OggAudio</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../api/minim.audio.WAVEAudio.html">WAVEAudio</a></li>
 </ul>
 </li>

docs/_modules/minim/itunes.html

@@ -8,11 +8,10 @@
         <title>minim.itunes - Minim 1.0.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
-    <link rel="stylesheet" type="text/css" href="../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
+    <link rel="stylesheet" type="text/css" href="../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
     <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
     <link rel="stylesheet" type="text/css" href="../../_static/togglebutton.css?v=13237357" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
-    <link rel="stylesheet" type="text/css" href="../../_static/sidebar.css" />
 
 
 
@@ -152,7 +151,6 @@
     <img class="sidebar-logo" src="../../_static/icon.svg" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Minim 1.0.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -170,7 +168,6 @@
 <li class="toctree-l3"><a class="reference internal" href="../../api/minim.audio.FLACAudio.html">FLACAudio</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../../api/minim.audio.MP3Audio.html">MP3Audio</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../../api/minim.audio.MP4Audio.html">MP4Audio</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../api/minim.audio.OGGAudio.html">OGGAudio</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../../api/minim.audio.WAVEAudio.html">WAVEAudio</a></li>
 </ul>
 </li>
@@ -242,9 +239,9 @@ <h1>Source code for minim.itunes</h1><div class="highlight"><pre>
 <span class="sd">endpoints.</span>
 <span class="sd">&quot;&quot;&quot;</span>
 
-<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Union</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">requests</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Union</span>
 
-<span class="kn">import</span> <span class="nn">requests</span>
+<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;SearchAPI&quot;</span><span class="p">]</span>
 
 <div class="viewcode-block" id="SearchAPI">
 <a class="viewcode-back" href="../../api/minim.itunes.SearchAPI.html#minim.itunes.SearchAPI">[docs]</a>