Skip to content

Commit

Permalink
Start implementing Discogs API database endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
bbye98 committed Dec 28, 2023
1 parent e50a59a commit b6c9c55
Show file tree
Hide file tree
Showing 17 changed files with 1,096 additions and 135 deletions.
Binary file modified docs/.doctrees/api/minim.discogs.API.doctree
Binary file not shown.
Binary file modified docs/.doctrees/api/minim.spotify.WebAPI.doctree
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
408 changes: 371 additions & 37 deletions docs/_modules/minim/discogs.html

Large diffs are not rendered by default.

7 changes: 4 additions & 3 deletions docs/_modules/minim/spotify.html
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@
<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>
Expand Down Expand Up @@ -6595,9 +6596,9 @@ <h1>Source code for minim.spotify</h1><div class="highlight"><pre>
<span class="n">json</span><span class="o">=</span><span class="n">json</span><span class="p">)</span><span class="o">.</span><span class="n">json</span><span class="p">()[</span><span class="s2">&quot;snapshot_id&quot;</span><span class="p">]</span></div>


<div class="viewcode-block" id="WebAPI.get_playlists">
<a class="viewcode-back" href="../../api/minim.spotify.WebAPI.html#minim.spotify.WebAPI.get_playlists">[docs]</a>
<span class="k">def</span> <span class="nf">get_playlists</span><span class="p">(</span>
<div class="viewcode-block" id="WebAPI.get_personal_playlists">
<a class="viewcode-back" href="../../api/minim.spotify.WebAPI.html#minim.spotify.WebAPI.get_personal_playlists">[docs]</a>
<span class="k">def</span> <span class="nf">get_personal_playlists</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
<span class="w"> </span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
Expand Down
15 changes: 14 additions & 1 deletion docs/_sources/api/minim.discogs.API.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
API
API
===

.. currentmodule:: minim.discogs
Expand All @@ -16,12 +16,25 @@ API
.. autosummary::
:nosignatures:

~API.delete_release_user_rating
~API.edit_profile
~API.get_artist
~API.get_artist_releases
~API.get_identity
~API.get_label
~API.get_label_releases
~API.get_master_release
~API.get_master_release_versions
~API.get_profile
~API.get_release
~API.get_release_community_rating
~API.get_release_stats
~API.get_release_user_rating
~API.get_user_contributions
~API.get_user_submissions
~API.search
~API.set_access_token
~API.set_flow
~API.update_release_user_rating


4 changes: 2 additions & 2 deletions docs/_sources/api/minim.spotify.WebAPI.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
WebAPI
WebAPI
======

.. currentmodule:: minim.spotify
Expand Down Expand Up @@ -54,11 +54,11 @@ WebAPI
~WebAPI.get_genre_seeds
~WebAPI.get_markets
~WebAPI.get_new_albums
~WebAPI.get_personal_playlists
~WebAPI.get_playback_state
~WebAPI.get_playlist
~WebAPI.get_playlist_cover_image
~WebAPI.get_playlist_items
~WebAPI.get_playlists
~WebAPI.get_profile
~WebAPI.get_queue
~WebAPI.get_recently_played
Expand Down
326 changes: 291 additions & 35 deletions docs/api/minim.discogs.API.html

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/api/minim.spotify.WebAPI.html
Original file line number Diff line number Diff line change
Expand Up @@ -538,21 +538,21 @@ <h1>WebAPI<a class="headerlink" href="#webapi" title="Link to this heading">#</a
<tr class="row-even"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_new_albums" title="minim.spotify.WebAPI.get_new_albums"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_new_albums</span></code></a></p></td>
<td><p><a class="reference external" href="https://developer.spotify.com/documentation/web-api/reference/get-new-releases">Albums &gt; Get New Releases</a>: Get a list of new album releases featured in Spotify (shown, for example, on a Spotify player's &quot;Browse&quot; tab).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_playback_state" title="minim.spotify.WebAPI.get_playback_state"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_playback_state</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_personal_playlists" title="minim.spotify.WebAPI.get_personal_playlists"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_personal_playlists</span></code></a></p></td>
<td><p><a class="reference external" href="https://developer.spotify.com/documentation/web-api/reference/get-a-list-of-current-users-playlists">Playlist &gt; Get Current User's Playlists</a>: Get a list of the playlists owned or followed by the current Spotify user.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_playback_state" title="minim.spotify.WebAPI.get_playback_state"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_playback_state</span></code></a></p></td>
<td><p><a class="reference external" href="https://developer.spotify.com/documentation/web-api/reference/get-information-about-the-users-current-playback">Player &gt; Get Playback State</a>: Get information about the user's current playback state, including track or episode, progress, and active device.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_playlist" title="minim.spotify.WebAPI.get_playlist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_playlist</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_playlist" title="minim.spotify.WebAPI.get_playlist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_playlist</span></code></a></p></td>
<td><p><a class="reference external" href="https://developer.spotify.com/documentation/web-api/reference/get-playlist">Playlists &gt; Get Playlist</a>: Get a playlist owned by a Spotify user.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_playlist_cover_image" title="minim.spotify.WebAPI.get_playlist_cover_image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_playlist_cover_image</span></code></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_playlist_cover_image" title="minim.spotify.WebAPI.get_playlist_cover_image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_playlist_cover_image</span></code></a></p></td>
<td><p><a class="reference external" href="https://developer.spotify.com/documentation/web-api/reference/get-playlist-cover">Playlists &gt; Get Playlist Cover Image</a>: Get the current image associated with a specific playlist.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_playlist_items" title="minim.spotify.WebAPI.get_playlist_items"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_playlist_items</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_playlist_items" title="minim.spotify.WebAPI.get_playlist_items"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_playlist_items</span></code></a></p></td>
<td><p><a class="reference external" href="https://developer.spotify.com/documentation/web-api/reference/get-playlists-tracks">Playlists &gt; Get Playlist Items</a>: Get full details of the items of a playlist owned by a Spotify user.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_playlists" title="minim.spotify.WebAPI.get_playlists"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_playlists</span></code></a></p></td>
<td><p><a class="reference external" href="https://developer.spotify.com/documentation/web-api/reference/get-a-list-of-current-users-playlists">Playlist &gt; Get Current User's Playlists</a>: Get a list of the playlists owned or followed by the current Spotify user.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#minim.spotify.WebAPI.get_profile" title="minim.spotify.WebAPI.get_profile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_profile</span></code></a></p></td>
<td><p><a class="reference external" href="https://developer.spotify.com/documentation/web-api/reference/get-current-users-profile">Users &gt; Get Current User's Profile</a>: Get detailed profile information about the current user (including the current user's username).</p></td>
</tr>
Expand Down Expand Up @@ -5246,8 +5246,8 @@ <h1>WebAPI<a class="headerlink" href="#webapi" title="Link to this heading">#</a
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="minim.spotify.WebAPI.get_playlists">
<span class="sig-name descname"><span class="pre">get_playlists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/minim/spotify.html#WebAPI.get_playlists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#minim.spotify.WebAPI.get_playlists" title="Link to this definition">#</a></dt>
<dt class="sig sig-object py" id="minim.spotify.WebAPI.get_personal_playlists">
<span class="sig-name descname"><span class="pre">get_personal_playlists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/minim/spotify.html#WebAPI.get_personal_playlists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#minim.spotify.WebAPI.get_personal_playlists" title="Link to this definition">#</a></dt>
<dd><p><a class="reference external" href="https://developer.spotify.com/documentation/web-api/reference/get-a-list-of-current-users-playlists">Playlist &gt; Get Current User’s Playlists</a>: Get a list of the
playlists owned or followed by the current Spotify user.</p>
<div class="warning admonition">
Expand Down Expand Up @@ -8353,7 +8353,7 @@ <h1>WebAPI<a class="headerlink" href="#webapi" title="Link to this heading">#</a
<li><a class="reference internal" href="#minim.spotify.WebAPI.add_playlist_items"><code class="docutils literal notranslate"><span class="pre">add_playlist_items()</span></code></a></li>
<li><a class="reference internal" href="#minim.spotify.WebAPI.update_playlist_items"><code class="docutils literal notranslate"><span class="pre">update_playlist_items()</span></code></a></li>
<li><a class="reference internal" href="#minim.spotify.WebAPI.remove_playlist_items"><code class="docutils literal notranslate"><span class="pre">remove_playlist_items()</span></code></a></li>
<li><a class="reference internal" href="#minim.spotify.WebAPI.get_playlists"><code class="docutils literal notranslate"><span class="pre">get_playlists()</span></code></a></li>
<li><a class="reference internal" href="#minim.spotify.WebAPI.get_personal_playlists"><code class="docutils literal notranslate"><span class="pre">get_personal_playlists()</span></code></a></li>
<li><a class="reference internal" href="#minim.spotify.WebAPI.get_user_playlists"><code class="docutils literal notranslate"><span class="pre">get_user_playlists()</span></code></a></li>
<li><a class="reference internal" href="#minim.spotify.WebAPI.create_playlist"><code class="docutils literal notranslate"><span class="pre">create_playlist()</span></code></a></li>
<li><a class="reference internal" href="#minim.spotify.WebAPI.get_featured_playlists"><code class="docutils literal notranslate"><span class="pre">get_featured_playlists()</span></code></a></li>
Expand Down
18 changes: 13 additions & 5 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -568,8 +568,12 @@ <h2>G</h2>
</li>
<li><a href="api/minim.tidal.PrivateAPI.html#minim.tidal.PrivateAPI.get_personal_playlist_folders">get_personal_playlist_folders() (minim.tidal.PrivateAPI method)</a>
</li>
<li><a href="api/minim.tidal.PrivateAPI.html#minim.tidal.PrivateAPI.get_personal_playlists">get_personal_playlists() (minim.tidal.PrivateAPI method)</a>
<li><a href="api/minim.spotify.WebAPI.html#minim.spotify.WebAPI.get_personal_playlists">get_personal_playlists() (minim.spotify.WebAPI method)</a>

<ul>
<li><a href="api/minim.tidal.PrivateAPI.html#minim.tidal.PrivateAPI.get_personal_playlists">(minim.tidal.PrivateAPI method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/minim.spotify.WebAPI.html#minim.spotify.WebAPI.get_playback_state">get_playback_state() (minim.spotify.WebAPI method)</a>
Expand All @@ -593,8 +597,6 @@ <h2>G</h2>
</li>
</ul></li>
<li><a href="api/minim.tidal.PrivateAPI.html#minim.tidal.PrivateAPI.get_playlist_recommendations">get_playlist_recommendations() (minim.tidal.PrivateAPI method)</a>
</li>
<li><a href="api/minim.spotify.WebAPI.html#minim.spotify.WebAPI.get_playlists">get_playlists() (minim.spotify.WebAPI method)</a>
</li>
<li><a href="api/minim.discogs.API.html#minim.discogs.API.get_profile">get_profile() (minim.discogs.API method)</a>

Expand All @@ -615,6 +617,10 @@ <h2>G</h2>
<li><a href="api/minim.spotify.WebAPI.html#minim.spotify.WebAPI.get_recommendations">get_recommendations() (minim.spotify.WebAPI method)</a>
</li>
<li><a href="api/minim.spotify.WebAPI.html#minim.spotify.WebAPI.get_related_artists">get_related_artists() (minim.spotify.WebAPI method)</a>
</li>
<li><a href="api/minim.discogs.API.html#minim.discogs.API.get_release">get_release() (minim.discogs.API method)</a>
</li>
<li><a href="api/minim.discogs.API.html#minim.discogs.API.get_release_user_rating">get_release_user_rating() (minim.discogs.API method)</a>
</li>
<li><a href="api/minim.spotify.WebAPI.html#minim.spotify.WebAPI.get_saved_albums">get_saved_albums() (minim.spotify.WebAPI method)</a>
</li>
Expand Down Expand Up @@ -1073,10 +1079,10 @@ <h2>U</h2>
<li><a href="api/minim.tidal.PrivateAPI.html#minim.tidal.PrivateAPI.unfavorite_playlist">(minim.tidal.PrivateAPI method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/minim.tidal.PrivateAPI.html#minim.tidal.PrivateAPI.unfavorite_tracks">unfavorite_tracks() (minim.tidal.PrivateAPI method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/minim.tidal.PrivateAPI.html#minim.tidal.PrivateAPI.unfavorite_videos">unfavorite_videos() (minim.tidal.PrivateAPI method)</a>
</li>
<li><a href="api/minim.spotify.WebAPI.html#minim.spotify.WebAPI.unfollow_people">unfollow_people() (minim.spotify.WebAPI method)</a>
Expand All @@ -1094,6 +1100,8 @@ <h2>U</h2>
<li><a href="api/minim.spotify.WebAPI.html#minim.spotify.WebAPI.update_playlist_items">update_playlist_items() (minim.spotify.WebAPI method)</a>
</li>
<li><a href="api/minim.qobuz.PrivateAPI.html#minim.qobuz.PrivateAPI.update_playlist_position">update_playlist_position() (minim.qobuz.PrivateAPI method)</a>
</li>
<li><a href="api/minim.discogs.API.html#minim.discogs.API.update_release_user_rating">update_release_user_rating() (minim.discogs.API method)</a>
</li>
</ul></td>
</tr></table>
Expand Down
Binary file modified docs/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

15 changes: 14 additions & 1 deletion docs/source/api/minim.discogs.API.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
API
API
===

.. currentmodule:: minim.discogs
Expand All @@ -16,12 +16,25 @@ API
.. autosummary::
:nosignatures:

~API.delete_release_user_rating
~API.edit_profile
~API.get_artist
~API.get_artist_releases
~API.get_identity
~API.get_label
~API.get_label_releases
~API.get_master_release
~API.get_master_release_versions
~API.get_profile
~API.get_release
~API.get_release_community_rating
~API.get_release_stats
~API.get_release_user_rating
~API.get_user_contributions
~API.get_user_submissions
~API.search
~API.set_access_token
~API.set_flow
~API.update_release_user_rating


Loading

0 comments on commit b6c9c55

Please sign in to comment.