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_album()

Get the album name

Args: None

Returns:

(str) the album name

get_artist()

Get the artist

Args: None

Returns:

(str) the artist name

get_current()

Get the current data information

Args: None

Returns: None

get_data()

Get the raw 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: None

Returns: None

get_label()

Get the label name

Args: None

Returns:

(str) the label name

get_next()

Get the next data information

Args: None

Returns: None

get_prev()

Get the previous data information

Args: None

Returns: None

get_title()

Get the title

Args: None

Returns:

(str) the song name

Command-Line Interface (CLI)