howfairis.readme module¶
-
class
howfairis.readme.
Readme
(filename: Optional[str] = None, text: Optional[str] = None, file_format: Optional[howfairis.readme_format.ReadmeFormat] = None, ignore_commented_badges: bool = True)¶ Bases:
object
Container for the README of a repository
- Parameters
filename – Name of README
text – Content of README
file_format – Format of README. It is used to ignore commented out badges.
ignore_commented_badges – If False commented out badges will be considered.
-
file_format
¶ Format of README
- Type
-
COMPLIANT_SYMBOL
= '%E2%97%8F'¶ this is a compliant symbol used in
get_compliance()
-
NONCOMPLIANT_SYMBOL
= '%E2%97%8B'¶ this is a non-compliant symbol used in
get_compliance()
-
SEPARATOR
= '%20%20'¶ this is a separator symbol used in
get_compliance()
-
get_compliance
() → Optional[howfairis.compliance.Compliance]¶ Retrieve compliance from README based on presence of the FAIR Software badge.
- Returns
Compliance object when badge is found otherwise None.