API

This part of the documentation describes the full reference API of the classes and functions.

Fip

Fip module

This module manages the Fip class in order to request the data and save them.

Todo:

• Improve docstrings
• Log eventually events
• Add an authentification system in another file or here

class fip.fip.Fip

Fip class

Instanciate an object that will request data from Fip server

__init__()

Constructor of the Fip class

Initialize the instance

get_data(offset=0)

Get the data from the server

Send a request to the FIP server to grab a specific JSON file containing the information related to lastest songs played on the radio.

Args:

offset (int): Offset to grab the next song information (but could

be the previous too).

get_key(name)

Return the data according to its key

Args:

name (str): Name of the key to get.

Returns:

String: return the data according to its key or None:

Command-Line Interface (CLI)