searchspotify 0.0.6__tar.gz

searchspotify-0.0.6/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 TRUE SAIYAN
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

searchspotify-0.0.6/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.1
+Name: searchspotify
+Version: 0.0.6
+Summary: A complete wrapper for the Search API provided by Spotify written in Python.
+Home-page: https://github.com/ufoptg/SearchSpotify
+Author: True Saiyan
+Project-URL: Bug Tracker, https://github.com/ufoptg/SearchSpotify/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Spotify Search
+<p>
+    <a href="https://choosealicense.com/licenses/mit/" target="_blank">
+        <img src="https://img.shields.io/github/license/matcsantos/SearchSpotify" alt="LICENSE">
+    </a>
+    <a href="https://pypi.org/project/searchspotify/" target="_blank">
+        <img src="https://img.shields.io/pypi/v/searchspotify?color=33BBFF&label=PIP" alt="PIP">
+    </a>
+</p>
+
+SearchSpotify is a complete wrapper for the Search API provided by Spotify written in Python.
+
+It has built-in classes that helps you access the data returned by Spotify, alongside with useful methods for exporting data.
+
+Check the [documentation](https://readthedocs.org/) for more information on classes and methods.
+
+## What you can do
+- Get Spotify catalog information about albums, artists or tracks that match a keyword string.
+- Easily access the information provided by Spotify using specific class attributes and methods, such as **name**, **id**, **url** and many more.
+- Access and export audio and image files, such as album covers for example.
+
+## Installation
+SearchSpotify depends on **[requests](https://pypi.org/project/requests/)**. You can easily install it by using **PIP**
+```bash
+python -m pip install requests
+```
+
+Then, you can safely install SearchSpotify using the following command:
+```bash
+python -m pip install searchspotify
+```
+
+## Testing your installation
+You can test your installation using python interactive shell
+```python
+>>> import searchspotify
+```
+
+## Getting access to the API
+To get access to Spotify Search API, you need to have a Spotify account to get an access token, which is required by the API itself. <br>
+You can [register an account](https://www.spotify.com/signup/) if you don't have one.
+
+Then, you need to login into your account in [Spotify for Developers](https://developer.spotify.com/dashboard/login).
+Once you have successfully logged in, go to your **Dashboard**, and create a new application.
+
+You should see something like this: <br>
+<p align="center"><img src="https://i.imgur.com/fWLbWUH.png"></p>
+
+Once you've created your application, you'll receive a **client ID** and a **client secret**. These are your credentials, you should store them in a **safe environment**.
+
+**IMPORTANT: You should not store your credentials inside of your code if you're planning to publish it. You should use Environment Variables instead. Check [this section](https://github.com/ufoptg/SearchSpotify#keeping-your-credentials-safe) to learn how to keep your credentials safe.**
+
+## Making your first call
+So now that you have your **credentials**, you can start making your calls to the API. 
+
+Open your editor and run the following code:
+
+```python
+# First, we import our Client class from searchspotify.client
+from searchspotify.client import Client
+
+# Then, we create an instance of that class passing our credentials as arguments.
+# IMPORTANT: Don't put your credentials inside your code if your planning to publish it.
+myclient = Client("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
+
+# Now we can call the method search() from our client and store the results in a new object.
+results = myclient.search("Never gonna give you up")
+
+# Then we call the method get_tracks() from our results object, which returns a list of tracks.
+tracks = results.get_tracks()
+
+# Now, let's access the first track in our list by using index 0.
+track = tracks[0]
+
+# Finally, we can access some information contained in our track.
+print(track.name, "-", track.artists[0].name)
+print(track.url)
+
+```
+
+**This should be your result:**
+```bash
+Never Gonna Give You Up - Rick Astley
+https://open.spotify.com/track/4cOdK2wGLETKBW3PvgPWqT
+```
+<br>
+
+That seems to be a lot of code, but you can simplify it a lot, like so:
+```python
+from searchspotify.client import Client
+
+myclient = Client("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
+track = myclient.search("Never gonna give you up").get_tracks()[0]
+
+print(track.name, "-", track.artists[0].name)
+
+```
+In a few lines of code, we got access to the API, retrieved some useful information of the first track in our results and displayed it.
+
+There are a lot of class attributes and methods that you can use to retrieve the information you need, you can check them out in the [documentation](https://readthedocs.org/).
+
+## Keeping your credentials safe
+As mentioned before, you should not store your credentials inside of your code. Specially if you are planning to publish it.
+
+A safer way to store them is by using Environment Variables.
+Here's a complete [tutorial](https://www.twilio.com/blog/environment-variables-python) on how to define and access environment variables using Python.
+
+## License
+This project is under the terms of the [MIT license](https://opensource.org/licenses/MIT).

searchspotify-0.0.6/README.md

@@ -0,0 +1,109 @@
+# Spotify Search
+<p>
+    <a href="https://choosealicense.com/licenses/mit/" target="_blank">
+        <img src="https://img.shields.io/github/license/matcsantos/SearchSpotify" alt="LICENSE">
+    </a>
+    <a href="https://pypi.org/project/searchspotify/" target="_blank">
+        <img src="https://img.shields.io/pypi/v/searchspotify?color=33BBFF&label=PIP" alt="PIP">
+    </a>
+</p>
+
+SearchSpotify is a complete wrapper for the Search API provided by Spotify written in Python.
+
+It has built-in classes that helps you access the data returned by Spotify, alongside with useful methods for exporting data.
+
+Check the [documentation](https://readthedocs.org/) for more information on classes and methods.
+
+## What you can do
+- Get Spotify catalog information about albums, artists or tracks that match a keyword string.
+- Easily access the information provided by Spotify using specific class attributes and methods, such as **name**, **id**, **url** and many more.
+- Access and export audio and image files, such as album covers for example.
+
+## Installation
+SearchSpotify depends on **[requests](https://pypi.org/project/requests/)**. You can easily install it by using **PIP**
+```bash
+python -m pip install requests
+```
+
+Then, you can safely install SearchSpotify using the following command:
+```bash
+python -m pip install searchspotify
+```
+
+## Testing your installation
+You can test your installation using python interactive shell
+```python
+>>> import searchspotify
+```
+
+## Getting access to the API
+To get access to Spotify Search API, you need to have a Spotify account to get an access token, which is required by the API itself. <br>
+You can [register an account](https://www.spotify.com/signup/) if you don't have one.
+
+Then, you need to login into your account in [Spotify for Developers](https://developer.spotify.com/dashboard/login).
+Once you have successfully logged in, go to your **Dashboard**, and create a new application.
+
+You should see something like this: <br>
+<p align="center"><img src="https://i.imgur.com/fWLbWUH.png"></p>
+
+Once you've created your application, you'll receive a **client ID** and a **client secret**. These are your credentials, you should store them in a **safe environment**.
+
+**IMPORTANT: You should not store your credentials inside of your code if you're planning to publish it. You should use Environment Variables instead. Check [this section](https://github.com/ufoptg/SearchSpotify#keeping-your-credentials-safe) to learn how to keep your credentials safe.**
+
+## Making your first call
+So now that you have your **credentials**, you can start making your calls to the API. 
+
+Open your editor and run the following code:
+
+```python
+# First, we import our Client class from searchspotify.client
+from searchspotify.client import Client
+
+# Then, we create an instance of that class passing our credentials as arguments.
+# IMPORTANT: Don't put your credentials inside your code if your planning to publish it.
+myclient = Client("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
+
+# Now we can call the method search() from our client and store the results in a new object.
+results = myclient.search("Never gonna give you up")
+
+# Then we call the method get_tracks() from our results object, which returns a list of tracks.
+tracks = results.get_tracks()
+
+# Now, let's access the first track in our list by using index 0.
+track = tracks[0]
+
+# Finally, we can access some information contained in our track.
+print(track.name, "-", track.artists[0].name)
+print(track.url)
+
+```
+
+**This should be your result:**
+```bash
+Never Gonna Give You Up - Rick Astley
+https://open.spotify.com/track/4cOdK2wGLETKBW3PvgPWqT
+```
+<br>
+
+That seems to be a lot of code, but you can simplify it a lot, like so:
+```python
+from searchspotify.client import Client
+
+myclient = Client("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
+track = myclient.search("Never gonna give you up").get_tracks()[0]
+
+print(track.name, "-", track.artists[0].name)
+
+```
+In a few lines of code, we got access to the API, retrieved some useful information of the first track in our results and displayed it.
+
+There are a lot of class attributes and methods that you can use to retrieve the information you need, you can check them out in the [documentation](https://readthedocs.org/).
+
+## Keeping your credentials safe
+As mentioned before, you should not store your credentials inside of your code. Specially if you are planning to publish it.
+
+A safer way to store them is by using Environment Variables.
+Here's a complete [tutorial](https://www.twilio.com/blog/environment-variables-python) on how to define and access environment variables using Python.
+
+## License
+This project is under the terms of the [MIT license](https://opensource.org/licenses/MIT).

searchspotify-0.0.6/pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

searchspotify-0.0.6/setup.cfg

@@ -0,0 +1,28 @@
+[metadata]
+name = searchspotify
+version = 0.0.6
+author = True Saiyan
+description = A complete wrapper for the Search API provided by Spotify written in Python.
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/ufoptg/SearchSpotify
+project_urls = 
+	Bug Tracker = https://github.com/ufoptg/SearchSpotify/issues
+classifiers = 
+	Programming Language :: Python :: 3
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+
+[options]
+package_dir = 
+	= src
+packages = find:
+python_requires = >=3.6
+
+[options.packages.find]
+where = src
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

searchspotify-0.0.6/src/searchspotify.egg-info/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.1
+Name: searchspotify
+Version: 0.0.6
+Summary: A complete wrapper for the Search API provided by Spotify written in Python.
+Home-page: https://github.com/ufoptg/SearchSpotify
+Author: True Saiyan
+Project-URL: Bug Tracker, https://github.com/ufoptg/SearchSpotify/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Spotify Search
+<p>
+    <a href="https://choosealicense.com/licenses/mit/" target="_blank">
+        <img src="https://img.shields.io/github/license/matcsantos/SearchSpotify" alt="LICENSE">
+    </a>
+    <a href="https://pypi.org/project/searchspotify/" target="_blank">
+        <img src="https://img.shields.io/pypi/v/searchspotify?color=33BBFF&label=PIP" alt="PIP">
+    </a>
+</p>
+
+SearchSpotify is a complete wrapper for the Search API provided by Spotify written in Python.
+
+It has built-in classes that helps you access the data returned by Spotify, alongside with useful methods for exporting data.
+
+Check the [documentation](https://readthedocs.org/) for more information on classes and methods.
+
+## What you can do
+- Get Spotify catalog information about albums, artists or tracks that match a keyword string.
+- Easily access the information provided by Spotify using specific class attributes and methods, such as **name**, **id**, **url** and many more.
+- Access and export audio and image files, such as album covers for example.
+
+## Installation
+SearchSpotify depends on **[requests](https://pypi.org/project/requests/)**. You can easily install it by using **PIP**
+```bash
+python -m pip install requests
+```
+
+Then, you can safely install SearchSpotify using the following command:
+```bash
+python -m pip install searchspotify
+```
+
+## Testing your installation
+You can test your installation using python interactive shell
+```python
+>>> import searchspotify
+```
+
+## Getting access to the API
+To get access to Spotify Search API, you need to have a Spotify account to get an access token, which is required by the API itself. <br>
+You can [register an account](https://www.spotify.com/signup/) if you don't have one.
+
+Then, you need to login into your account in [Spotify for Developers](https://developer.spotify.com/dashboard/login).
+Once you have successfully logged in, go to your **Dashboard**, and create a new application.
+
+You should see something like this: <br>
+<p align="center"><img src="https://i.imgur.com/fWLbWUH.png"></p>
+
+Once you've created your application, you'll receive a **client ID** and a **client secret**. These are your credentials, you should store them in a **safe environment**.
+
+**IMPORTANT: You should not store your credentials inside of your code if you're planning to publish it. You should use Environment Variables instead. Check [this section](https://github.com/ufoptg/SearchSpotify#keeping-your-credentials-safe) to learn how to keep your credentials safe.**
+
+## Making your first call
+So now that you have your **credentials**, you can start making your calls to the API. 
+
+Open your editor and run the following code:
+
+```python
+# First, we import our Client class from searchspotify.client
+from searchspotify.client import Client
+
+# Then, we create an instance of that class passing our credentials as arguments.
+# IMPORTANT: Don't put your credentials inside your code if your planning to publish it.
+myclient = Client("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
+
+# Now we can call the method search() from our client and store the results in a new object.
+results = myclient.search("Never gonna give you up")
+
+# Then we call the method get_tracks() from our results object, which returns a list of tracks.
+tracks = results.get_tracks()
+
+# Now, let's access the first track in our list by using index 0.
+track = tracks[0]
+
+# Finally, we can access some information contained in our track.
+print(track.name, "-", track.artists[0].name)
+print(track.url)
+
+```
+
+**This should be your result:**
+```bash
+Never Gonna Give You Up - Rick Astley
+https://open.spotify.com/track/4cOdK2wGLETKBW3PvgPWqT
+```
+<br>
+
+That seems to be a lot of code, but you can simplify it a lot, like so:
+```python
+from searchspotify.client import Client
+
+myclient = Client("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
+track = myclient.search("Never gonna give you up").get_tracks()[0]
+
+print(track.name, "-", track.artists[0].name)
+
+```
+In a few lines of code, we got access to the API, retrieved some useful information of the first track in our results and displayed it.
+
+There are a lot of class attributes and methods that you can use to retrieve the information you need, you can check them out in the [documentation](https://readthedocs.org/).
+
+## Keeping your credentials safe
+As mentioned before, you should not store your credentials inside of your code. Specially if you are planning to publish it.
+
+A safer way to store them is by using Environment Variables.
+Here's a complete [tutorial](https://www.twilio.com/blog/environment-variables-python) on how to define and access environment variables using Python.
+
+## License
+This project is under the terms of the [MIT license](https://opensource.org/licenses/MIT).

searchspotify-0.0.6/src/searchspotify.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+setup.cfg
+src/searchspotify.egg-info/PKG-INFO
+src/searchspotify.egg-info/SOURCES.txt
+src/searchspotify.egg-info/dependency_links.txt
+src/searchspotify.egg-info/top_level.txt
+src/spotifysearch/__init__.py
+src/spotifysearch/calls.py
+src/spotifysearch/classes.py
+src/spotifysearch/client.py
+src/spotifysearch/constructor.py
+src/spotifysearch/urlbuilder.py

searchspotify-0.0.6/src/searchspotify.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

searchspotify-0.0.6/src/searchspotify.egg-info/top_level.txt

@@ -0,0 +1 @@
+spotifysearch

searchspotify-0.0.6/src/spotifysearch/__init__.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright 2020-2023 (c) Randy W @xtdevs, @xtsea
+# Nimbus ~ UserBot
+# Copyright (C) 2023 NimbusTheCloud, ufoptg, @TrueSaiyan
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+# This file is a part of < https://github.com/ufoptg/Nimbus/ >
+# PLease read the GNU Affero General Public License in
+# <https://www.github.com/ufoptg/Nimbus/blob/main/LICENSE/>.
+# If not, see <https://www.gnu.org/licenses/>.
+
+
+from .classes import *
+from .client import Client

searchspotify-0.0.6/src/spotifysearch/calls.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright 2020-2023 (c) Randy W @xtdevs, @xtsea
+# Nimbus ~ UserBot
+# Copyright (C) 2023 NimbusTheCloud, ufoptg, @TrueSaiyan
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+# This file is a part of < https://github.com/ufoptg/Nimbus/ >
+# PLease read the GNU Affero General Public License in
+# <https://www.github.com/ufoptg/Nimbus/blob/main/LICENSE/>.
+# If not, see <https://www.gnu.org/licenses/>.
+
+# THIS FILE IS RESPONSABLE FOR API CALLS
+
+from requests import get, post
+
+from . import urlbuilder
+
+
+def call_acess_token(credentials):
+    """
+    Calls Spotify API to obtain an access token using client credentials.
+
+    :param credentials: Encoded client credentials.
+    :return: Response object containing the access token.
+    """
+    endpoint = "https://accounts.spotify.com/api/token"
+    data = {"grant_type": "client_credentials"}
+    headers = {"Authorization": f"Basic {credentials}"}
+    return post(url=endpoint, data=data, headers=headers)
+
+
+def call_search(acess_token, args):
+    """
+    Calls Spotify API to search for entities using the provided access token and arguments.
+
+    :param access_token: Access token for authentication.
+    :param args: Tuple of arguments for the search endpoint.
+    :return: Response object containing the search results.
+    """
+    endpoint = urlbuilder.search_endpoint(*args)
+    headers = {"Authorization": f"Bearer {acess_token}"}
+    return get(url=endpoint, headers=headers)