insert_github_config

nbreport.userconfig.insert_github_config(config, username, token, token_note=None)

Insert a github field into the configuration data with GitHub authentication information (username and personal access token).

Parameters:

config : ruamel.yaml.comments.CommentedMap

The configuration data, as a native ruamel.yaml map type.

username : str

GitHub username.

token : str

GitHub personal access token belonging to the user.

note : str, optional

Note (YAML comment) to associate with the token field.

Returns:

config : ruamel.yaml.comments.CommentedMap

The configuration data, as a native ruamel.yaml map type.