radtools.logo#
- radtools.logo(info=None, line_length=71, flat=False, date_time=False, comment=None)[source]#
Logo generator for rad-tools package.
Returns the logo and information about the package.
- Parameters:
- infolist of str, optional
Information about the package. will be displayed below the logo. Each element should not exceed 59 characters. by default it displays the version, release date, git hash and documentation link. You can pass th empty list to display the logo only.
- line_lengthint
Length of the lines to be returned. Minimum value is 71.
- flatbool
Whether to return a flat logo or not.
- date_timebool, default False
Whether to include the date and time to the standard info or not.
- commentstr or bool, optional
Whether to use some character at the end of each string. If bool and True, then "# " is used. If str, then this string is used. If None, then no character is used.
- Returns
- -------
- logo_infostr
Logo and information about the package.