Search YouTube without YouTube Data API
Project description
Unlimited YouTube Search
Unlimited YouTube Search (UYTS) is a quick and easy way to search YouTube from your Python program without the need for the YouTube Data API. It's a Python port of youtube-scrape by Herman Fassett and has the majority of its features.
How do I install it?
Simply run pip install unlimited-youtube-search
in the command prompt to install it from the Python Package Index. Alternatively, clone the repo to your PC, navigate to its folder, and run python setup.py install
. Both of these methods will install UYTS and its dependencies.
How do I use it?
You'll need to import uyts
at the start of your project in order to use Unlimited YouTube Search. From then on, you can search YouTube using search = uyts.Search('search query')
. This returns a search object which has the attribute results
storing a list of Video, Playlist and Channel objects. For example, if the first result is a video, you could run print(search.results[0].title)
to see its title. For more information, read on.
Simple Example Program
Here's a simple program to show how easy it is to search YouTube with UYTS.
import uyts
query = input("Search query: ")
search = uyts.Search(query)
for result in search.results:
print(result.resultType +": "+result.title)
What if I want to host a server with it?
That's already built in! To host a server, simply run the following code:
from uyts import Server
app = Server()
app.run()
This will host a Flask server on port 80. More information on how to customise this is in the documentation below.
Documentation
Search class
Usage: uyts.Search(query,minResults=0)
Parameters:
query
: the string to search forminResults
(optional): the minimum number of results to return. UYTS will continue making requests until it reaches this number or runs out of results. The default value of 0 will make one search request.
Attributes:
results
: list of search resultsresultsJSON
: JSON object of search resultsquery
: the original search queryresultsCount
: the number of search results returnedmaxResultsCount
: YouTube's estimation of total possible search results
The following three classes are returned in the search results, and while they can be created yourself, there's pretty much no reason you would want to do that so I haven't included how to do so here. It's self explanatory in the code however.
Video class
Attributes:
id
: the ID of the YouTube videotitle
: the title of the YouTube videothumbnail_src
: the URL of the thumbnailviews
: the number of viewsauthor
: the name of the uploaderduration
: the duration of the videoresultType
: the type of result (in this case,video
)ToJSON()
: returns the video as a JSON objectToXML()
: returns the video as an XML string
Playlist class
Attributes:
id
: the ID of the playlisttitle
: the title of the playlistthumbnail_src
: the URL of the thumbnaillength
: the number of videos in the playlistauthor
: the name of the creatorresultType
: the type of result (in this case,playlist
)ToJSON()
: returns the playlist as a JSON objectToXML()
: returns the playlist as an XML string
Channel class
Attributes:
id
: the ID of the channeltitle
: the name of the channelsubs
orsubscriber_count
: the number of subscribers the channel hasresultType
: the type of result (in this case,channel
)ToJSON()
: returns the channel as a JSON objectToXML()
: returns the channel as an XML string
Server class
The server must be initialised before you can call run()
.
Parameters:
serverName
(optional): the name for the Flask server, defaults touyts-api
serverMessage
(optional): the message that appears on the server homepage, defaults toServer online
rawHTML
(optional): ifTrue
, treatsserverMessage
as raw HTML rather than a string, defaults toFalse
Methods:
run(host="0.0.0.0",port=80)
: runs a Flask server on your local IP on port 80, unless specified otherwise
Attributes:
app
: this is a Flask object for the server. For most use-cases you won't need to directly interact with it. However, if you wanted to deploy this to Heroku you would need to do something likeserver = uyts.Server().app
and then use Gunicorn to run it withweb: gunicorn main:server
for the Procfile as you can't run something from inside a class (e.g.web: gunicorn main:server.app
would be invalid).
Server routes:
/
: main page, should show "Server online" if the server is online/api
: API page, either GET/api/<query>
or/api/<query>/<minResults>
depending on whether you want to specify the minimum results. The response should look like this (but with more results):
[
{
"id": "dQw4w9WgXcQ",
"title": "Rick Astley - Never Gonna Give You Up (Video)",
"thumbnail_src": "http://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
"views": "746,623,786 views",
"author": "Official Rick Astley",
"duration": "3:32",
"resultType": "video"
},
{
"id": "UC-lHJZR3Gqxm24_Vd_AJ5Yw",
"title": "PewDiePie",
"subscriber_count": "106M subscribers",
"resultType": "channel"
}
]
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for unlimited-youtube-search-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4591d0632a0ac80f4188876ca8a7e88544878f1830bec1a3574720b11c5f5683 |
|
MD5 | b300627b4ce94801be5bc478e6162c0c |
|
BLAKE2b-256 | 523202330ff6774cbd04edb26688b07f0c2a4c751daa1b0875afee38cabcf1de |
Hashes for unlimited_youtube_search-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c04b3a5853b821e6ab2cfb48746307e044aebb691d5853b904892631e82b979f |
|
MD5 | 9a6e0d6ca19ff0ca8ff99b5c3ea3d713 |
|
BLAKE2b-256 | 20ac44575b72fff66efd1294a32cf40af272e18583438a6069d174b791bb378e |