#17 readability metrics first pass

[ats0stv]

Added calculator for calculating the following readability metrics

• Flesch Reading Ease Score
• Flesch-Kincaid Grade Level
• Gunning Fog Index
• Automated Readability Index
• Simple Measure of Gobbledygook
• Coleman-Liau Index
• Linsear Write Score

The following is not implemented.

• Fry Readability Formula

Defined the output model as follows.

class OutputDataModel:
    def __init__(self):
        LOG.debug(f"{__name__} init")
        self.coreMetrics = CoreMetrics()
        self.readabilityMetrics = ReadabilityMetrics()
        self.category = ""
        self.description = ""

The output object can be accessed as follows.

from lisibilite.Lisibilite import Lisibilite
    def sample():
        readabilityWithFile = Lisibilite("./resources/sample_text.txt")
        output = readabilityWithFile.getReadabilityMetrics()
        print(output)

Sample Output

*** Core Metrics
Total Sentences = 11
Total Words = 54
Total Hard Words = 51
Total Easy Words = 3
Total Syllables = 82
Total Characters = 260

*** Readability Metrics
Automated Readability Index  = 3.7023232323232307
Coleman-Liau Index  = 6.481481481481481
Flesch-Kincaid Grade Level  = 4.243063973063972
Flesch Reading Ease Score  = 73.38560606060608
Fry Readability Formula  = 0.0
Gunning Fog Index  = 39.74141414141414
Linsear Write Score  = 6.09090909090909
Simple Measure of Gobbledygook  = 15.429909175157395
Category = 
Description =