friendlypins.board module

Primitives for interacting with Pinterest boards

class friendlypins.board.Board(data, rest_io)[source]

Bases: object

Abstraction around a Pinterest board

Parameters:
  • data (dict) – Raw Pinterest API data describing the board
  • rest_io (friendlypins.utils.rest_io.RestIO) – reference to the Pinterest REST API
delete()[source]

Removes this board and all pins attached to it

description

Gets the descriptive text associated with this board

Return type:str
name

The name of the board

Return type:str
num_pins

Gets the total number of pins linked to this board

Return type:int
pins

Generator for iterating over the pins linked to this board

Return type:Generator of friendlypins.pin.Pin
unique_id

The unique identifier associated with this board

Return type:int
url

Web address for the UI associated with the dashboard

Return type:str