cufflinks.auth module

Based in Plotly’s tools module

cufflinks.auth.check_file_permissions()

cufflinks.auth.ensure_local_files()

Ensure that filesystem is setup/filled out in a valid way

cufflinks.auth.get_config_file(*args)

Return specified args from ~/.confg. as dict. Returns all if no arguments are specified.

Example:

get_config_file(‘sharing’)

cufflinks.auth.get_path()

cufflinks.auth.get_pickle_path()

cufflinks.auth.load_json_dict(filename, *args)

Checks if file exists. Returns {} if something fails.

cufflinks.auth.save_json_dict(filename, json_dict)

Will error if filename is not appropriate, but it’s checked elsewhere.

cufflinks.auth.set_config_file(sharing=None, theme=None, colorscale=None, offline=None, offline_url=None, offline_show_link=None, offline_link_text=None, datagen_mode=None, **kwargs)

Set the keyword-value pairs in ~/.config.

sharing : string

Sets the sharing level permission

public - anyone can see this chart private - only you can see this chart secret - only people with the link can see the chart

theme : string

Sets the default theme See cufflinks.getThemes() for available themes

colorscale : string

Sets the default colorscale See cufflinks.scales()

offline : bool

If true then the charts are rendered locally.

offline_show_link : bool

If true then the chart will show a link to plot.ly at the bottom right of the chart

offline_link_text : string

Text to display as link at the bottom right of the chart

datagen_mode : string

Mode in which the data is generated by the datagen module

stocks : random stock names are used for the index abc : alphabet values are used for the index

dimensions : tuple

Sets the default (width,height) of the chart

margin : dict or tuple

Dictionary (l,r,b,t) or Tuple containing the left, right, bottom and top margins