Archives

Categories

v1.0 • released 2014-01-19 • Download on GitHubFull Write-up

FeedPress Subscribers Panel

FeedPress Subscribers Panel

Made to grab several days of stats from multiple feeds on FeedPress and create a JSON file with feed data for a Panic Status Board Graph Panel.

If you only want to see seven days of stats from one feed, FeedPress already has you covered.

Originally written to graph stats for The Optical Podcast. If you like 80’s effects movies, and interviews with effects artists, please give it a listen: http://opticalpodcast.com

Requirements

At least one feed hosted on FeedPress.

Written against Python 2.7.5. Not tested against any other versions, but it’s pretty simple, so expect it’s fairly portable.

This script requires Requests for its URL handling, and was written against v2.2.0. If you have pip, it’s easy to install:

Don’t forget to customize your API_KEY, API_TOKEN, and FEEDS at the top. These are required to access the API and get your data. More information about the FeedPress API, and how to get your tokens, is available at http://feedpress.it/api.

Customization

Under FEEDS, 'name' is what your feed is called on FeedPress. for example:

The 'alias' is what you’d like that feed to be titled in the graph’s key. In the example above, that’s “Tumblr”, “Enhanced AAC” and “MP3”.

Note that the current version of Status Board makes these terms conform to Title Case, so abbreviations like “AAC” and “MP3” look a little weird. Panic’s handling of this may change in future versions.

The 'color' is what color each line will be drawn with on the graph. Color values can be yellow, green, red, purple, blue, mediumGray, pink, aqua, orange, or lightGray, according to the Status Board 1.3 Graph Tutorial documentation.

GRAPH_TITLE is the title of the graph, “The Optical Subscribers” in the example above.

HISTORY_LENGTH is an integer number of days you’d like to see plotted on the graph.

Known issue: If all of the feeds don’t have the same number of days available, the graph gets screwed up. Status Board 1.3 seems to assume all of the graph lines start on the same date, and left-justifies all of the graph lines, so they no longer line up with each other. A quick workaround is just to keep the HISTORY_LENGTH to the number of days for which you have data for all feeds.

DATE_FORMAT controls the date shown along the X-axis (bottom) of the graph. Use standard Python date formatters to customize this.

FILE_PATH is the file that you’re going to write the JSON data to, which you’ll then load up in Status Board.

Operation

Once you have it customized to fetch your data, the script is run from the command line like any Python script:

You can make it run on a schedule by adding it to your cron jobs, or if you’d like a GUI to set that up with, I recommend Lingon, which lets you easily add scheduled tasks on Mac OS X.

FeedPress (as of this writing) only updates their stats once a day, so there’s no sense in scheduling this script to run more often than that. Check your feed’s Dashboard page on their site to see the countdown until the next update, to get a sense of what time of day you should schedule your script to run. For instance:

Next subscribers count update in 11 hours, 26 minutes.

Loading it up in Status Board is pretty simple, but you can see Panic’s Graph Tutorial for more information.

The easiest way (unless you’re running a web server) is to write the file to your Dropbox account, which you can also access in the most recent versions of Status board.

Support

This script is officially unsupported, but if you run into any real snags, say hi on Twitter, and I’ll see what I can do to help.


© 2014 Mark Boszko
Released under The MIT License (MIT)
http://opensource.org/licenses/MIT

Use as you like. Enjoy!

If you have comments, please share them with me on Twitter or Facebook.

You should check out my podcast about movie magic and VFX: The Optical.