import requests
from . import (FOUND_FLASK, FOUND_PLAYWRIGHT, VERSION, REPOSITORY_URL,
- DIR_HOME, DIR_TEMP, config)
+ DIR_HOME, DIR_TEMP, _config)
if FOUND_FLASK:
- from . import Flask, request
+ from flask import Flask, request
if FOUND_PLAYWRIGHT:
- from . import sync_playwright
+ from playwright.sync_api import sync_playwright
__all__ = ["API"]
@@ -472,13 +472,13 @@ Source code for minim.discogs
self.session = requests.Session()
self.session.headers["User-Agent"] = f"Minim/{VERSION} +{REPOSITORY_URL}"
- if (access_token is None and config.has_section(self._NAME)
+ if (access_token is None and _config.has_section(self._NAME)
and not overwrite):
- flow = config.get(self._NAME, "flow")
- access_token = config.get(self._NAME, "access_token")
- access_token_secret = config.get(self._NAME, "access_token_secret")
- consumer_key = config.get(self._NAME, "consumer_key")
- consumer_secret = config.get(self._NAME, "consumer_secret")
+ flow = _config.get(self._NAME, "flow")
+ access_token = _config.get(self._NAME, "access_token")
+ access_token_secret = _config.get(self._NAME, "access_token_secret")
+ consumer_key = _config.get(self._NAME, "consumer_key")
+ consumer_secret = _config.get(self._NAME, "consumer_secret")
elif flow is None and access_token is not None:
flow = "discogs" if access_token_secret is None else "oauth"
@@ -642,8 +642,8 @@ Source code for minim.discogs
oauth |= dict(
urllib.parse.parse_qsl(
urllib.parse.urlparse(
- re.search(f'{self._redirect_uri}\?(.*?)"',
- f.read()).group(0)
+ re.search(fr'{self._redirect_uri}\?(.*?)"',
+ f.read()).group(0)
).query
)
)
@@ -712,7 +712,7 @@ Source code for minim.discogs
dict(urllib.parse.parse_qsl(r.text)).values()
if self._save:
- config[self._NAME] = {
+ _config[self._NAME] = {
"flow": self._flow,
"access_token": access_token,
"access_token_secret": access_token_secret,
@@ -720,7 +720,7 @@ Source code for minim.discogs
"consumer_secret": self._consumer_secret
}
with open(DIR_HOME / "minim.cfg", "w") as f:
- config.write(f)
+ _config.write(f)
self._oauth |= {
"oauth_token": access_token,
@@ -775,6 +775,54 @@ Source code for minim.discogs
* :code:`"oauth"` for the OAuth 1.0a flow.
consumer_key : `str`, keyword-only, optional
+ Consumer key. Required for the OAuth 1.0a flow, and can be
+ used in the Discogs authorization flow alongside a consumer
+ secret. If it is not stored as :code:`DISCOGS_CONSUMER_KEY`
+ in the operating system's environment variables or found in
+ the Minim configuration file, it can be provided here.
+
+ consumer_secret : `str`, keyword-only, optional
+ Consumer secret. Required for the OAuth 1.0a flow, and can
+ be used in the Discogs authorization flow alongside a
+ consumer key. If it is not stored as
+ :code:`DISCOGS_CONSUMER_SECRET` in the operating system's
+ environment variables or found in the Minim configuration
+ file, it can be provided here.
+
+ browser : `bool`, keyword-only, default: :code:`False`
+ Determines whether a web browser is automatically opened for
+ the OAuth 1.0a flow. If :code:`False`, users will have to
+ manually open the authorization URL and provide the full
+ callback URI via the terminal.
+
+ web_framework : `str`, keyword-only, optional
+ Determines which web framework to use for the OAuth 1.0a
+ flow.
+
+ .. container::
+
+ **Valid values**:
+
+ * :code:`"http.server"` for the built-in implementation
+ of HTTP servers.
+ * :code:`"flask"` for the Flask framework.
+ * :code:`"playwright"` for the Playwright framework by
+ Microsoft.
+
+ port : `int` or `str`, keyword-only, default: :code:`8888`
+ Port on :code:`localhost` to use for the OAuth 1.0a flow
+ with the :code:`http.server` and Flask frameworks. Only used
+ if `redirect_uri` is not specified.
+
+ redirect_uri : `str`, keyword-only, optional
+ Redirect URI for the OAuth 1.0a flow. If not on
+ :code:`localhost`, the automatic request access token
+ retrieval functionality is not available.
+
+ save : `bool`, keyword-only, default: :code:`True`
+ Determines whether newly obtained access tokens and their
+ associated properties are stored to the Minim configuration
+ file.
"""
if flow and flow not in self._FLOWS:
@@ -794,8 +842,8 @@ Source code for minim.discogs
if redirect_uri:
self._redirect_uri = redirect_uri
if "localhost" in redirect_uri:
- self._port = re.search("localhost:(\d+)",
- redirect_uri).group(1)
+ self._port = re.search(r"localhost:(\d+)",
+ redirect_uri).group(1)
elif web_framework:
wmsg = ("The redirect URI is not on localhost, "
"so automatic authorization code "
@@ -1007,9 +1055,9 @@ Source code for minim.discogs
)
-
-[docs]
- def get_release_user_rating(
+
+[docs]
+ def get_user_release_rating(
self, release_id: Union[int, str], username: str = None
) -> dict[str, Any]:
@@ -1061,9 +1109,9 @@ Source code for minim.discogs
)
-
-[docs]
- def update_release_user_rating(
+
+[docs]
+ def update_user_release_rating(
self, release_id: Union[int, str], rating: int,
username: str = None) -> dict[str, Any]:
@@ -1113,7 +1161,7 @@ Source code for minim.discogs
}
"""
- self._check_authentication("update_release_rating")
+ self._check_authentication("update_user_release_rating")
if username is None:
if hasattr(self, "_username"):
@@ -1128,62 +1176,819 @@ Source code for minim.discogs
)
- def delete_release_user_rating(
+
+[docs]
+ def delete_user_release_rating(
self, release_id: Union[int, str], username: str = None) -> None:
+
+ """
+ `Database > Release Rating By User > Delete Release Rating By
+ User <https://www.discogs.com/developers
+ /#page:database,header:database-release-rating-by-user-delete>`_:
+ Deletes the release's rating for a given user.
+
+ .. admonition:: User authentication
+ :class: warning
+
+ Requires user authentication with a personal access token or
+ via the OAuth 1.0a flow.
+
+ Parameters
+ ----------
+ release_id : `int` or `str`
+ The release ID.
+
+ **Example**: :code:`249504`.
+
+ username : `str`, optional
+ The username of the user whose rating you are requesting. If
+ not specified, the username of the authenticated user is
+ used.
+
+ **Example**: :code:`"memory"`.
+ """
+
+ self._check_authentication("delete_user_release_rating")
- raise NotImplementedError
+ if username is None:
+ if hasattr(self, "_username"):
+ username = self._username
+ else:
+ raise ValueError("No username provided.")
+
+ return self._request(
+ "delete",
+ f"{self.API_URL}/releases/{release_id}/rating/{username}"
+ )
- def get_release_community_rating(
- self, release_id: Union[int, str]) -> dict[str, Any]:
+
+
+[docs]
+ def get_community_release_rating(
+ self, release_id: Union[int, str]) -> dict[str, Any]:
+
+ """
+ `Database > Community Release Rating <https://www.discogs.com
+ /developers/#page:database,header
+ :database-community-release-rating-get>`_: Retrieves the
+ community release rating average and count.
+
+ Parameters
+ ----------
+ release_id : `int` or `str`
+ The release ID.
+
+ **Example**: :code:`249504`.
+
+ Returns
+ -------
+ rating : `dict`
+ Community release rating average and count.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "rating": {
+ "count": <int>,
+ "average": <float>
+ },
+ "release_id": <int>
+ }
+ """
- raise NotImplementedError
+ return self._get_json(f"{self.API_URL}/releases/{release_id}/rating")
+
+
+[docs]
def get_release_stats(self, release_id: Union[int, str]) -> dict[str, Any]:
+
+ """
+ `Database > Release Stats <https://www.discogs.com/developers
+ /#page:database,header:database-release-stats-get>`_: Retrieves
+ the release's "have" and "want" counts.
+
+ .. attention::
+
+ This endpoint does not appear to be working correctly.
+ Currently, the response will be of the form
+
+ .. code::
+
+ {
+ "is_offense": <bool>
+ }
+
+ Parameters
+ ----------
+ release_id : `int` or `str`
+ The release ID.
+
+ **Example**: :code:`249504`.
+
+ Returns
+ -------
+ stats : `dict`
+ Release "have" and "want" counts.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "num_have": <int>,
+ "num_want": <int>
+ }
+ """
- raise NotImplementedError
+ return self._get_json(f"{self.API_URL}/releases/{release_id}/stats")
+
+
+[docs]
def get_master_release(self, master_id: Union[int, str]) -> dict[str, Any]:
+
+ """
+ `Database > Master Release <https://www.discogs.com/developers
+ /#page:database,header:database-master-release-get>`_: Get a
+ master release.
+
+ Parameters
+ ----------
+ master_id : `int` or `str`
+ The master release ID.
+
+ **Example**: :code:`1000`.
+
+ Returns
+ -------
+ master_release : `dict`
+ Discogs database information for a single master release.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "styles": [<str>],
+ "genres": [<str>],
+ "videos": [
+ {
+ "duration": <int>,
+ "description": <str>,
+ "embed": <bool>,
+ "uri": <str>,
+ "title": <str>
+ }
+ ],
+ "title": <str>,
+ "main_release": <int>,
+ "main_release_url": <str>,
+ "uri": <str>,
+ "artists": [
+ {
+ "join": <str>,
+ "name": <str>,
+ "anv": <str>,
+ "tracks": <str>,
+ "role": <str>,
+ "resource_url": <str>,
+ "id": <int>
+ }
+ ],
+ "versions_url": <str>,
+ "year": <int>,
+ "images": [
+ {
+ "height": <int>,
+ "resource_url": <str>,
+ "type": <str>,
+ "uri": <str>,
+ "uri150": <str>,
+ "width": <int>
+ }
+ ],
+ "resource_url": <str>,
+ "tracklist": [
+ {
+ "duration": <str>,
+ "position": <str>,
+ "type_": <str>,
+ "extraartists": [
+ {
+ "join": <str>,
+ "name": <str>,
+ "anv": <str>,
+ "tracks": <str>,
+ "role": <str>,
+ "resource_url": <str>,
+ "id": <int>
+ }
+ ],
+ "title": <str>
+ }
+ ],
+ "id": <int>,
+ "num_for_sale": <int>,
+ "lowest_price": <float>,
+ "data_quality": <str>
+ }
+ """
- raise NotImplementedError
+ return self._get_json(f"{self.API_URL}/masters/{master_id}")
+
+
+[docs]
def get_master_release_versions(
self, master_id: Union[int, str], *, country: str = None,
format: str = None, label: str = None, released: str = None,
page: int = None, per_page: int = None, sort: str = None,
sort_order: str = None) -> dict[str, Any]:
+
+ """
+ `Database > Master Release Versions <https://www.discogs.com
+ /developers/#page:database,header
+ :database-master-release-versions-get>`_: Retrieves a list of
+ all releases that are versions of this master.
+
+ Parameters
+ ----------
+ master_id : `int` or `str`
+ The master release ID.
+
+ **Example**: :code:`1000`.
+
+ country : `str`, keyword-only, optional
+ The country to filter for.
+
+ **Example**: :code:`"Belgium"`.
+
+ format : `str`, keyword-only, optional
+ The format to filter for.
+
+ **Example**: :code:`"Vinyl"`.
+
+ label : `str`, keyword-only, optional
+ The label to filter for.
+
+ **Example**: :code:`"Scorpio Music"`.
+
+ released : `str`, keyword-only, optional
+ The release year to filter for.
+
+ **Example**: :code:`"1992"`.
+
+ page : `int`, keyword-only, optional
+ The page you want to request.
+
+ **Example**: :code:`3`.
+
+ per_page : `int`, keyword-only, optional
+ The number of items per page.
+
+ **Example**: :code:`25`.
+
+ sort : `str`, keyword-only, optional
+ Sort items by this field.
+
+ **Valid values**: :code:`"released"`, :code:`"title"`,
+ :code:`"format"`, :code:`"label"`, :code:`"catno"`,
+ and :code:`"country"`.
+
+ sort_order : `str`, keyword-only, optional
+ Sort items in a particular order.
+
+ **Valid values**: :code:`"asc"` and :code:`"desc"`.
+
+ Returns
+ -------
+ versions : `dict`
+ Discogs database information for all releases that are
+ versions of the specified master.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "pagination": {
+ "items": <int>,
+ "page": <int>,
+ "pages": <int>,
+ "per_page": <int>,
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
+ },
+ "versions": [
+ {
+ "status": <str>,
+ "stats": {
+ "user": {
+ "in_collection": <int>,
+ "in_wantlist": <int>
+ },
+ "community": {
+ "in_collection": <int>,
+ "in_wantlist": <int>
+ }
+ },
+ "thumb": <str>,
+ "format": <str>,
+ "country": <str>,
+ "title": <str>,
+ "label": <str>,
+ "released": <str>,
+ "major_formats": [<str>],
+ "catno": <str>,
+ "resource_url": <str>,
+ "id": <int>
+ }
+ ]
+ }
+ """
- raise NotImplementedError
+ return self._get_json(
+ f"{self.API_URL}/masters/{master_id}/versions",
+ params={
+ "country": country,
+ "format": format,
+ "label": label,
+ "released": released,
+ "page": page,
+ "per_page": per_page,
+ "sort": sort,
+ "sort_order": sort_order
+ },
+ )
+
+
+[docs]
def get_artist(self, artist_id: Union[int, str]) -> dict[str, Any]:
+
+ """
+ `Database > Artist <https://www.discogs.com/developers
+ /#page:database,header:database-artist-get>`_: Get an artist.
+
+ Parameters
+ ----------
+ artist_id : `int` or `str`
+ The artist ID.
+
+ **Example**: :code:`108713`.
+
+ Returns
+ -------
+ artist : `dict`
+ Discogs database information for a single artist.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "namevariations": [<str>],
+ "profile": <str>,
+ "releases_url": <str>,
+ "resource_url": <str>,
+ "uri": <str>,
+ "urls": [<str>],
+ "data_quality": <str>,
+ "id": <int>,
+ "images": [
+ {
+ "height": <int>,
+ "resource_url": <str>,
+ "type": <str>,
+ "uri": <str>,
+ "uri150": <str>,
+ "width": <int>
+ }
+ ],
+ "members": [
+ {
+ "active": <bool>,
+ "id": <int>,
+ "name": <str>,
+ "resource_url": <str>
+ }
+ ]
+ }
+ """
- raise NotImplementedError
+ return self._get_json(f"{self.API_URL}/artists/{artist_id}")
+
+
+[docs]
def get_artist_releases(
- self, artist_id: Union[int, str], *, sort: str = None,
- sort_order: str = None) -> dict[str, Any]:
+ self, artist_id: Union[int, str], *, page: int = None,
+ per_page: int = None, sort: str = None, sort_order: str = None
+ ) -> dict[str, Any]:
+
+ """
+ `Database > Artist Releases <https://www.discogs.com/developers
+ /#page:database,header:database-artist-releases-get>`_: Get an
+ artist's releases and masters.
+
+ Parameters
+ ----------
+ artist_id : `int` or `str`
+ The artist ID.
+
+ **Example**: :code:`108713`.
+
+ page : `int`, keyword-only, optional
+ Page of results to fetch.
+
+ per_page : `int`, keyword-only, optional
+ Number of results per page.
+
+ sort : `str`, keyword-only, optional
+ Sort results by this field.
+
+ **Valid values**: :code:`"year"`, :code:`"title"`, and
+ :code:`"format"`.
+
+ sort_order : `str`, keyword-only, optional
+ Sort results in a particular order.
+
+ **Valid values**: :code:`"asc"` and :code:`"desc"`.
+
+ Returns
+ -------
+ releases : `dict`
+ Discogs database information for all releases by the
+ specified artist.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "pagination": {
+ "items": <int>,
+ "page": <int>,
+ "pages": <int>,
+ "per_page": <int>,
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
+ },
+ "releases": [
+ {
+ "artist": <str>,
+ "id": <int>,
+ "main_release": <int>,
+ "resource_url": <str>,
+ "role": <str>,
+ "thumb": <str>,
+ "title": <str>,
+ "type": <str>,
+ "year": <int>
+ }
+ ]
+ }
+ """
- raise NotImplementedError
+ return self._get_json(
+ f"{self.API_URL}/artists/{artist_id}/releases",
+ params={
+ "page": page,
+ "per_page": per_page,
+ "sort": sort,
+ "sort_order": sort_order
+ }
+ )
+
+
+[docs]
def get_label(self, label_id: Union[int, str]) -> dict[str, Any]:
-
- raise NotImplementedError
+
+ """
+ `Database > Label <https://www.discogs.com/developers
+ /#page:database,header:database-label-get>`_: Get a label,
+ company, recording studio, locxation, or other entity involved
+ with artists and releases.
+
+ Parameters
+ ----------
+ label_id : `int` or `str`
+ The label ID.
+
+ **Example**: :code:`1`.
+
+ Returns
+ -------
+ label : `dict`
+ Discogs database information for a single label.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "profile": <str>,
+ "releases_url": <str>,
+ "name": <str>,
+ "contact_info": <str>,
+ "uri": <str>,
+ "sublabels": [
+ {
+ "resource_url": <str>,
+ "id": <int>,
+ "name": <str>
+ }
+ ],
+ "urls": [<str>],
+ "images": [
+ {
+ "height": <int>,
+ "resource_url": <str>,
+ "type": <str>,
+ "uri": <str>,
+ "uri150": <str>,
+ "width": <int>
+ }
+ ],
+ "resource_url": <str>,
+ "id": <int>,
+ "data_quality": <str>
+ }
+ """
+
+ return self._get_json(f"{self.API_URL}/labels/{label_id}")
+
+
+[docs]
def get_label_releases(
self, label_id: Union[int, str], *, page: int = None,
per_page: int = None) -> dict[str, Any]:
+
+ """
+ `Database > Label Releases <https://www.discogs.com/developers
+ /#page:database,header:database-all-label-releases-get>`_: Get a
+ list of releases associated with the label.
+
+ Parameters
+ ----------
+ label_id : `int` or `str`
+ The label ID.
+
+ **Example**: :code:`1`.
+
+ page : `int`, keyword-only, optional
+ Page of results to fetch.
+
+ per_page : `int`, keyword-only, optional
+ Number of results per page.
+
+ Returns
+ -------
+ releases : `dict`
+ Discogs database information for all releases by the
+ specified label.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "pagination": {
+ "items": <int>,
+ "page": <int>,
+ "pages": <int>,
+ "per_page": <int>,
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
+ },
+ "releases": [
+ {
+ "artist": <str>,
+ "catno": <str>,
+ "format": <str>,
+ "id": <int>,
+ "resource_url": <str>,
+ "status": <str>,
+ "thumb": <str>,
+ "title": <str>,
+ "year": <int>
+ }
+ ]
+ }
+ """
- raise NotImplementedError
+ return self._get_json(
+ f"{self.API_URL}/labels/{label_id}/releases",
+ params={"page": page, "per_page": per_page}
+ )
+
+
+[docs]
def search(
- self, query: str, *, type: str = None, title: str = None,
+ self, query: str = None, *, type: str = None, title: str = None,
release_title: str = None, credit: str = None,
artist: str = None, anv: str = None, label: str = None,
genre: str = None, style: str = None, country: str = None,
year: str = None, format: str = None, catno: str = None,
barcode: str = None, track: str = None, submitter: str = None,
- contributor: str = None):
+ contributor: str = None) -> dict[str, Any]:
+
+ """
+ `Database > Search <https://www.discogs.com/developers
+ /#page:database,header:database-search-get>`_: Issue a search
+ query to the Discogs database.
+
+ .. admonition:: Authentication
+ :class: warning
+
+ Requires authentication with consumer credentials, with a
+ personal access token, or via the OAuth 1.0a flow.
+
+ Parameters
+ ----------
+ query : `str`, optional
+ The search query.
+
+ **Example**: :code:`"Nirvana"`.
+
+ type : `str`, keyword-only, optional
+ The type of item to search for.
+
+ **Valid values**: :code:`"release"`, :code:`"master"`,
+ :code:`"artist"`, and :code:`"label"`.
+
+ title : `str`, keyword-only, optional
+ Search by combined :code:`"<artist name> - <release title>"`
+ title field.
+
+ **Example**: :code:`"Nirvana - Nevermind"`.
+
+ release_title : `str`, keyword-only, optional
+ Search release titles.
+
+ **Example**: :code:`"Nevermind"`.
+
+ credit : `str`, keyword-only, optional
+ Search release credits.
+
+ **Example**: :code:`"Kurt"`.
+
+ artist : `str`, keyword-only, optional
+ Search artist names.
+
+ **Example**: :code:`"Nirvana"`.
+
+ anv : `str`, keyword-only, optional
+ Search artist name variations (ANV).
+
+ **Example**: :code:`"Nirvana"`.
+
+ label : `str`, keyword-only, optional
+ Search labels.
+
+ **Example**: :code:`"DGC"`.
+
+ genre : `str`, keyword-only, optional
+ Search genres.
+
+ **Example**: :code:`"Rock"`.
+
+ style : `str`, keyword-only, optional
+ Search styles.
+
+ **Example**: :code:`"Grunge"`.
+
+ country : `str`, keyword-only, optional
+ Search release country.
+
+ **Example**: :code:`"Canada"`.
+
+ year : `str`, keyword-only, optional
+ Search release year.
+
+ **Example**: :code:`"1991"`.
+
+ format : `str`, keyword-only, optional
+ Search formats.
+
+ **Example**: :code:`"Album"`.
+
+ catno : `str`, keyword-only, optional
+ Search catalog number.
+
+ **Example**: :code:`"DGCD-24425"`.
+
+ barcode : `str`, keyword-only, optional
+ Search barcode.
+
+ **Example**: :code:`"720642442524"`.
+
+ track : `str`, keyword-only, optional
+ Search track.
+
+ **Example**: :code:`"Smells Like Teen Spirit"`.
+
+ submitter : `str`, keyword-only, optional
+ Search submitter username.
+
+ **Example**: :code:`"milKt"`.
+
+ contributor : `str`, keyword-only, optional
+ Search contributor username.
+
+ **Example**: :code:`"jerome99"`.
+
+ Returns
+ -------
+ results : `dict`
+ Search results.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "pagination": {
+ "items": <int>,
+ "page": <int>,
+ "pages": <int>,
+ "per_page": <int>,
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
+ },
+ "results": [
+ {
+ "style": [<str>],
+ "thumb": <str>,
+ "title": <str>,
+ "country": <str>,
+ "format": [<str>],
+ "uri": <str>,
+ "community": {
+ "want": <int>,
+ "have": <int>
+ },
+ "label": [<str>],
+ "catno": <str>,
+ "year": <str>,
+ "genre": [<str>],
+ "resource_url": <str>,
+ "type": <str>,
+ "id": <int>
+ }
+ ]
+ }
+ """
+
+ self._check_authentication("search", False)
- raise NotImplementedError
+ return self._get_json(
+ f"{self.API_URL}/database/search",
+ params={
+ "q": query,
+ "type": type,
+ "title": title,
+ "release_title": release_title,
+ "credit": credit,
+ "artist": artist,
+ "anv": anv,
+ "label": label,
+ "genre": genre,
+ "style": style,
+ "country": country,
+ "year": year,
+ "format": format,
+ "catno": catno,
+ "barcode": barcode,
+ "track": track,
+ "submitter": submitter,
+ "contributor": contributor
+ }
+ )
+
### MARKETPLACE ###########################################################
@@ -1226,7 +2031,7 @@ Source code for minim.discogs
.. code::
{
- "id": <int><int>,
+ "id": <int>,
"username": <str>,
"resource_url": <str>,
"consumer_name": <str>
@@ -1280,7 +2085,7 @@ Source code for minim.discogs
"wantlist_url": <str>,
"rank": <int>,
"num_pending": <int>,
- "id": <int><int>,
+ "id": <int>,
"num_for_sale": <int>,
"home_page": <str>,
"location": <str>,
@@ -1479,7 +2284,10 @@ Source code for minim.discogs
"page": <int>,
"pages": <int>,
"per_page": <int>,
- "urls": {}
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
},
"submissions": {
"artists": [
@@ -1658,7 +2466,10 @@ Source code for minim.discogs
"page": <int>,
"pages": <int>,
"per_page": <int>,
- "urls": {}
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
},
"contributions": [
{
@@ -1763,8 +2574,12 @@ Source code for minim.discogs
return self._get_json(
f"{self.API_URL}/users/{username}/contributions",
- params={"page": page, "per_page": per_page, "sort": sort,
- "sort_order": sort_order}
+ params={
+ "page": page,
+ "per_page": per_page,
+ "sort": sort,
+ "sort_order": sort_order
+ }
)
diff --git a/docs/_modules/minim/qobuz.html b/docs/_modules/minim/qobuz.html
index e7fccd6..139bb7c 100644
--- a/docs/_modules/minim/qobuz.html
+++ b/docs/_modules/minim/qobuz.html
@@ -173,6 +173,7 @@
FLACAudio
MP3Audio
MP4Audio
+OggAudio
WAVEAudio
@@ -258,9 +259,9 @@ Source code for minim.qobuz
import requests
-from . import FOUND_PLAYWRIGHT, DIR_HOME, DIR_TEMP, config
+from . import FOUND_PLAYWRIGHT, DIR_HOME, DIR_TEMP, _config
if FOUND_PLAYWRIGHT:
- from . import sync_playwright
+ from playwright.sync_api import sync_playwright
__all__ = ["PrivateAPI"]
@@ -455,12 +456,12 @@ Source code for minim.qobuz
if user_agent:
self.session.headers["User-Agent"] = user_agent
- if (auth_token is None and config.has_section(self._NAME)
+ if (auth_token is None and _config.has_section(self._NAME)
and not overwrite):
- flow = config.get(self._NAME, "flow") or None
- auth_token = config.get(self._NAME, "auth_token")
- app_id = config.get(self._NAME, "app_id")
- app_secret = config.get(self._NAME, "app_secret")
+ flow = _config.get(self._NAME, "flow") or None
+ auth_token = _config.get(self._NAME, "auth_token")
+ app_id = _config.get(self._NAME, "app_id")
+ app_secret = _config.get(self._NAME, "app_secret")
self.set_flow(flow, app_id=app_id, app_secret=app_secret,
auth_token=auth_token, browser=browser, save=save)
@@ -625,14 +626,14 @@ Source code for minim.qobuz
auth_token = r["user_auth_token"]
if self._save:
- config[self._NAME] = {
+ _config[self._NAME] = {
"flow": self._flow,
"auth_token": auth_token,
"app_id": self.session.headers["X-App-Id"],
"app_secret": self._app_secret
}
with open(DIR_HOME / "minim.cfg", "w") as f:
- config.write(f)
+ _config.write(f)
self.session.headers["X-User-Auth-Token"] = auth_token
diff --git a/docs/_modules/minim/spotify.html b/docs/_modules/minim/spotify.html
index c36540c..2d34e74 100644
--- a/docs/_modules/minim/spotify.html
+++ b/docs/_modules/minim/spotify.html
@@ -269,11 +269,11 @@ Source code for minim.spotify
import requests
-from . import FOUND_FLASK, FOUND_PLAYWRIGHT, DIR_HOME, DIR_TEMP, config
+from . import FOUND_FLASK, FOUND_PLAYWRIGHT, DIR_HOME, DIR_TEMP, _config
if FOUND_FLASK:
- from . import Flask, request
+ from flask import Flask, request
if FOUND_PLAYWRIGHT:
- from . import sync_playwright
+ from playwright.sync_api import sync_playwright
__all__ = ["PrivateLyricsService", "WebAPI"]
@@ -406,10 +406,10 @@ Source code for minim.spotify
self.session = requests.Session()
self.session.headers["App-Platform"] = "WebPlayer"
- if access_token is None and config.has_section(self._NAME):
- sp_dc = config.get(self._NAME, "sp_dc")
- access_token = config.get(self._NAME, "access_token")
- expiry = config.get(self._NAME, "expiry")
+ if access_token is None and _config.has_section(self._NAME):
+ sp_dc = _config.get(self._NAME, "sp_dc")
+ access_token = _config.get(self._NAME, "access_token")
+ expiry = _config.get(self._NAME, "expiry")
self.set_sp_dc(sp_dc, save=save)
self.set_access_token(access_token=access_token, expiry=expiry)
@@ -539,13 +539,13 @@ Source code for minim.spotify
)
if self._save:
- config[self._NAME] = {
+ _config[self._NAME] = {
"sp_dc": self._sp_dc,
"access_token": access_token,
"expiry": expiry.strftime("%Y-%m-%dT%H:%M:%SZ")
}
with open(DIR_HOME / "minim.cfg", "w") as f:
- config.write(f)
+ _config.write(f)
self.session.headers["Authorization"] = f"Bearer {access_token}"
self._expiry = (
@@ -945,20 +945,20 @@ Source code for minim.spotify
self.session = requests.Session()
- if (access_token is None and config.has_section(self._NAME)
+ if (access_token is None and _config.has_section(self._NAME)
and not overwrite):
- flow = config.get(self._NAME, "flow")
- access_token = config.get(self._NAME, "access_token")
- refresh_token = config.get(self._NAME, "refresh_token",
+ flow = _config.get(self._NAME, "flow")
+ access_token = _config.get(self._NAME, "access_token")
+ refresh_token = _config.get(self._NAME, "refresh_token",
fallback=None)
- expiry = config.get(self._NAME, "expiry", fallback=None)
- client_id = config.get(self._NAME, "client_id")
- client_secret = config.get(self._NAME, "client_secret",
+ expiry = _config.get(self._NAME, "expiry", fallback=None)
+ client_id = _config.get(self._NAME, "client_id")
+ client_secret = _config.get(self._NAME, "client_secret",
fallback=None)
- redirect_uri = config.get(self._NAME, "redirect_uri",
+ redirect_uri = _config.get(self._NAME, "redirect_uri",
fallback=None)
- scopes = config.get(self._NAME, "scopes")
- sp_dc = config.get(self._NAME, "sp_dc", fallback=None)
+ scopes = _config.get(self._NAME, "scopes")
+ sp_dc = _config.get(self._NAME, "sp_dc", fallback=None)
self.set_flow(
flow, client_id=client_id, client_secret=client_secret,
@@ -1139,14 +1139,14 @@ Source code for minim.spotify
self._scopes = r["scope"]
if self._save:
- config[self._NAME].update({
+ _config[self._NAME].update({
"access_token": r["access_token"],
"refresh_token": self._refresh_token,
"expiry": self._expiry.strftime("%Y-%m-%dT%H:%M:%SZ"),
"scopes": self._scopes
})
with open(DIR_HOME / "minim.cfg", "w") as f:
- config.write(f)
+ _config.write(f)
def _request(
self, method: str, url: str, retry: bool = True, **kwargs
@@ -1277,7 +1277,7 @@ Source code for minim.spotify
+ datetime.timedelta(0, r["expires_in"]))
if self._save:
- config[self._NAME] = {
+ _config[self._NAME] = {
"flow": self._flow,
"client_id": self._client_id,
"access_token": access_token,
@@ -1285,14 +1285,14 @@ Source code for minim.spotify
"scopes": self._scopes
}
if refresh_token:
- config[self._NAME]["refresh_token"] \
+ _config[self._NAME]["refresh_token"] \
= refresh_token
for attr in ("client_secret", "redirect_uri", "sp_dc"):
if hasattr(self, f"_{attr}"):
- config[self._NAME][attr] \
+ _config[self._NAME][attr] \
= getattr(self, f"_{attr}") or ""
with open(DIR_HOME / "minim.cfg", "w") as f:
- config.write(f)
+ _config.write(f)
self.session.headers["Authorization"] = f"Bearer {access_token}"
self._refresh_token = refresh_token
diff --git a/docs/_modules/minim/tidal.html b/docs/_modules/minim/tidal.html
index bdb14e9..923bc73 100644
--- a/docs/_modules/minim/tidal.html
+++ b/docs/_modules/minim/tidal.html
@@ -173,6 +173,7 @@
FLACAudio
MP3Audio
MP4Audio
+OggAudio
WAVEAudio
@@ -269,9 +270,9 @@ Source code for minim.tidal
from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
import requests
-from . import FOUND_PLAYWRIGHT, DIR_HOME, DIR_TEMP, config
+from . import FOUND_PLAYWRIGHT, DIR_HOME, DIR_TEMP, _config
if FOUND_PLAYWRIGHT:
- from . import sync_playwright
+ from playwright.sync_api import sync_playwright
__all__ = ["API", "PrivateAPI"]
@@ -400,13 +401,13 @@ Source code for minim.tidal
self.session = requests.Session()
self.session.headers["Content-Type"] = "application/vnd.tidal.v1+json"
- if (access_token is None and config.has_section(self._NAME)
+ if (access_token is None and _config.has_section(self._NAME)
and not overwrite):
- flow = config.get(self._NAME, "flow")
- access_token = config.get(self._NAME, "access_token")
- expiry = config.get(self._NAME, "expiry")
- client_id = config.get(self._NAME, "client_id")
- client_secret = config.get(self._NAME, "client_secret")
+ flow = _config.get(self._NAME, "flow")
+ access_token = _config.get(self._NAME, "access_token")
+ expiry = _config.get(self._NAME, "expiry")
+ client_id = _config.get(self._NAME, "client_id")
+ client_secret = _config.get(self._NAME, "client_secret")
self.set_flow(flow, client_id=client_id, client_secret=client_secret,
save=save)
@@ -509,7 +510,7 @@ Source code for minim.tidal
+ datetime.timedelta(0, r["expires_in"]))
if self._save:
- config[self._NAME] = {
+ _config[self._NAME] = {
"flow": self._flow,
"client_id": self._client_id,
"client_secret": self._client_secret,
@@ -517,7 +518,7 @@ Source code for minim.tidal
"expiry": expiry.strftime("%Y-%m-%dT%H:%M:%SZ")
}
with open(DIR_HOME / "minim.cfg", "w") as f:
- config.write(f)
+ _config.write(f)
self.session.headers["Authorization"] = f"Bearer {access_token}"
self._expiry = (
@@ -2316,15 +2317,15 @@ Source code for minim.tidal
if user_agent:
self.session.headers["User-Agent"] = user_agent
- if (access_token is None and config.has_section(self._NAME)
+ if (access_token is None and _config.has_section(self._NAME)
and not overwrite):
- flow = config.get(self._NAME, "flow")
- access_token = config.get(self._NAME, "access_token")
- refresh_token = config.get(self._NAME, "refresh_token")
- expiry = config.get(self._NAME, "expiry")
- client_id = config.get(self._NAME, "client_id")
- client_secret = config.get(self._NAME, "client_secret")
- scopes = config.get(self._NAME, "scopes")
+ flow = _config.get(self._NAME, "flow")
+ access_token = _config.get(self._NAME, "access_token")
+ refresh_token = _config.get(self._NAME, "refresh_token")
+ expiry = _config.get(self._NAME, "expiry")
+ client_id = _config.get(self._NAME, "client_id")
+ client_secret = _config.get(self._NAME, "client_secret")
+ scopes = _config.get(self._NAME, "scopes")
self.set_flow(flow, client_id=client_id, client_secret=client_secret,
browser=browser, scopes=scopes, save=save)
@@ -2525,13 +2526,13 @@ Source code for minim.tidal
self._scopes = r["scope"]
if self._save:
- config[self._NAME].update({
+ _config[self._NAME].update({
"access_token": r["access_token"],
"expiry": self._expiry.strftime("%Y-%m-%dT%H:%M:%SZ"),
"scopes": self._scopes
})
with open(DIR_HOME / "minim.cfg", "w") as f:
- config.write(f)
+ _config.write(f)
def _request(
self, method: str, url: str, retry: bool = True, **kwargs
@@ -2684,7 +2685,7 @@ Source code for minim.tidal
+ datetime.timedelta(0, r["expires_in"]))
if self._save:
- config[self._NAME] = {
+ _config[self._NAME] = {
"flow": self._flow,
"client_id": self._client_id,
"access_token": access_token,
@@ -2693,10 +2694,10 @@ Source code for minim.tidal
"scopes": self._scopes
}
if hasattr(self, "_client_secret"):
- config[self._NAME]["client_secret"] \
+ _config[self._NAME]["client_secret"] \
= self._client_secret
with open(DIR_HOME / "minim.cfg", "w") as f:
- config.write(f)
+ _config.write(f)
self.session.headers["Authorization"] = f"Bearer {access_token}"
self._refresh_token = refresh_token
diff --git a/docs/_modules/minim/utility.html b/docs/_modules/minim/utility.html
index cd569ff..d6f7a0f 100644
--- a/docs/_modules/minim/utility.html
+++ b/docs/_modules/minim/utility.html
@@ -173,6 +173,7 @@
FLACAudio
MP3Audio
MP4Audio
+OggAudio
WAVEAudio
@@ -262,7 +263,7 @@ Source code for minim.utility
except ModuleNotFoundError:
FOUND_NUMPY = False
-__all__ = ["format_multivalue", "gestalt_ratios", "levenshtein_ratios"]
+__all__ = ["format_multivalue", "gestalt_ratio", "levenshtein_ratio"]
[docs]
diff --git a/docs/_sources/api/minim.discogs.API.rst.txt b/docs/_sources/api/minim.discogs.API.rst.txt
index 98a28e6..aa3309f 100644
--- a/docs/_sources/api/minim.discogs.API.rst.txt
+++ b/docs/_sources/api/minim.discogs.API.rst.txt
@@ -16,10 +16,11 @@
.. autosummary::
:nosignatures:
- ~API.delete_release_user_rating
+ ~API.delete_user_release_rating
~API.edit_profile
~API.get_artist
~API.get_artist_releases
+ ~API.get_community_release_rating
~API.get_identity
~API.get_label
~API.get_label_releases
@@ -27,14 +28,13 @@
~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_release_rating
~API.get_user_submissions
~API.search
~API.set_access_token
~API.set_flow
- ~API.update_release_user_rating
+ ~API.update_user_release_rating
\ No newline at end of file
diff --git a/docs/api/minim.discogs.API.html b/docs/api/minim.discogs.API.html
index c286073..4091b4a 100644
--- a/docs/api/minim.discogs.API.html
+++ b/docs/api/minim.discogs.API.html
@@ -383,56 +383,56 @@ API#
-delete_release_user_rating
Database > Release Rating By User > Delete Release Rating By User: Deletes the release's rating for a given user.
User Identity > Profile > Edit Profile: Edit a user's profile data.
get_artist
Database > Artist: Get an artist.
get_artist_releases
Database > Artist Releases: Get an artist's releases and masters.
Database > Community Release Rating: Retrieves the community release rating average and count.
User Identity > Identity: Retrieve basic information about the authenticated user.
get_label
Database > Label: Get a label, company, recording studio, locxation, or other entity involved with artists and releases.
get_label_releases
Database > Label Releases: Get a list of releases associated with the label.
get_master_release
Database > Master Release: Get a master release.
get_master_release_versions
Database > Master Release Versions: Retrieves a list of all releases that are versions of this master.
User Identity > Profile > Get Profile: Retrieve a user by username.
Database > Release: Get a release (physical or digital object released by one or more artists).
get_release_community_rating
Database > Release Stats: Retrieves the release's "have" and "want" counts.
get_release_stats
User Identity > User Contributions: Retrieve a user's contributions (releases, labels, artists) by username.
Database > Release Rating By User > Get Release Rating By User: Retrieves the release's rating for a given user.
User Identity > User Contributions: Retrieve a user's contributions (releases, labels, artists) by username.
User Identity > User Submissions: Retrieve a user's submissions (edits made to releases, labels, and artists) by username.
search
Database > Search: Issue a search query to the Discogs database.
Set the Discogs API personal or OAuth access token (and secret).
API#
Set the authorization flow.
Database > Release Rating By User > Update Release Rating By User: Updates the release's rating for a given user.
API#
-consumer_keystr, keyword-only, optional
+consumer_keystr, keyword-only, optional Consumer key. Required for the OAuth 1.0a flow, and can be
+used in the Discogs authorization flow alongside a consumer
+secret. If it is not stored as DISCOGS_CONSUMER_KEY
+in the operating system’s environment variables or found in
+the Minim configuration file, it can be provided here.
+consumer_secretstr, keyword-only, optional Consumer secret. Required for the OAuth 1.0a flow, and can
+be used in the Discogs authorization flow alongside a
+consumer key. If it is not stored as
+DISCOGS_CONSUMER_SECRET in the operating system’s
+environment variables or found in the Minim configuration
+file, it can be provided here.
+browserbool, keyword-only, default: False Determines whether a web browser is automatically opened for
+the OAuth 1.0a flow. If False, users will have to
+manually open the authorization URL and provide the full
+callback URI via the terminal.
+web_frameworkstr, keyword-only, optional Determines which web framework to use for the OAuth 1.0a
+flow.
+
+Valid values:
+
+"http.server" for the built-in implementation
+of HTTP servers.
"flask" for the Flask framework.
"playwright" for the Playwright framework by
+Microsoft.
+
+portint or str, keyword-only, default: 8888 Port on localhost to use for the OAuth 1.0a flow
+with the http.server and Flask frameworks. Only used
+if redirect_uri is not specified.
+redirect_uristr, keyword-only, optional Redirect URI for the OAuth 1.0a flow. If not on
+localhost, the automatic request access token
+retrieval functionality is not available.
+savebool, keyword-only, default: True Determines whether newly obtained access tokens and their
+associated properties are stored to the Minim configuration
+file.
+API#
--
-get_release_user_rating(release_id: int | str, username: str = None) dict[str, Any][source]#
+-
+get_user_release_rating(release_id: int | str, username: str = None) dict[str, Any][source]#
Database > Release Rating By User > Get Release Rating By User: Retrieves the
release’s rating for a given user.
@@ -686,8 +728,8 @@ API#
--
-update_release_user_rating(release_id: int | str, rating: int, username: str = None) dict[str, Any][source]#
+-
+update_user_release_rating(release_id: int | str, rating: int, username: str = None) dict[str, Any][source]#
Database > Release Rating By User > Update Release Rating By
User:
Updates the release’s rating for a given user.
@@ -730,6 +772,641 @@ API#
+
+-
+delete_user_release_rating(release_id: int | str, username: str = None) None[source]#
+Database > Release Rating By User > Delete Release Rating By
+User:
+Deletes the release’s rating for a given user.
+
+User authentication
+Requires user authentication with a personal access token or
+via the OAuth 1.0a flow.
+
+
+- Parameters:
+
+- release_idint or str
The release ID.
+Example: 249504.
+- usernamestr, optional
The username of the user whose rating you are requesting. If
+not specified, the username of the authenticated user is
+used.
+Example: "memory".
+
+
+
+
+
+-
+get_community_release_rating(release_id: int | str) dict[str, Any][source]#
+Database > Community Release Rating: Retrieves the
+community release rating average and count.
+
+- Parameters:
+
+- release_idint or str
The release ID.
+Example: 249504.
+
+- Returns:
+
+- ratingdict
Community release rating average and count.
+
+Sample
+{
+ "rating": {
+ "count": <int>,
+ "average": <float>
+ },
+ "release_id": <int>
+}
+
+
+
+
+
+
+
+
+-
+get_release_stats(release_id: int | str) dict[str, Any][source]#
+Database > Release Stats: Retrieves
+the release’s “have” and “want” counts.
+
+Attention
+This endpoint does not appear to be working correctly.
+Currently, the response will be of the form
+{
+ "is_offense": <bool>
+}
+
+
+
+
+- Parameters:
+
+- release_idint or str
The release ID.
+Example: 249504.
+
+- Returns:
+
+- statsdict
Release “have” and “want” counts.
+
+Sample
+{
+ "num_have": <int>,
+ "num_want": <int>
+}
+
+
+
+
+
+
+
+
+-
+get_master_release(master_id: int | str) dict[str, Any][source]#
+Database > Master Release: Get a
+master release.
+
+- Parameters:
+
+- master_idint or str
The master release ID.
+Example: 1000.
+
+- Returns:
+
+- master_releasedict
Discogs database information for a single master release.
+
+Sample
+{
+ "styles": [<str>],
+ "genres": [<str>],
+ "videos": [
+ {
+ "duration": <int>,
+ "description": <str>,
+ "embed": <bool>,
+ "uri": <str>,
+ "title": <str>
+ }
+ ],
+ "title": <str>,
+ "main_release": <int>,
+ "main_release_url": <str>,
+ "uri": <str>,
+ "artists": [
+ {
+ "join": <str>,
+ "name": <str>,
+ "anv": <str>,
+ "tracks": <str>,
+ "role": <str>,
+ "resource_url": <str>,
+ "id": <int>
+ }
+ ],
+ "versions_url": <str>,
+ "year": <int>,
+ "images": [
+ {
+ "height": <int>,
+ "resource_url": <str>,
+ "type": <str>,
+ "uri": <str>,
+ "uri150": <str>,
+ "width": <int>
+ }
+ ],
+ "resource_url": <str>,
+ "tracklist": [
+ {
+ "duration": <str>,
+ "position": <str>,
+ "type_": <str>,
+ "extraartists": [
+ {
+ "join": <str>,
+ "name": <str>,
+ "anv": <str>,
+ "tracks": <str>,
+ "role": <str>,
+ "resource_url": <str>,
+ "id": <int>
+ }
+ ],
+ "title": <str>
+ }
+ ],
+ "id": <int>,
+ "num_for_sale": <int>,
+ "lowest_price": <float>,
+ "data_quality": <str>
+}
+
+
+
+
+
+
+
+
+-
+get_master_release_versions(master_id: int | str, *, country: str = None, format: str = None, label: str = None, released: str = None, page: int = None, per_page: int = None, sort: str = None, sort_order: str = None) dict[str, Any][source]#
+Database > Master Release Versions: Retrieves a list of
+all releases that are versions of this master.
+
+- Parameters:
+
+- master_idint or str
The master release ID.
+Example: 1000.
+- countrystr, keyword-only, optional
The country to filter for.
+Example: "Belgium".
+- formatstr, keyword-only, optional
The format to filter for.
+Example: "Vinyl".
+- labelstr, keyword-only, optional
The label to filter for.
+Example: "Scorpio Music".
+- releasedstr, keyword-only, optional
The release year to filter for.
+Example: "1992".
+- pageint, keyword-only, optional
The page you want to request.
+Example: 3.
+- per_pageint, keyword-only, optional
The number of items per page.
+Example: 25.
+- sortstr, keyword-only, optional
Sort items by this field.
+Valid values: "released", "title",
+"format", "label", "catno",
+and "country".
+- sort_orderstr, keyword-only, optional
Sort items in a particular order.
+Valid values: "asc" and "desc".
+
+- Returns:
+
+- versionsdict
Discogs database information for all releases that are
+versions of the specified master.
+
+Sample
+{
+ "pagination": {
+ "items": <int>,
+ "page": <int>,
+ "pages": <int>,
+ "per_page": <int>,
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
+ },
+ "versions": [
+ {
+ "status": <str>,
+ "stats": {
+ "user": {
+ "in_collection": <int>,
+ "in_wantlist": <int>
+ },
+ "community": {
+ "in_collection": <int>,
+ "in_wantlist": <int>
+ }
+ },
+ "thumb": <str>,
+ "format": <str>,
+ "country": <str>,
+ "title": <str>,
+ "label": <str>,
+ "released": <str>,
+ "major_formats": [<str>],
+ "catno": <str>,
+ "resource_url": <str>,
+ "id": <int>
+ }
+ ]
+}
+
+
+
+
+
+
+
+
+-
+get_artist(artist_id: int | str) dict[str, Any][source]#
+Database > Artist: Get an artist.
+
+- Parameters:
+
+- artist_idint or str
The artist ID.
+Example: 108713.
+
+- Returns:
+
+- artistdict
Discogs database information for a single artist.
+
+Sample
+{
+ "namevariations": [<str>],
+ "profile": <str>,
+ "releases_url": <str>,
+ "resource_url": <str>,
+ "uri": <str>,
+ "urls": [<str>],
+ "data_quality": <str>,
+ "id": <int>,
+ "images": [
+ {
+ "height": <int>,
+ "resource_url": <str>,
+ "type": <str>,
+ "uri": <str>,
+ "uri150": <str>,
+ "width": <int>
+ }
+ ],
+ "members": [
+ {
+ "active": <bool>,
+ "id": <int>,
+ "name": <str>,
+ "resource_url": <str>
+ }
+ ]
+}
+
+
+
+
+
+
+
+
+-
+get_artist_releases(artist_id: int | str, *, page: int = None, per_page: int = None, sort: str = None, sort_order: str = None) dict[str, Any][source]#
+Database > Artist Releases: Get an
+artist’s releases and masters.
+
+- Parameters:
+
+- artist_idint or str
The artist ID.
+Example: 108713.
+- pageint, keyword-only, optional
Page of results to fetch.
+- per_pageint, keyword-only, optional
Number of results per page.
+- sortstr, keyword-only, optional
Sort results by this field.
+Valid values: "year", "title", and
+"format".
+- sort_orderstr, keyword-only, optional
Sort results in a particular order.
+Valid values: "asc" and "desc".
+
+- Returns:
+
+- releasesdict
Discogs database information for all releases by the
+specified artist.
+
+Sample
+{
+ "pagination": {
+ "items": <int>,
+ "page": <int>,
+ "pages": <int>,
+ "per_page": <int>,
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
+ },
+ "releases": [
+ {
+ "artist": <str>,
+ "id": <int>,
+ "main_release": <int>,
+ "resource_url": <str>,
+ "role": <str>,
+ "thumb": <str>,
+ "title": <str>,
+ "type": <str>,
+ "year": <int>
+ }
+ ]
+}
+
+
+
+
+
+
+
+
+-
+get_label(label_id: int | str) dict[str, Any][source]#
+Database > Label: Get a label,
+company, recording studio, locxation, or other entity involved
+with artists and releases.
+
+- Parameters:
+
+- label_idint or str
The label ID.
+Example: 1.
+
+- Returns:
+
+- labeldict
Discogs database information for a single label.
+
+Sample
+{
+ "profile": <str>,
+ "releases_url": <str>,
+ "name": <str>,
+ "contact_info": <str>,
+ "uri": <str>,
+ "sublabels": [
+ {
+ "resource_url": <str>,
+ "id": <int>,
+ "name": <str>
+ }
+ ],
+ "urls": [<str>],
+ "images": [
+ {
+ "height": <int>,
+ "resource_url": <str>,
+ "type": <str>,
+ "uri": <str>,
+ "uri150": <str>,
+ "width": <int>
+ }
+ ],
+ "resource_url": <str>,
+ "id": <int>,
+ "data_quality": <str>
+}
+
+
+
+
+
+
+
+
+-
+get_label_releases(label_id: int | str, *, page: int = None, per_page: int = None) dict[str, Any][source]#
+Database > Label Releases: Get a
+list of releases associated with the label.
+
+- Parameters:
+
+- label_idint or str
The label ID.
+Example: 1.
+- pageint, keyword-only, optional
Page of results to fetch.
+- per_pageint, keyword-only, optional
Number of results per page.
+
+- Returns:
+
+- releasesdict
Discogs database information for all releases by the
+specified label.
+
+Sample
+{
+ "pagination": {
+ "items": <int>,
+ "page": <int>,
+ "pages": <int>,
+ "per_page": <int>,
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
+ },
+ "releases": [
+ {
+ "artist": <str>,
+ "catno": <str>,
+ "format": <str>,
+ "id": <int>,
+ "resource_url": <str>,
+ "status": <str>,
+ "thumb": <str>,
+ "title": <str>,
+ "year": <int>
+ }
+ ]
+}
+
+
+
+
+
+
+
+
+-
+search(query: str = None, *, type: str = None, title: str = None, release_title: str = None, credit: str = None, artist: str = None, anv: str = None, label: str = None, genre: str = None, style: str = None, country: str = None, year: str = None, format: str = None, catno: str = None, barcode: str = None, track: str = None, submitter: str = None, contributor: str = None) dict[str, Any][source]#
+Database > Search: Issue a search
+query to the Discogs database.
+
+Authentication
+
+Requires authentication with consumer credentials, with a
+personal access token, or via the OAuth 1.0a flow.
+
+
+
+- Parameters:
+
+- querystr, optional
The search query.
+Example: "Nirvana".
+- typestr, keyword-only, optional
The type of item to search for.
+Valid values: "release", "master",
+"artist", and "label".
+- titlestr, keyword-only, optional
Search by combined "<artist name> - <release title>"
+title field.
+Example: "Nirvana - Nevermind".
+- release_titlestr, keyword-only, optional
Search release titles.
+Example: "Nevermind".
+- creditstr, keyword-only, optional
Search release credits.
+Example: "Kurt".
+- artiststr, keyword-only, optional
Search artist names.
+Example: "Nirvana".
+- anvstr, keyword-only, optional
Search artist name variations (ANV).
+Example: "Nirvana".
+- labelstr, keyword-only, optional
Search labels.
+Example: "DGC".
+- genrestr, keyword-only, optional
Search genres.
+Example: "Rock".
+- stylestr, keyword-only, optional
Search styles.
+Example: "Grunge".
+- countrystr, keyword-only, optional
Search release country.
+Example: "Canada".
+- yearstr, keyword-only, optional
Search release year.
+Example: "1991".
+- formatstr, keyword-only, optional
Search formats.
+Example: "Album".
+- catnostr, keyword-only, optional
Search catalog number.
+Example: "DGCD-24425".
+- barcodestr, keyword-only, optional
Search barcode.
+Example: "720642442524".
+- trackstr, keyword-only, optional
Search track.
+Example: "Smells Like Teen Spirit".
+- submitterstr, keyword-only, optional
Search submitter username.
+Example: "milKt".
+- contributorstr, keyword-only, optional
Search contributor username.
+Example: "jerome99".
+
+- Returns:
+
+- resultsdict
Search results.
+
+Sample
+{
+ "pagination": {
+ "items": <int>,
+ "page": <int>,
+ "pages": <int>,
+ "per_page": <int>,
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
+ },
+ "results": [
+ {
+ "style": [<str>],
+ "thumb": <str>,
+ "title": <str>,
+ "country": <str>,
+ "format": [<str>],
+ "uri": <str>,
+ "community": {
+ "want": <int>,
+ "have": <int>
+ },
+ "label": [<str>],
+ "catno": <str>,
+ "year": <str>,
+ "genre": [<str>],
+ "resource_url": <str>,
+ "type": <str>,
+ "id": <int>
+ }
+ ]
+}
+
+
+
+
+
+
+
-
get_identity() dict[str, Any][source]#
@@ -752,7 +1429,7 @@ API#
Sample
{
- "id": <int><int>,
+ "id": <int>,
"username": <str>,
"resource_url": <str>,
"consumer_name": <str>
@@ -797,7 +1474,7 @@ API#
"wantlist_url": <str>,
"rank": <int>,
"num_pending": <int>,
- "id": <int><int>,
+ "id": <int>,
"num_for_sale": <int>,
"home_page": <str>,
"location": <str>,
@@ -937,7 +1614,10 @@ API#
"page": <int>,
"pages": <int>,
"per_page": <int>,
- "urls": {}
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
},
"submissions": {
"artists": [
@@ -1093,7 +1773,10 @@ API#
"page": <int>,
"pages": <int>,
"per_page": <int>,
- "urls": {}
+ "urls": {
+ "last": <str>,
+ "next": <str>
+ }
},
"contributions": [
{
@@ -1261,8 +1944,18 @@ API#
set_access_token()set_flow()get_release()get_release_user_rating()update_release_user_rating()get_user_release_rating()update_user_release_rating()delete_user_release_rating()get_community_release_rating()get_release_stats()get_master_release()get_master_release_versions()get_artist()get_artist_releases()get_label()get_label_releases()search()get_identity()get_profile()edit_profile()D
- (minim.tidal.PrivateAPI method)
-
-
@@ -444,9 +446,11 @@ G
(minim.tidal.API method)
- get_artist() (minim.qobuz.PrivateAPI method)
+ get_artist() (minim.discogs.API method)
+ - (minim.qobuz.PrivateAPI method)
+
- (minim.spotify.WebAPI method)
- (minim.tidal.API method)
@@ -471,6 +475,8 @@
G
- get_artist_page() (minim.tidal.PrivateAPI method)
- get_artist_radio() (minim.tidal.PrivateAPI method)
+
+ - get_artist_releases() (minim.discogs.API method)
- get_artist_top_tracks() (minim.spotify.WebAPI method)
@@ -512,6 +518,8 @@
G
- (minim.tidal.PrivateAPI method)
+ get_community_release_rating() (minim.discogs.API method)
+
get_country_code() (minim.tidal.PrivateAPI method)
get_curated_tracks() (minim.qobuz.PrivateAPI method)
@@ -554,11 +562,21 @@ G
get_image() (minim.tidal.PrivateAPI method)
- get_label() (minim.qobuz.PrivateAPI method)
+ get_label() (minim.discogs.API method)
+
+
+ get_label_releases() (minim.discogs.API method)
get_lyrics() (minim.spotify.PrivateLyricsService method)
get_markets() (minim.spotify.WebAPI method)
+
+ get_master_release() (minim.discogs.API method)
+
+ get_master_release_versions() (minim.discogs.API method)
get_mix_items() (minim.tidal.PrivateAPI method)
@@ -566,6 +584,8 @@ G
get_new_albums() (minim.spotify.WebAPI method)
+
+
-
-
- get_playback_state() (minim.spotify.WebAPI method)
- get_playlist() (minim.qobuz.PrivateAPI method)
@@ -620,7 +638,7 @@
G
- get_release() (minim.discogs.API method)
- - get_release_user_rating() (minim.discogs.API method)
+
- get_release_stats() (minim.discogs.API method)
- get_saved_albums() (minim.spotify.WebAPI method)
@@ -728,6 +746,8 @@ G
- (minim.tidal.PrivateAPI method)
+ get_user_release_rating() (minim.discogs.API method)
+
get_user_submissions() (minim.discogs.API method)
get_video() (minim.tidal.API method)
@@ -925,9 +945,11 @@ S
save_tracks() (minim.spotify.WebAPI method)
- search() (minim.itunes.SearchAPI method)
+ search() (minim.discogs.API method)
`_:
+ Deletes the release's rating for a given user.
+
+ .. admonition:: User authentication
+ :class: warning
+
+ Requires user authentication with a personal access token or
+ via the OAuth 1.0a flow.
+
+ Parameters
+ ----------
+ release_id : `int` or `str`
+ The release ID.
+
+ **Example**: :code:`249504`.
+
+ username : `str`, optional
+ The username of the user whose rating you are requesting. If
+ not specified, the username of the authenticated user is
+ used.
+
+ **Example**: :code:`"memory"`.
+ """
+
+ self._check_authentication("delete_user_release_rating")
- raise NotImplementedError
+ if username is None:
+ if hasattr(self, "_username"):
+ username = self._username
+ else:
+ raise ValueError("No username provided.")
+
+ return self._request(
+ "delete",
+ f"{self.API_URL}/releases/{release_id}/rating/{username}"
+ )
+
+ def get_community_release_rating(
+ self, release_id: Union[int, str]) -> dict[str, Any]:
+
+ """
+ `Database > Community Release Rating `_: Retrieves the
+ community release rating average and count.
+
+ Parameters
+ ----------
+ release_id : `int` or `str`
+ The release ID.
+
+ **Example**: :code:`249504`.
+
+ Returns
+ -------
+ rating : `dict`
+ Community release rating average and count.
- def get_release_community_rating(
- self, release_id: Union[int, str]) -> dict[str, Any]:
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "rating": {
+ "count": ,
+ "average":
+ },
+ "release_id":
+ }
+ """
- raise NotImplementedError
+ return self._get_json(f"{self.API_URL}/releases/{release_id}/rating")
def get_release_stats(self, release_id: Union[int, str]) -> dict[str, Any]:
+
+ """
+ `Database > Release Stats `_: Retrieves
+ the release's "have" and "want" counts.
+
+ .. attention::
+
+ This endpoint does not appear to be working correctly.
+ Currently, the response will be of the form
+
+ .. code::
+
+ {
+ "is_offense":
+ }
+
+ Parameters
+ ----------
+ release_id : `int` or `str`
+ The release ID.
+
+ **Example**: :code:`249504`.
+
+ Returns
+ -------
+ stats : `dict`
+ Release "have" and "want" counts.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "num_have": ,
+ "num_want":
+ }
+ """
- raise NotImplementedError
+ return self._get_json(f"{self.API_URL}/releases/{release_id}/stats")
def get_master_release(self, master_id: Union[int, str]) -> dict[str, Any]:
+
+ """
+ `Database > Master Release `_: Get a
+ master release.
+
+ Parameters
+ ----------
+ master_id : `int` or `str`
+ The master release ID.
+
+ **Example**: :code:`1000`.
+
+ Returns
+ -------
+ master_release : `dict`
+ Discogs database information for a single master release.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "styles": [],
+ "genres": [],
+ "videos": [
+ {
+ "duration": ,
+ "description": ,
+ "embed": ,
+ "uri": ,
+ "title":
+ }
+ ],
+ "title": ,
+ "main_release": ,
+ "main_release_url": ,
+ "uri": ,
+ "artists": [
+ {
+ "join": ,
+ "name": ,
+ "anv": ,
+ "tracks": ,
+ "role": ,
+ "resource_url": ,
+ "id":
+ }
+ ],
+ "versions_url": ,
+ "year": ,
+ "images": [
+ {
+ "height": ,
+ "resource_url": ,
+ "type": ,
+ "uri": ,
+ "uri150": ,
+ "width":
+ }
+ ],
+ "resource_url": ,
+ "tracklist": [
+ {
+ "duration": ,
+ "position": ,
+ "type_": ,
+ "extraartists": [
+ {
+ "join": ,
+ "name": ,
+ "anv": ,
+ "tracks": ,
+ "role": ,
+ "resource_url": ,
+ "id":
+ }
+ ],
+ "title":
+ }
+ ],
+ "id": ,
+ "num_for_sale": ,
+ "lowest_price": ,
+ "data_quality":
+ }
+ """
- raise NotImplementedError
+ return self._get_json(f"{self.API_URL}/masters/{master_id}")
def get_master_release_versions(
self, master_id: Union[int, str], *, country: str = None,
@@ -892,38 +1137,568 @@ def get_master_release_versions(
page: int = None, per_page: int = None, sort: str = None,
sort_order: str = None) -> dict[str, Any]:
- raise NotImplementedError
+ """
+ `Database > Master Release Versions `_: Retrieves a list of
+ all releases that are versions of this master.
+
+ Parameters
+ ----------
+ master_id : `int` or `str`
+ The master release ID.
+
+ **Example**: :code:`1000`.
+
+ country : `str`, keyword-only, optional
+ The country to filter for.
+
+ **Example**: :code:`"Belgium"`.
+
+ format : `str`, keyword-only, optional
+ The format to filter for.
+
+ **Example**: :code:`"Vinyl"`.
+
+ label : `str`, keyword-only, optional
+ The label to filter for.
+
+ **Example**: :code:`"Scorpio Music"`.
+
+ released : `str`, keyword-only, optional
+ The release year to filter for.
+
+ **Example**: :code:`"1992"`.
+
+ page : `int`, keyword-only, optional
+ The page you want to request.
+
+ **Example**: :code:`3`.
+
+ per_page : `int`, keyword-only, optional
+ The number of items per page.
+
+ **Example**: :code:`25`.
+
+ sort : `str`, keyword-only, optional
+ Sort items by this field.
+
+ **Valid values**: :code:`"released"`, :code:`"title"`,
+ :code:`"format"`, :code:`"label"`, :code:`"catno"`,
+ and :code:`"country"`.
+
+ sort_order : `str`, keyword-only, optional
+ Sort items in a particular order.
+
+ **Valid values**: :code:`"asc"` and :code:`"desc"`.
+
+ Returns
+ -------
+ versions : `dict`
+ Discogs database information for all releases that are
+ versions of the specified master.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "pagination": {
+ "items": ,
+ "page": ,
+ "pages": ,
+ "per_page": ,
+ "urls": {
+ "last": ,
+ "next":
+ }
+ },
+ "versions": [
+ {
+ "status": ,
+ "stats": {
+ "user": {
+ "in_collection": ,
+ "in_wantlist":
+ },
+ "community": {
+ "in_collection": ,
+ "in_wantlist":
+ }
+ },
+ "thumb": ,
+ "format": ,
+ "country": ,
+ "title": ,
+ "label": ,
+ "released": ,
+ "major_formats": [],
+ "catno": ,
+ "resource_url": ,
+ "id":
+ }
+ ]
+ }
+ """
+
+ return self._get_json(
+ f"{self.API_URL}/masters/{master_id}/versions",
+ params={
+ "country": country,
+ "format": format,
+ "label": label,
+ "released": released,
+ "page": page,
+ "per_page": per_page,
+ "sort": sort,
+ "sort_order": sort_order
+ },
+ )
def get_artist(self, artist_id: Union[int, str]) -> dict[str, Any]:
+
+ """
+ `Database > Artist `_: Get an artist.
+
+ Parameters
+ ----------
+ artist_id : `int` or `str`
+ The artist ID.
+
+ **Example**: :code:`108713`.
+
+ Returns
+ -------
+ artist : `dict`
+ Discogs database information for a single artist.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "namevariations": [],
+ "profile": ,
+ "releases_url": ,
+ "resource_url": ,
+ "uri": ,
+ "urls": [],
+ "data_quality": ,
+ "id": ,
+ "images": [
+ {
+ "height": ,
+ "resource_url": ,
+ "type": ,
+ "uri": ,
+ "uri150": ,
+ "width":
+ }
+ ],
+ "members": [
+ {
+ "active": ,
+ "id": ,
+ "name": ,
+ "resource_url":
+ }
+ ]
+ }
+ """
- raise NotImplementedError
+ return self._get_json(f"{self.API_URL}/artists/{artist_id}")
def get_artist_releases(
- self, artist_id: Union[int, str], *, sort: str = None,
- sort_order: str = None) -> dict[str, Any]:
+ self, artist_id: Union[int, str], *, page: int = None,
+ per_page: int = None, sort: str = None, sort_order: str = None
+ ) -> dict[str, Any]:
+
+ """
+ `Database > Artist Releases `_: Get an
+ artist's releases and masters.
+
+ Parameters
+ ----------
+ artist_id : `int` or `str`
+ The artist ID.
+
+ **Example**: :code:`108713`.
+
+ page : `int`, keyword-only, optional
+ Page of results to fetch.
+
+ per_page : `int`, keyword-only, optional
+ Number of results per page.
+
+ sort : `str`, keyword-only, optional
+ Sort results by this field.
+
+ **Valid values**: :code:`"year"`, :code:`"title"`, and
+ :code:`"format"`.
+
+ sort_order : `str`, keyword-only, optional
+ Sort results in a particular order.
+
+ **Valid values**: :code:`"asc"` and :code:`"desc"`.
+
+ Returns
+ -------
+ releases : `dict`
+ Discogs database information for all releases by the
+ specified artist.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "pagination": {
+ "items": ,
+ "page": ,
+ "pages": ,
+ "per_page": ,
+ "urls": {
+ "last": ,
+ "next":
+ }
+ },
+ "releases": [
+ {
+ "artist": ,
+ "id": ,
+ "main_release": ,
+ "resource_url": ,
+ "role": ,
+ "thumb": ,
+ "title": ,
+ "type": ,
+ "year":
+ }
+ ]
+ }
+ """
- raise NotImplementedError
+ return self._get_json(
+ f"{self.API_URL}/artists/{artist_id}/releases",
+ params={
+ "page": page,
+ "per_page": per_page,
+ "sort": sort,
+ "sort_order": sort_order
+ }
+ )
def get_label(self, label_id: Union[int, str]) -> dict[str, Any]:
- raise NotImplementedError
+ """
+ `Database > Label `_: Get a label,
+ company, recording studio, locxation, or other entity involved
+ with artists and releases.
+
+ Parameters
+ ----------
+ label_id : `int` or `str`
+ The label ID.
+
+ **Example**: :code:`1`.
+
+ Returns
+ -------
+ label : `dict`
+ Discogs database information for a single label.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "profile": ,
+ "releases_url": ,
+ "name": ,
+ "contact_info": ,
+ "uri": ,
+ "sublabels": [
+ {
+ "resource_url": ,
+ "id": ,
+ "name":
+ }
+ ],
+ "urls": [],
+ "images": [
+ {
+ "height": ,
+ "resource_url": ,
+ "type": ,
+ "uri": ,
+ "uri150": ,
+ "width":
+ }
+ ],
+ "resource_url": ,
+ "id": ,
+ "data_quality":
+ }
+ """
+
+ return self._get_json(f"{self.API_URL}/labels/{label_id}")
def get_label_releases(
self, label_id: Union[int, str], *, page: int = None,
per_page: int = None) -> dict[str, Any]:
+
+ """
+ `Database > Label Releases `_: Get a
+ list of releases associated with the label.
+
+ Parameters
+ ----------
+ label_id : `int` or `str`
+ The label ID.
+
+ **Example**: :code:`1`.
+
+ page : `int`, keyword-only, optional
+ Page of results to fetch.
+
+ per_page : `int`, keyword-only, optional
+ Number of results per page.
+
+ Returns
+ -------
+ releases : `dict`
+ Discogs database information for all releases by the
+ specified label.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "pagination": {
+ "items": ,
+ "page": ,
+ "pages": ,
+ "per_page": ,
+ "urls": {
+ "last": ,
+ "next":
+ }
+ },
+ "releases": [
+ {
+ "artist": ,
+ "catno": ,
+ "format": ,
+ "id": ,
+ "resource_url": ,
+ "status": ,
+ "thumb": ,
+ "title": ,
+ "year":
+ }
+ ]
+ }
+ """
- raise NotImplementedError
+ return self._get_json(
+ f"{self.API_URL}/labels/{label_id}/releases",
+ params={"page": page, "per_page": per_page}
+ )
def search(
- self, query: str, *, type: str = None, title: str = None,
+ self, query: str = None, *, type: str = None, title: str = None,
release_title: str = None, credit: str = None,
artist: str = None, anv: str = None, label: str = None,
genre: str = None, style: str = None, country: str = None,
year: str = None, format: str = None, catno: str = None,
barcode: str = None, track: str = None, submitter: str = None,
- contributor: str = None):
+ contributor: str = None) -> dict[str, Any]:
- raise NotImplementedError
+ """
+ `Database > Search `_: Issue a search
+ query to the Discogs database.
+
+ .. admonition:: Authentication
+ :class: warning
+
+ Requires authentication with consumer credentials, with a
+ personal access token, or via the OAuth 1.0a flow.
+
+ Parameters
+ ----------
+ query : `str`, optional
+ The search query.
+
+ **Example**: :code:`"Nirvana"`.
+
+ type : `str`, keyword-only, optional
+ The type of item to search for.
+
+ **Valid values**: :code:`"release"`, :code:`"master"`,
+ :code:`"artist"`, and :code:`"label"`.
+
+ title : `str`, keyword-only, optional
+ Search by combined :code:`" - "`
+ title field.
+
+ **Example**: :code:`"Nirvana - Nevermind"`.
+
+ release_title : `str`, keyword-only, optional
+ Search release titles.
+
+ **Example**: :code:`"Nevermind"`.
+
+ credit : `str`, keyword-only, optional
+ Search release credits.
+
+ **Example**: :code:`"Kurt"`.
+
+ artist : `str`, keyword-only, optional
+ Search artist names.
+
+ **Example**: :code:`"Nirvana"`.
+
+ anv : `str`, keyword-only, optional
+ Search artist name variations (ANV).
+
+ **Example**: :code:`"Nirvana"`.
+
+ label : `str`, keyword-only, optional
+ Search labels.
+
+ **Example**: :code:`"DGC"`.
+
+ genre : `str`, keyword-only, optional
+ Search genres.
+
+ **Example**: :code:`"Rock"`.
+
+ style : `str`, keyword-only, optional
+ Search styles.
+
+ **Example**: :code:`"Grunge"`.
+
+ country : `str`, keyword-only, optional
+ Search release country.
+
+ **Example**: :code:`"Canada"`.
+
+ year : `str`, keyword-only, optional
+ Search release year.
+
+ **Example**: :code:`"1991"`.
+
+ format : `str`, keyword-only, optional
+ Search formats.
+
+ **Example**: :code:`"Album"`.
+
+ catno : `str`, keyword-only, optional
+ Search catalog number.
+
+ **Example**: :code:`"DGCD-24425"`.
+
+ barcode : `str`, keyword-only, optional
+ Search barcode.
+
+ **Example**: :code:`"720642442524"`.
+
+ track : `str`, keyword-only, optional
+ Search track.
+
+ **Example**: :code:`"Smells Like Teen Spirit"`.
+
+ submitter : `str`, keyword-only, optional
+ Search submitter username.
+
+ **Example**: :code:`"milKt"`.
+
+ contributor : `str`, keyword-only, optional
+ Search contributor username.
+
+ **Example**: :code:`"jerome99"`.
+
+ Returns
+ -------
+ results : `dict`
+ Search results.
+
+ .. admonition:: Sample
+ :class: dropdown
+
+ .. code::
+
+ {
+ "pagination": {
+ "items": ,
+ "page": ,
+ "pages": ,
+ "per_page": ,
+ "urls": {
+ "last": ,
+ "next":
+ }
+ },
+ "results": [
+ {
+ "style": [],
+ "thumb": ,
+ "title": ,
+ "country": ,
+ "format": [],
+ "uri": ,
+ "community": {
+ "want": ,
+ "have":
+ },
+ "label": [],
+ "catno": ,
+ "year": ,
+ "genre": [],
+ "resource_url": ,
+ "type": ,
+ "id":
+ }
+ ]
+ }
+ """
+
+ self._check_authentication("search", False)
+
+ return self._get_json(
+ f"{self.API_URL}/database/search",
+ params={
+ "q": query,
+ "type": type,
+ "title": title,
+ "release_title": release_title,
+ "credit": credit,
+ "artist": artist,
+ "anv": anv,
+ "label": label,
+ "genre": genre,
+ "style": style,
+ "country": country,
+ "year": year,
+ "format": format,
+ "catno": catno,
+ "barcode": barcode,
+ "track": track,
+ "submitter": submitter,
+ "contributor": contributor
+ }
+ )
### MARKETPLACE ###########################################################
@@ -964,7 +1739,7 @@ def get_identity(self) -> dict[str, Any]:
.. code::
{
- "id": ,
+ "id": ,
"username": ,
"resource_url": ,
"consumer_name":
@@ -1015,7 +1790,7 @@ def get_profile(self, username: str = None) -> dict[str, Any]:
"wantlist_url": ,
"rank": ,
"num_pending": ,
- "id": ,
+ "id": ,
"num_for_sale": ,
"home_page": ,
"location": ,
@@ -1208,7 +1983,10 @@ def get_user_submissions(
"page": ,
"pages": ,
"per_page": ,
- "urls": {}
+ "urls": {
+ "last": ,
+ "next":
+ }
},
"submissions": {
"artists": [
@@ -1384,7 +2162,10 @@ def get_user_contributions(
"page": ,
"pages": ,
"per_page": ,
- "urls": {}
+ "urls": {
+ "last":