# PyPortal GitHub Stars Trophy ## Overview ![](https://cdn-learn.adafruit.com/assets/assets/000/072/140/medium800/internet_of_things___iot_IMG_4335_2k.jpg?1551470572) https://youtu.be/P7ScnII0Xgc Here's a great way to display the GitHub Star count for any repo. Using CircuitPython and the PyPortal library, it's easy to grab the JSON data provided by a site's API and display it dynamically. The PyPortal's built-in WiFi connects to your network and checks for updates every minute. And, you can control the fonts, captions, colors, background image, and even play a happy sound effect when the number changes. Plus, for extra special fanciness, mount the PyPortal to a trophy for all to admire! ## Parts Featured ### Adafruit PyPortal - CircuitPython Powered Internet Display [Adafruit PyPortal - CircuitPython Powered Internet Display](https://www.adafruit.com/product/4116) **PyPortal** , our easy-to-use IoT device that allows you to create all the things for the “Internet of Things” in minutes. Make custom touch screen interface GUIs, all open-source, and Python-powered using tinyJSON / APIs to get news, stock, weather, cat photos,... In Stock [Buy Now](https://www.adafruit.com/product/4116) [Related Guides to the Product](https://learn.adafruit.com/products/4116/guides) ![Front view of a Adafruit PyPortal - CircuitPython Powered Internet Display with a pyportal logo image on the display. ](https://cdn-shop.adafruit.com/640x480/4116-00.jpeg) Featured ### USB cable - USB A to Micro-B [USB cable - USB A to Micro-B](https://www.adafruit.com/product/592) This here is your standard A to micro-B USB cable, for USB 1.1 or 2.0. Perfect for connecting a PC to your Metro, Feather, Raspberry Pi or other dev-board or microcontroller Approximately 3 feet / 1 meter long In Stock [Buy Now](https://www.adafruit.com/product/592) [Related Guides to the Product](https://learn.adafruit.com/products/592/guides) ![USB cable - USB A to Micro-B - 3 foot long](https://cdn-shop.adafruit.com/640x480/592-01.jpg) ## Materials - You may want to mount your PyPortal on a handsome trophy! I got one at a thrift store for fewer than two dollars - You can use small zip ties or double stick tape to mount the the PyPortal to your trophy ![](https://cdn-learn.adafruit.com/assets/assets/000/072/099/medium800/internet_of_things___iot_IMG_4288_2k.jpg?1551402749) # PyPortal GitHub Stars Trophy ## Install CircuitPython [CircuitPython](https://github.com/adafruit/circuitpython) is a derivative of [MicroPython](https://micropython.org) designed to simplify experimentation and education on low-cost microcontrollers. It makes it easier than ever to get prototyping by requiring no upfront desktop software downloads. Simply copy and edit files on the **CIRCUITPY**  "flash" drive to iterate. The following instructions will show you how to install CircuitPython. If you've already installed CircuitPython but are looking to update it or reinstall it, the same steps work for that as well! ## Set up CircuitPython Quick Start! Follow this quick step-by-step for super-fast Python power :) [Download the latest version of CircuitPython for the PyPortal via CircuitPython.org](https://circuitpython.org/board/pyportal/) [Download the latest version of CircuitPython for the PyPortal Pynt via CircuitPython.org](https://circuitpython.org/board/pyportal_pynt/) **Click the link above to download the latest version of CircuitPython for the PyPortal.** Download and save it to your desktop (or wherever is handy). ![circuitpython_pyportal-uf2.png](https://cdn-learn.adafruit.com/assets/assets/000/073/615/medium640/circuitpython_pyportal-uf2.png?1553610968) Plug your PyPortal into your computer using a known-good USB cable. **A lot of people end up using charge-only USB cables and it is very frustrating! So make sure you have a USB cable you know is good for data sync.** Double-click the **Reset** button on the top in the middle (magenta arrow) on your board, and you will see the NeoPixel RGB LED (green arrow) turn green. If it turns red, check the USB cable, try another USB port, etc.  **Note:** The little red LED next to the USB connector will pulse red. That's ok! If double-clicking doesn't work the first time, try again. Sometimes it can take a few tries to get the rhythm right! ![circuitpython_PyPortalResetNeoPIxel.jpg](https://cdn-learn.adafruit.com/assets/assets/000/071/993/medium640/circuitpython_PyPortalResetNeoPIxel.jpg?1551213425) You will see a new disk drive appear called **PORTALBOOT**. Drag the **adafruit-circuitpython-pyportal-\.uf2** file to **PORTALBOOT.** ![circuitpython_PyPortal_PORTALBOOT.png](https://cdn-learn.adafruit.com/assets/assets/000/072/029/medium640/circuitpython_PyPortal_PORTALBOOT.png?1551287972) ![circuitpython_PyPortal_Drag_UF2.png](https://cdn-learn.adafruit.com/assets/assets/000/072/030/medium640/circuitpython_PyPortal_Drag_UF2.png?1551287983) The LED will flash. Then, the **PORTALBOOT** drive will disappear and a new disk drive called **CIRCUITPY** will appear. If you haven't added any code to your board, the only file that will be present is **boot\_out.txt**. This is absolutely normal! It's time for you to add your **code.py** and get started! That's it, you're done! :) ![circuitpython_PyPortalCIRCUITPY.png](https://cdn-learn.adafruit.com/assets/assets/000/071/995/medium640/circuitpython_PyPortalCIRCUITPY.png?1551213875) ## PyPortal Default Files Click below to download a zip of the files that shipped on the PyPortal or PyPortal Pynt. [PyPortal Default Files](https://github.com/adafruit/circuitpython-default-files/tree/main/boards/pyportal/4.x) [PyPortal Pynt Default Files](https://github.com/adafruit/circuitpython-default-files/tree/main/boards/pyportal_pynt/5.x) # PyPortal GitHub Stars Trophy ## PyPortal CircuitPython Setup To use all the amazing features of your PyPortal with CircuitPython, you must first install a number of libraries. This page covers that process. # Adafruit CircuitPython Bundle Download the Adafruit CircuitPython Library Bundle. You can find the latest release here: [Latest Adafruit CircuitPython Library Bundle](https://circuitpython.org/libraries) Download the **adafruit-circuitpython-bundle-\*.x-mpy-\*.zip** bundle zip file where **\*.x MATCHES THE VERSION OF CIRCUITPYTHON YOU INSTALLED** , and unzip a folder of the same name. Inside you'll find a **lib** folder. You have two options: - You can add the **lib** folder to your **CIRCUITPY** drive. This will ensure you have _all the drivers_. But it will take a bunch of space on the 8 MB disk - Add each library as you need it, this will reduce the space usage but you'll need to put in a little more effort. At a minimum we recommend the following libraries, in fact we more than recommend. They're basically required. So grab them and install them into **CIRCUITPY/lib** now! - **adafruit\_esp32spi** - This is the library that gives you internet access via the ESP32 using (you guessed it!) SPI transport. You need this for anything Internet - **adafruit\_requests** - This library allows us to perform HTTP requests and get responses back from servers. GET/POST/PUT/PATCH - they're all in here! - adafruit\_connection\_manager - used by adafruit\_requests. - **adafruit\_pyportal** - This is our friendly wrapper library that does a lot of our projects, displays graphics and text, fetches data from the internet. Nearly all of our projects depend on it! - **adafruit\_portalbase**  - This library is the base library that adafruit\_pyportal library is built on top of. - **adafruit\_touchscreen** - a library for reading touches from the resistive touchscreen. Handles all the analog noodling, rotation and calibration for you. - **adafruit\_io** - this library helps connect the PyPortal to our free datalogging and viewing service - **adafruit\_imageload** - an image display helper, required for any graphics! - **adafruit\_display\_text** - not surprisingly, it displays text on the screen - **adafruit\_bitmap\_font** - we have fancy font support, and its easy to make new fonts. This library reads and parses font files. - **adafruit\_slideshow** - for making image slideshows - handy for quick display of graphics and sound - **neopixel** - for controlling the onboard neopixel - **adafruit\_adt7410** - library to read the temperature from the on-board Analog Devices ADT7410 precision temperature sensor (not necessary for Titano or Pynt) - **adafruit\_bus\_device** - low level support for I2C/SPI - **adafruit\_fakerequests**  - This library allows you to create fake HTTP requests by using local files. # PyPortal GitHub Stars Trophy ## Internet Connect! # Connect to WiFi OK, now that you have your  **settings.toml** file set up - you can connect to the Internet. To do this, you need to first install a few libraries, into the lib folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script. Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **examples/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive. Your **CIRCUITPY** drive should now look similar to the following image: ![CIRCUITPY](https://adafruit.github.io/Adafruit_CircuitPython_Bundle/esp32spi_esp32spi_simpletest.py.png ) Info: Update to CircuitPython 9.2.x or later to use this example. https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/blob/main/examples/esp32spi_simpletest.py And save it to your board, with the name **code.py**. Don't forget you'll also need to create the **settings.toml** file as seen above, with your WiFi ssid and password. In a serial console, you should see something like the following. For more information about connecting with a serial console, view the guide [Connecting to the Serial Console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console). ```terminal >>> import wifitest ESP32 SPI webclient test ESP32 found and in idle mode Firmware vers. 1.7.5 MAC addr: 24:C9:DC:BD:0F:3F HomeNetwork RSSI: -46 HomeNetwork RSSI: -76 Fios-12345 RSSI: -92 FiOS-AB123 RSSI: -92 NETGEAR53 RSSI: -93 Connecting to AP... Connected to HomeNetwork RSSI: -45 My IP address is 192.168.1.245 IP lookup adafruit.com: 104.20.39.240 Ping google.com: 30 ms Fetching text from http://wifitest.adafruit.com/testwifi/index.html ---------------------------------------- This is a test of Adafruit WiFi! If you can read this, its working :) ---------------------------------------- Fetching json from http://wifitest.adafruit.com/testwifi/sample.json ---------------------------------------- {'fun': True, 'company': 'Adafruit', 'founded': 2005, 'primes': [2, 3, 5], 'pi': 3.14, 'mixed': [False, None, 3, True, 2.7, 'cheese']} ---------------------------------------- Done! ``` Going over the example above, here's a breakdown of what the program is doing: - Initialize the ESP32 over SPI using the SPI port and 3 control pins: ```python esp32_cs = DigitalInOut(board.ESP_CS) esp32_ready = DigitalInOut(board.ESP_BUSY) esp32_reset = DigitalInOut(board.ESP_RESET) #... else: spi = busio.SPI(board.SCK, board.MOSI, board.MISO) esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) ``` - Get the socket pool and the SSL context, and then tell the `adafruit_requests` library about them. ```python pool = adafruit_connection_manager.get_radio_socketpool(esp) ssl_context = adafruit_connection_manager.get_radio_ssl_context(esp) requests = adafruit_requests.Session(pool, ssl_context) ``` - Verify an ESP32 is found, checks the firmware and MAC address ```auto if esp.status == adafruit_esp32spi.WL_IDLE_STATUS: print("ESP32 found and in idle mode") print("Firmware vers.", esp.firmware_version) print("MAC addr:", ":".join("%02X" % byte for byte in esp.MAC_address)) ``` - Perform a scan of all access points it can see and print out the name and signal strength. ```python for ap in esp.scan_networks(): print("\t%-23s RSSI: %d" % (ap.ssid, ap.rssi)) ``` - Connect to the AP we've defined here, then print out the local IP address. Then attempt to do a domain name lookup and ping google.com to check network connectivity. (Note sometimes the ping fails or takes a while; this isn't a big deal.) ```python print("Connecting to AP...") while not esp.is_connected: try: esp.connect_AP(ssid, password) except OSError as e: print("could not connect to AP, retrying: ", e) continue print("Connected to", esp.ap_info.ssid, "\tRSSI:", esp.ap_info.rssi) print("My IP address is", esp.ipv4_address) print( "IP lookup adafruit.com: %s" % esp.pretty_ip(esp.get_host_by_name("adafruit.com")) ) ``` Now we're getting to the really interesting part of the example program. We've written a library for web fetching web data, named [adafruit\_requests](https://github.com/adafruit/Adafruit_CircuitPython_Requests). It is a lot like the regular Python library named [requests](https://requests.readthedocs.io/en/latest/). This library allows you to send HTTP and HTTPS requests easily and provides helpful methods for parsing the response from the server. - Here is the part of the example program is fetching text data from a URL. ```python TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html" # Further up in the program # ... print("Fetching text from", TEXT_URL) r = requests.get(TEXT_URL) print('-' * 40) print(r.text) print('-' * 40) r.close() ``` - Finally, here the program is fetching some JSON data. The `adafruit_requests` library will parse the JSON into a Python dictionary whose structure is the same as the structure of the JSON. ```auto JSON_URL = "http://wifitest.adafruit.com/testwifi/sample.json" # Further up in the program # ... print("Fetching json from", JSON_URL) r = requests.get(JSON_URL) print('-' * 40) print(r.json()) print('-' * 40) r.close() ``` # Advanced Requests Usage Want to send custom HTTP headers, parse the response as raw bytes, or handle a response's http status code in your CircuitPython code? We've written an example to show advanced usage of the requests module below. To use with CircuitPython, you need to first install a few libraries, into the lib folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script. Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, open the directory **examples/** and then click on the directory that matches the version of CircuitPython you're using and copy the contents of that directory to your **CIRCUITPY** drive. https://github.com/adafruit/Adafruit_CircuitPython_Requests/blob/main/examples/esp32spi/requests_esp32spi_advanced.py Your **CIRCUITPY** drive should now look similar to the following image: ![CIRCUITPY](https://adafruit.github.io/Adafruit_CircuitPython_Bundle/requests_esp32spi_requests_esp32spi_advanced.py.png ) # WiFi Manager The way the examples above connect to WiFi works but it's a little finicky. Since WiFi is not necessarily so reliable, you may have disconnects and need to reconnect. For more advanced uses, we recommend using the `WiFiManager` class. It will wrap the connection/status/requests loop for you - reconnecting if WiFi drops, resetting the ESP32 if it gets into a bad state, etc. Here's a more advanced example that shows using the `WiFiManager` and also how to fetch the current time from a web source. https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/blob/main/examples/esp32spi_localtime.py # Further Information For more information on the basics of doing networking in CircuitPython, see this guide: ### Networking in CircuitPython [Networking in CircuitPython](https://learn.adafruit.com/networking-in-circuitpython) # PyPortal GitHub Stars Trophy ## Code PyPortal with CircuitPython ## CircuitPython Code In the embedded code element below, click on the **Download Project Bundle** button, and save the .zip archive file to your computer. Then, uncompress the .zip file, it will unpack to a folder named **PyPortal\_GithubStars**. Copy the contents of the  **PyPortal\_GithubStars** directory to your PyPortal **CIRCUITPY** drive. ![](https://cdn-learn.adafruit.com/assets/assets/000/072/172/medium800/internet_of_things___iot_py_star_drag.jpg?1551481479) This is what the final contents of the **CIRCUITPY** drive will look like: ![CIRCUITPY](https://adafruit.github.io/Adafruit_Learning_System_Guides/PyPortal_PyPortal_GithubStars.png ) https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/main/PyPortal/PyPortal_GithubStars/code.py Warning: ## How It Works The PyPortal Stats Trophy is doing a couple of neat-o things to provide for your stats-tastic display needs! ### Background First, it displays a bitmap graphic as the screen's background. This is a 320 x 240 pixel RGB 16-bit raster graphic in **.bmp** format. ![](https://cdn-learn.adafruit.com/assets/assets/000/072/611/medium800/internet_of_things___iot_git16.bmp?1552411827) ### Font Then, it displays the repo's name as a caption, created with bitmapped fonts to overlay on top of the background. The fonts used here is are bitmap fonts made from the Collegiate and Arial typefaces. You can learn more about [converting type in this guide](https://learn.adafruit.com/custom-fonts-for-pyportal-circuitpython-display). Next, the PyPortal will display the current number of GitHub Stars for the repository. ### JSON To keep things current, the Star count is grabbed from the website itself. GitHub automatically generates a JSON file for each repo, in this case at the address **https://api.github.com/repos/adafruit/circuitpython** This file contains all sorts of information, delivered in an easy-to-parse format. If you visit that URL by copying the address in to your browser, your browser may return it as a somewhat difficult to read chunk of raw text, or if you view it in Firefox, it will format it nicely for reading. You can also use online code "beautifiers" such as [https://codebeautify.org/jsonviewer](https://codebeautify.org/jsonviewer) or [http://jsonviewer.stack.hu](http://jsonviewer.stack.hu) ![](https://cdn-learn.adafruit.com/assets/assets/000/072/146/medium800/internet_of_things___iot_Screen_Shot_2019-03-01_at_12.36.03_PM.png?1551472583) Here it is in a raw-er form, but still using indentation and carriage returns to make it readable: ```auto { "id": 66166069, "node_id": "MDEwOlJlcG9zaXRvcnk2NjE2NjA2OQ==", "name": "circuitpython", "full_name": "adafruit/circuitpython", "private": false, "owner": { "login": "adafruit", "id": 181069, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE4MTA2OQ==", "avatar_url": "https://avatars3.githubusercontent.com/u/181069?v=4", "gravatar_id": "", "url": "https://api.github.com/users/adafruit", "html_url": "https://github.com/adafruit", "followers_url": "https://api.github.com/users/adafruit/followers", "following_url": "https://api.github.com/users/adafruit/following{/other_user}", "gists_url": "https://api.github.com/users/adafruit/gists{/gist_id}", "starred_url": "https://api.github.com/users/adafruit/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/adafruit/subscriptions", "organizations_url": "https://api.github.com/users/adafruit/orgs", "repos_url": "https://api.github.com/users/adafruit/repos", "events_url": "https://api.github.com/users/adafruit/events{/privacy}", "received_events_url": "https://api.github.com/users/adafruit/received_events", "type": "Organization", "site_admin": false }, "html_url": "https://github.com/adafruit/circuitpython", "description": "CircuitPython - a Python implementation for teaching coding with microcontrollers", "fork": true, "url": "https://api.github.com/repos/adafruit/circuitpython", "forks_url": "https://api.github.com/repos/adafruit/circuitpython/forks", "keys_url": "https://api.github.com/repos/adafruit/circuitpython/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/adafruit/circuitpython/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/adafruit/circuitpython/teams", "hooks_url": "https://api.github.com/repos/adafruit/circuitpython/hooks", "issue_events_url": "https://api.github.com/repos/adafruit/circuitpython/issues/events{/number}", "events_url": "https://api.github.com/repos/adafruit/circuitpython/events", "assignees_url": "https://api.github.com/repos/adafruit/circuitpython/assignees{/user}", "branches_url": "https://api.github.com/repos/adafruit/circuitpython/branches{/branch}", "tags_url": "https://api.github.com/repos/adafruit/circuitpython/tags", "blobs_url": "https://api.github.com/repos/adafruit/circuitpython/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/adafruit/circuitpython/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/adafruit/circuitpython/git/refs{/sha}", "trees_url": "https://api.github.com/repos/adafruit/circuitpython/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/adafruit/circuitpython/statuses/{sha}", "languages_url": "https://api.github.com/repos/adafruit/circuitpython/languages", "stargazers_url": "https://api.github.com/repos/adafruit/circuitpython/stargazers", "contributors_url": "https://api.github.com/repos/adafruit/circuitpython/contributors", "subscribers_url": "https://api.github.com/repos/adafruit/circuitpython/subscribers", "subscription_url": "https://api.github.com/repos/adafruit/circuitpython/subscription", "commits_url": "https://api.github.com/repos/adafruit/circuitpython/commits{/sha}", "git_commits_url": "https://api.github.com/repos/adafruit/circuitpython/git/commits{/sha}", "comments_url": "https://api.github.com/repos/adafruit/circuitpython/comments{/number}", "issue_comment_url": "https://api.github.com/repos/adafruit/circuitpython/issues/comments{/number}", "contents_url": "https://api.github.com/repos/adafruit/circuitpython/contents/{+path}", "compare_url": "https://api.github.com/repos/adafruit/circuitpython/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/adafruit/circuitpython/merges", "archive_url": "https://api.github.com/repos/adafruit/circuitpython/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/adafruit/circuitpython/downloads", "issues_url": "https://api.github.com/repos/adafruit/circuitpython/issues{/number}", "pulls_url": "https://api.github.com/repos/adafruit/circuitpython/pulls{/number}", "milestones_url": "https://api.github.com/repos/adafruit/circuitpython/milestones{/number}", "notifications_url": "https://api.github.com/repos/adafruit/circuitpython/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/adafruit/circuitpython/labels{/name}", "releases_url": "https://api.github.com/repos/adafruit/circuitpython/releases{/id}", "deployments_url": "https://api.github.com/repos/adafruit/circuitpython/deployments", "created_at": "2016-08-20T20:10:40Z", "updated_at": "2019-03-01T20:31:34Z", "pushed_at": "2019-03-01T19:07:33Z", "git_url": "git://github.com/adafruit/circuitpython.git", "ssh_url": "git@github.com:adafruit/circuitpython.git", "clone_url": "https://github.com/adafruit/circuitpython.git", "svn_url": "https://github.com/adafruit/circuitpython", "homepage": "", "size": 57300, "stargazers_count": 1059, "watchers_count": 1059, "language": "C", "has_issues": true, "has_projects": false, "has_downloads": true, "has_wiki": false, "has_pages": false, "forks_count": 204, "mirror_url": null, "archived": false, "open_issues_count": 157, "license": { "key": "other", "name": "Other", "spdx_id": "NOASSERTION", "url": null, "node_id": "MDc6TGljZW5zZTA=" }, "forks": 204, "open_issues": 157, "watchers": 1059, "default_branch": "master", "organization": { "login": "adafruit", "id": 181069, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE4MTA2OQ==", "avatar_url": "https://avatars3.githubusercontent.com/u/181069?v=4", "gravatar_id": "", "url": "https://api.github.com/users/adafruit", "html_url": "https://github.com/adafruit", "followers_url": "https://api.github.com/users/adafruit/followers", "following_url": "https://api.github.com/users/adafruit/following{/other_user}", "gists_url": "https://api.github.com/users/adafruit/gists{/gist_id}", "starred_url": "https://api.github.com/users/adafruit/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/adafruit/subscriptions", "organizations_url": "https://api.github.com/users/adafruit/orgs", "repos_url": "https://api.github.com/users/adafruit/repos", "events_url": "https://api.github.com/users/adafruit/events{/privacy}", "received_events_url": "https://api.github.com/users/adafruit/received_events", "type": "Organization", "site_admin": false }, "parent": { "id": 15337142, "node_id": "MDEwOlJlcG9zaXRvcnkxNTMzNzE0Mg==", "name": "micropython", "full_name": "micropython/micropython", "private": false, "owner": { "login": "micropython", "id": 6298560, "node_id": "MDEyOk9yZ2FuaXphdGlvbjYyOTg1NjA=", "avatar_url": "https://avatars1.githubusercontent.com/u/6298560?v=4", "gravatar_id": "", "url": "https://api.github.com/users/micropython", "html_url": "https://github.com/micropython", "followers_url": "https://api.github.com/users/micropython/followers", "following_url": "https://api.github.com/users/micropython/following{/other_user}", "gists_url": "https://api.github.com/users/micropython/gists{/gist_id}", "starred_url": "https://api.github.com/users/micropython/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/micropython/subscriptions", "organizations_url": "https://api.github.com/users/micropython/orgs", "repos_url": "https://api.github.com/users/micropython/repos", "events_url": "https://api.github.com/users/micropython/events{/privacy}", "received_events_url": "https://api.github.com/users/micropython/received_events", "type": "Organization", "site_admin": false }, "html_url": "https://github.com/micropython/micropython", "description": "MicroPython - a lean and efficient Python implementation for microcontrollers and constrained systems", "fork": false, "url": "https://api.github.com/repos/micropython/micropython", "forks_url": "https://api.github.com/repos/micropython/micropython/forks", "keys_url": "https://api.github.com/repos/micropython/micropython/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/micropython/micropython/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/micropython/micropython/teams", "hooks_url": "https://api.github.com/repos/micropython/micropython/hooks", "issue_events_url": "https://api.github.com/repos/micropython/micropython/issues/events{/number}", "events_url": "https://api.github.com/repos/micropython/micropython/events", "assignees_url": "https://api.github.com/repos/micropython/micropython/assignees{/user}", "branches_url": "https://api.github.com/repos/micropython/micropython/branches{/branch}", "tags_url": "https://api.github.com/repos/micropython/micropython/tags", "blobs_url": "https://api.github.com/repos/micropython/micropython/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/micropython/micropython/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/micropython/micropython/git/refs{/sha}", "trees_url": "https://api.github.com/repos/micropython/micropython/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/micropython/micropython/statuses/{sha}", "languages_url": "https://api.github.com/repos/micropython/micropython/languages", "stargazers_url": "https://api.github.com/repos/micropython/micropython/stargazers", "contributors_url": "https://api.github.com/repos/micropython/micropython/contributors", "subscribers_url": "https://api.github.com/repos/micropython/micropython/subscribers", "subscription_url": "https://api.github.com/repos/micropython/micropython/subscription", "commits_url": "https://api.github.com/repos/micropython/micropython/commits{/sha}", "git_commits_url": "https://api.github.com/repos/micropython/micropython/git/commits{/sha}", "comments_url": "https://api.github.com/repos/micropython/micropython/comments{/number}", "issue_comment_url": "https://api.github.com/repos/micropython/micropython/issues/comments{/number}", "contents_url": "https://api.github.com/repos/micropython/micropython/contents/{+path}", "compare_url": "https://api.github.com/repos/micropython/micropython/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/micropython/micropython/merges", "archive_url": "https://api.github.com/repos/micropython/micropython/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/micropython/micropython/downloads", "issues_url": "https://api.github.com/repos/micropython/micropython/issues{/number}", "pulls_url": "https://api.github.com/repos/micropython/micropython/pulls{/number}", "milestones_url": "https://api.github.com/repos/micropython/micropython/milestones{/number}", "notifications_url": "https://api.github.com/repos/micropython/micropython/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/micropython/micropython/labels{/name}", "releases_url": "https://api.github.com/repos/micropython/micropython/releases{/id}", "deployments_url": "https://api.github.com/repos/micropython/micropython/deployments", "created_at": "2013-12-20T11:47:07Z", "updated_at": "2019-03-01T18:51:51Z", "pushed_at": "2019-03-01T16:47:12Z", "git_url": "git://github.com/micropython/micropython.git", "ssh_url": "git@github.com:micropython/micropython.git", "clone_url": "https://github.com/micropython/micropython.git", "svn_url": "https://github.com/micropython/micropython", "homepage": "https://micropython.org", "size": 39688, "stargazers_count": 7996, "watchers_count": 7996, "language": "C", "has_issues": true, "has_projects": true, "has_downloads": true, "has_wiki": true, "has_pages": false, "forks_count": 2298, "mirror_url": null, "archived": false, "open_issues_count": 713, "license": { "key": "mit", "name": "MIT License", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZTEz" }, "forks": 2298, "open_issues": 713, "watchers": 7996, "default_branch": "master" }, "source": { "id": 15337142, "node_id": "MDEwOlJlcG9zaXRvcnkxNTMzNzE0Mg==", "name": "micropython", "full_name": "micropython/micropython", "private": false, "owner": { "login": "micropython", "id": 6298560, "node_id": "MDEyOk9yZ2FuaXphdGlvbjYyOTg1NjA=", "avatar_url": "https://avatars1.githubusercontent.com/u/6298560?v=4", "gravatar_id": "", "url": "https://api.github.com/users/micropython", "html_url": "https://github.com/micropython", "followers_url": "https://api.github.com/users/micropython/followers", "following_url": "https://api.github.com/users/micropython/following{/other_user}", "gists_url": "https://api.github.com/users/micropython/gists{/gist_id}", "starred_url": "https://api.github.com/users/micropython/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/micropython/subscriptions", "organizations_url": "https://api.github.com/users/micropython/orgs", "repos_url": "https://api.github.com/users/micropython/repos", "events_url": "https://api.github.com/users/micropython/events{/privacy}", "received_events_url": "https://api.github.com/users/micropython/received_events", "type": "Organization", "site_admin": false }, "html_url": "https://github.com/micropython/micropython", "description": "MicroPython - a lean and efficient Python implementation for microcontrollers and constrained systems", "fork": false, "url": "https://api.github.com/repos/micropython/micropython", "forks_url": "https://api.github.com/repos/micropython/micropython/forks", "keys_url": "https://api.github.com/repos/micropython/micropython/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/micropython/micropython/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/micropython/micropython/teams", "hooks_url": "https://api.github.com/repos/micropython/micropython/hooks", "issue_events_url": "https://api.github.com/repos/micropython/micropython/issues/events{/number}", "events_url": "https://api.github.com/repos/micropython/micropython/events", "assignees_url": "https://api.github.com/repos/micropython/micropython/assignees{/user}", "branches_url": "https://api.github.com/repos/micropython/micropython/branches{/branch}", "tags_url": "https://api.github.com/repos/micropython/micropython/tags", "blobs_url": "https://api.github.com/repos/micropython/micropython/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/micropython/micropython/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/micropython/micropython/git/refs{/sha}", "trees_url": "https://api.github.com/repos/micropython/micropython/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/micropython/micropython/statuses/{sha}", "languages_url": "https://api.github.com/repos/micropython/micropython/languages", "stargazers_url": "https://api.github.com/repos/micropython/micropython/stargazers", "contributors_url": "https://api.github.com/repos/micropython/micropython/contributors", "subscribers_url": "https://api.github.com/repos/micropython/micropython/subscribers", "subscription_url": "https://api.github.com/repos/micropython/micropython/subscription", "commits_url": "https://api.github.com/repos/micropython/micropython/commits{/sha}", "git_commits_url": "https://api.github.com/repos/micropython/micropython/git/commits{/sha}", "comments_url": "https://api.github.com/repos/micropython/micropython/comments{/number}", "issue_comment_url": "https://api.github.com/repos/micropython/micropython/issues/comments{/number}", "contents_url": "https://api.github.com/repos/micropython/micropython/contents/{+path}", "compare_url": "https://api.github.com/repos/micropython/micropython/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/micropython/micropython/merges", "archive_url": "https://api.github.com/repos/micropython/micropython/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/micropython/micropython/downloads", "issues_url": "https://api.github.com/repos/micropython/micropython/issues{/number}", "pulls_url": "https://api.github.com/repos/micropython/micropython/pulls{/number}", "milestones_url": "https://api.github.com/repos/micropython/micropython/milestones{/number}", "notifications_url": "https://api.github.com/repos/micropython/micropython/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/micropython/micropython/labels{/name}", "releases_url": "https://api.github.com/repos/micropython/micropython/releases{/id}", "deployments_url": "https://api.github.com/repos/micropython/micropython/deployments", "created_at": "2013-12-20T11:47:07Z", "updated_at": "2019-03-01T18:51:51Z", "pushed_at": "2019-03-01T16:47:12Z", "git_url": "git://github.com/micropython/micropython.git", "ssh_url": "git@github.com:micropython/micropython.git", "clone_url": "https://github.com/micropython/micropython.git", "svn_url": "https://github.com/micropython/micropython", "homepage": "https://micropython.org", "size": 39688, "stargazers_count": 7996, "watchers_count": 7996, "language": "C", "has_issues": true, "has_projects": true, "has_downloads": true, "has_wiki": true, "has_pages": false, "forks_count": 2298, "mirror_url": null, "archived": false, "open_issues_count": 713, "license": { "key": "mit", "name": "MIT License", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZTEz" }, "forks": 2298, "open_issues": 713, "watchers": 7996, "default_branch": "master" }, "network_count": 2298, "subscribers_count": 109 } ``` ## Keys If we look a bit further down the JSON page, we'll see a **key** called `stargazers_count` that has a **value** of 1059. The raw JSON for this **key : value** pair looks like this: `"stargazers_count": 1059` Our CircuitPython code is able to grab and parse this data using these variables: ```auto DATA_SOURCE = "https://api.github.com/repos/adafruit/circuitpython" DATA_LOCATION = ["stargazers_count"] ``` ## Traversing JSON The `DATA_LOCATION` contains a value that we use to traverse the JSON file. In the image above, note how there is a tree hierarchy indicated by the indentation level. The `stargazer_count` key is at the root level of the file's hierarchy, so we can call it explicitly. In some JSON files, the key you seek may have a parent or parents that must be traversed as well. ## PyPortal Constructor When we set up the `pyportal` constructor, we are providing it with these things: - `url` to query - `json_path` to traverse and find the key:value pair we need - `default_bg` path and name to display the background bitmap - `text_font` path and name to the font used for displaying the star count value - `text_position` on the screen's x/y coordinate system - `text_color` - `caption_text` to display statically -- in this case the name of the repo - `caption_font` - `caption_position` - `caption_color` ## Fetch With the pyportal set up, we can then use `pyportal.fetch()` to do the query and parsing of the GitHub data and then display it on screen along with the caption text on top of the background image. ## Ba-Ding! Additionally, we use the `last_value` variable's state to compare against the latest value. If they differ, we play the **coin.wav** file for a satisfying ding over the PyPortal's built in speaker! To make your own .wav files, [check out this guide](https://learn.adafruit.com/microcontroller-compatible-audio-file-conversion). ## Customization You can customize this project to make it your own and point to different website API's as the source of your JSON data, as well as adjust the graphics and text. ## Text Position Depending on the design of your background bitmap and the length of the text you're displaying, you may want to reposition the text and caption. You can do this with the `text_position` and `caption_position` options. The PyPortal's display is 320 pixels wide and 240 pixels high. In order to refer to those positions on the screen, we use an x/y coordinate system, where x is horizontal and y is vertical. The origin of this coordinate system is the upper left corner. This means that a pixel placed at the upper left corner would be (0,0) and the lower right corner would be (320, 240). ![](https://cdn-learn.adafruit.com/assets/assets/000/072/123/medium800/internet_of_things___iot_pyportal_grid.jpg?1551460792) So, if you wanted to move the subscriber count text to the right and up closer to the top, your code may look like this for that part of the pyportal constructor: `text_position=(250, 10)` ## Text Color Another way to customize your stats trophy is to adjust the color of the text. The line `text_color=0xFFFFFF` in the constructor shows how. You will need to use the hexidecimal value for any color you want to display. You can use something like [https://htmlcolorcodes.com/](https://htmlcolorcodes.com/) to pick your color and then copy the hex value, in this example it would be `0x0ED9EE` ![](https://cdn-learn.adafruit.com/assets/assets/000/072/129/medium800/internet_of_things___iot_hecxolor.png?1551462671) ## Background Image If you would like to create your own background, awesome! You'll want to save the file with these specifications: - 320 x 240 pixels - 24-bit RGB color (8-bits per channel) - Save file as .bmp format You can then copy the .bmp file to the root level of the **CIRCUITPY** drive. Make sure you refer to this new filename in the pyportal constructor line: `default_bg=cwd+"/stars_background.bmp"` Change that line to use the new filename name, such as: `default_bg=cwd+"/my_new_background.bmp"` ## Advanced Option: API Key The GitHub API allows up to ten queries per minute for an unauthenticated request. If you would like to query your GitHub stars stats at a higher rate, up to 30 per minute, you can do so by adding your GitHub API key token to the `settings.toml` file. The code we're using checks for the presence of the `github_token` variable in the file, and if it's there, it adds that argument to the query. [Here's more info](https://developer.github.com/v3/search/) on the query limits. To get a token, [follow these instruction](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line). Once you have your token, add it to the `settings.toml` file. Your file should look something like this: ```auto CIRCUITPY_WIFI_SSID="your-wifi-ssid" CIRCUITPY_WIFI_PASSWORD="your-wifi-password" timezone="America/Los_Angeles" # this is offset from UTC location="Los Angeles, US" github_token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" ``` Save your `settings.toml` file and now you can query three times as fast! Now, we'll look at mounting the PyPortal onto a trophy for display! # PyPortal GitHub Stars Trophy ## Build the Trophy ![](https://cdn-learn.adafruit.com/assets/assets/000/072/142/medium800/internet_of_things___iot_IMG_4335_2k.jpg?1551471937) Now that you've got your PyPortal displaying your stats, dress things up a bit with a re-purposed trophy! C'mon, you know you've got one in a box somewhere. If not, get one at a yard sale or thrift shop. ## Prep Remove off any unnecessary parts or labels from your trophy if you like. In this case, I'm going to mount the PyPortal in the center, so I'll remove the (admittedly awesome) spinning "KICKBALL" element. ![internet_of_things___iot_IMG_4288_2k.jpg](https://cdn-learn.adafruit.com/assets/assets/000/072/049/medium640/internet_of_things___iot_IMG_4288_2k.jpg?1551307475) ![internet_of_things___iot_IMG_4296_2k.jpg](https://cdn-learn.adafruit.com/assets/assets/000/072/050/medium640/internet_of_things___iot_IMG_4296_2k.jpg?1551307484) ## Mounting ![](https://cdn-learn.adafruit.com/assets/assets/000/072/051/medium800/internet_of_things___iot_IMG_4298_2k.jpg?1551307607) Using zip ties, connect each of the four mounting holes of the PyPortal to the trophy. Alternately, you can use double-stick foam mounting tape or some other method to mount it. ![internet_of_things___iot_IMG_4299_2k.jpg](https://cdn-learn.adafruit.com/assets/assets/000/072/052/medium640/internet_of_things___iot_IMG_4299_2k.jpg?1551307677) ![internet_of_things___iot_IMG_4300_2k.jpg](https://cdn-learn.adafruit.com/assets/assets/000/072/053/medium640/internet_of_things___iot_IMG_4300_2k.jpg?1551307684) ![internet_of_things___iot_IMG_4301_2k.jpg](https://cdn-learn.adafruit.com/assets/assets/000/072/054/medium640/internet_of_things___iot_IMG_4301_2k.jpg?1551307690) ![](https://cdn-learn.adafruit.com/assets/assets/000/072/055/medium800/internet_of_things___iot_IMG_4302_2k.jpg?1551307762) Now, your display is complete, just plug it into USB power and admire your achievements! https://youtu.be/P7ScnII0Xgc ## Guide Products ### Adafruit PyPortal - CircuitPython Powered Internet Display [Adafruit PyPortal - CircuitPython Powered Internet Display](https://www.adafruit.com/product/4116) **PyPortal** , our easy-to-use IoT device that allows you to create all the things for the “Internet of Things” in minutes. Make custom touch screen interface GUIs, all open-source, and Python-powered using tinyJSON / APIs to get news, stock, weather, cat photos,... In Stock [Buy Now](https://www.adafruit.com/product/4116) [Related Guides to the Product](https://learn.adafruit.com/products/4116/guides) ### USB cable - USB A to Micro-B [USB cable - USB A to Micro-B](https://www.adafruit.com/product/592) This here is your standard A to micro-B USB cable, for USB 1.1 or 2.0. Perfect for connecting a PC to your Metro, Feather, Raspberry Pi or other dev-board or microcontroller Approximately 3 feet / 1 meter long In Stock [Buy Now](https://www.adafruit.com/product/592) [Related Guides to the Product](https://learn.adafruit.com/products/592/guides) ## Related Guides - [Adafruit PyPortal - IoT for CircuitPython](https://learn.adafruit.com/adafruit-pyportal.md) - [Crawling Animatronic Hand](https://learn.adafruit.com/crawling-hand-with-cpx-and-makecode.md) - [How to Make Animated Graphics for Hologram Displays](https://learn.adafruit.com/how-to-make-animated-graphics-for-hologram-displays.md) - [CircuitPython Twitter Viewer Using the Twitter API](https://learn.adafruit.com/twitter-api-use.md) - [PyPortal Reddit Stats Trophy](https://learn.adafruit.com/pyportal-reddit-stats-trophy.md) - [CLUE Rock, Paper, Scissors Game using Bluetooth](https://learn.adafruit.com/rock-paper-scissors-circuitpython.md) - [PyPortal Hurricane Tracker](https://learn.adafruit.com/pyportal-hurricane-tracker.md) - [Multi-tasking with CircuitPython](https://learn.adafruit.com/multi-tasking-with-circuitpython.md) - [Adafruit Feather M0 Basic Proto](https://learn.adafruit.com/adafruit-feather-m0-basic-proto.md) - [Using the Bluefruit Dashboard with Web Bluetooth in Chrome](https://learn.adafruit.com/bluefruit-dashboard-web-bluetooth-chrome.md) - [CircuitPython BLE Advertising Beacons](https://learn.adafruit.com/circuitpython-ble-advertising-beacons.md) - [CLUE Sensor Plotter in CircuitPython](https://learn.adafruit.com/clue-sensor-plotter-circuitpython.md) - [CircuitPython Day 2020 Countdown Clock](https://learn.adafruit.com/circuitpython-day-2020-countdown-clock.md) - [Clue Coffee Scale](https://learn.adafruit.com/clue-coffee-scale.md) - [PyPortal Winamp MP3 Player](https://learn.adafruit.com/pyportal-winamp-mp3-player.md) - [Circuit Playground Express: Piano de Limones](https://learn.adafruit.com/circuit-playground-express-piano-de-limones.md)