Metadata-Version: 2.1
Name: fkscore
Version: 1.1.2
Summary: Flesch Kincaid readability scoring algorithm
Home-page: https://github.com/RandallShanePhD/fkscore
Author: Randall Shane, PhD <Randall.Shane@CodeIntelligence.IO>
Author-email: Randall.Shane@CodeIntelligence.IO
License: MIT
Description: fkscore
        ====
        
        Flesch Kincaid readability score for text
        
        A Python module implementation of the Flesch Kincaid readability score algorithm.
        
        The source code is released under the MIT License.
        
        ### Installation ###
            pip3 install fkscore
        
        ### Usage ###
        For text in python represented as a string.
        
        Takes text as string datatype.  Words can be on same or different lines.  Current version is English language only. Requires pyphen 0.9.5+.  Email for support.
        
            import fkscore
            text = '...blah blah blah...'
            f = fkscore.fkscore(text)
            print(f.stats)
            print(f.score)
        
        ### Output ###
        Output includes 2 dictionaries of information as follows:
        * stats:
          * stats['num_words']
          * stats['num_syllables']
          * stats['num_sentences']
        * score:
          * score['readability']  # Calculated F-K Readability Score
          * score['grade']        # Permuted F-K Grade Reading Level
        
        ### Releases ###
        Releases and additions will push to PyPi periodically, but if there is a feature in master not built/pushed and you want it to be, just ping me.
        
        ### History ###
        This is a maintained as an original implementation of the Flesch-Kincaid readability score algorithm which has been around since 1975.  The module is pure python and works with 3.5+.
        
        ### Questions ###
        Feel free to ping for questions, comments, concerns or hit the repository. <br />
        Randall Shane, PhD <br />
        Randall.Shane@CodeIntelligence.IO <br />
        https://github.com/RandallShanePhD/fkscore <br />
        Thank you!
        
Keywords: nlp,linguistics,nltk,text processing
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Text Processing :: Indexing
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
