Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/UnexpectedMaker/micropython-youtube-api

Youtube API in MicroPython
https://github.com/UnexpectedMaker/micropython-youtube-api

Last synced: 3 months ago
JSON representation

Youtube API in MicroPython

Awesome Lists containing this project

README 

        
MicroPython Youtube API

=======================



A MicroPython based Youtube API wrapper library and example code that allows you to connect to the Google Apps API backend to obtain channel stats for aa YouTube channel.



Setting up the config.json

--------------------------



The config.json file contains entried you will need to fill in for the following items:

* ssid - Your Wifi network SSID

* ssid_password - Your WiFi router password

* appkeyid - Your API kety from Google (See below on how to opbtain one)

* channelid - Your YouTube Channel ID

* query_interval_sec - How long between hitting GoogleApps for an updated set of data



.. code-block:: json



    {

        "ssid": "Enter_Wifi_SSID",

        "ssid_password": "Enter_Wifi_Password",

        "appkeyid": "Enter_GooleApps_API_Key",

        "channelid": "Enter_YT_Channel_ID",

        "query_interval_sec": 60

    }

..



Installing

----------



Download the repositry and copy the following files to your ESP8266 or ESP32 Development board running the latest mainline  MicroPython firmware



* micropython_youtube_api.py

* config.json 

* urequests.py

* Optional: grab_stats.py from examples folder



Using the API

----------



Check the grab_stats.py example script for a full implementation of using the library.



Take note that the creation of the YoutubeAPI() instance is done using the **with** statement to create a context around the definition, so cleanup of the WiFi connection can happen when the data variable (class instance) is out of scope. 



.. code-block:: python



    from micropython_youtube_api import YoutubeAPI

    import network, json, time



    # Read config

    with open('config.json') as f:

        config = json.load(f)



    # Check config.json has updated credentials

    if config['ssid'] == 'Enter_Wifi_SSID':

        assert False, ("config.json has not been updated with your unique keys and data")



    # Create WiFi connection and turn it on

    wlan = network.WLAN(network.STA_IF)

    wlan.active(True)



    # Connect to WiFi router

    print ("Connecting to WiFi: {}".format( config['ssid'] ) )

    wlan.connect( config['ssid'], config['ssid_password'])



    # Wait until wifi is connected

    while not wlan.isconnected:

        pass



    # Create an instance of the YoutubeApi

    with YoutubeAPI( config["channelid"], config["appkeyid"], config["query_interval_sec"] ) as data:



        # Read the data every X seconds

        update_interval = 5

        update_stats_time = time.time() - 10



        while True:



            if update_stats_time < time.time():

                update_stats_time = time.time() + update_interval



                print ("Subs {}".format( data.subs ) )

                print ("Views {}".format( data.views ) )

                print ("Videos {}".format( data.videos ) )

                print ("Comments {}".format( data.comments ) )

..



Getting a Google Apps API key (Required!)

-----------------------------------------



* Create an application [here](https://console.developers.google.com)

* On the API Manager section, go to "Credentials" and create a new API key

* Enable your application to communicate the YouTube Api [here](https://console.developers.google.com/apis/api/youtube)

* Make sure the following URL works for you in your browser (Change the key at the end!):

https://www.googleapis.com/youtube/v3/channels?part=statistics&id=UCu7_D0o48KbfhpEohoP7YSQ&key=PutYourNewlyGeneratedKeyHere



Enjoy!



Back me on Patreon?

===================



I love making and designing projects but sharing open source projects takes a lot of thought and time. I do it because I think it’s important to share knowledge and give back to the community like many have done before me.



If you find this project useful or want to see more open source projects like it, please consider backing me on Patreon to say thanks!



.. image:: http://3sprockets.com.au/um/PatreonSmall.jpg

    :width: 100

    :alt: Patreon

    :target: https://www.patreon.com/unexpectedmaker

    

https://www.patreon.com/unexpectedmaker



Unexpected Maker

===================

http://youtube.com/c/unexpectedmaker



http://twitter.com/unexpectedmaker



https://www.facebook.com/unexpectedmaker/



https://www.instagram.com/unexpectedmaker/



https://www.tindie.com/stores/seonr/