README.md

newyorker

 
PLUGIN: newyorker v:0.1.1

 
FUNCTION: update_function
update function for newyorker provides a New Yorker comic of the day
    
    This plugin provides an image and text pulled from the New Yorker 
    
    Requirments:
        self.config(dict): {
            'day_range': 'number of days to pull comics from (default: 5)',
        }    
    
    Args:
        self(`namespace`)
        day_range(`int`): number of days in the past to pull radom comic and text from
            use 1 to only pull from today
        
    Returns:
        tuple: (is_updated(bool), data(dict), priority(int))
    
    This plugin is inspired and based on the veeb.ch [stonks project](https://github.com/veebch/stonks)
        
    
___________________________________________________________________________
 
 

SAMPLE CONFIGURATION FOR paperpi.plugins.newyorker.newyorker

[Plugin: New Yorker Comic]
layout = layout
plugin = newyorker
day_range = 5 # number of past days to choose from
refresh_rate = 120
min_display_time = 60
max_priority = 2

 
LAYOUTS AVAILABLE:
  default
  layout
 

DATA KEYS AVAILABLE FOR USE IN LAYOUTS PROVIDED BY paperpi.plugins.newyorker.newyorker:
   comic
   text
   time

Provided Layouts

layout: default

layout: layout