Metadata-Version: 2.1
Name: scienco
Version: 0.2.0
Summary: Calculate the readability of text using one of a variety of computed indexes
Home-page: https://gitlab.com/amalchuk/scienco
Author: Andrew Malchuk
Author-email: andrew.malchuk@yandex.ru
License: MIT
Project-URL: Documentation, https://scienco.readable.pw
Project-URL: Source, https://gitlab.com/amalchuk/scienco
Description: Scienco
        =======
        [![pipeline status][pipeline]][homepage]
        [![coverage report][coverage]][homepage]
        [![distribution][license]](LICENSE)
        
        Calculate the readability of text using one of a variety of computed indexes including:
        
        - Flesch-Kincaid score
        - Automated readability index
        - Coleman-Liau index
        
        Requirements
        ------------
        Python 3.6+
        
        Installation
        ------------
        ```
        $ pip install scienco
        ```
        
        Usage
        -----
        ```pycon
        >>> import scienco
        >>> metrics = scienco.compute_metrics("Lorem ipsum dolor sit amet ...")
        >>> metrics
        Metrics(sentences=32, words=250, letters=1329, syllables=489, is_russian=False)
        >>> indexes = scienco.compute_indexes(sentences=32, words=250, letters=1329, syllables=489, is_russian=False)
        >>> indexes
        Indexes(flesch_reading_ease_score=33.43, automated_readability_index=7.51, coleman_liau_index=11.67)
        ```
        
        Distribution
        ------------
        This project is licensed under the terms of the [MIT License](LICENSE).
        
        Links
        -----
        - Documentation: <https://scienco.readable.pw>
        - Code: <https://gitlab.com/amalchuk/scienco>
        - GitHub mirror: <https://github.com/amalchuk/scienco>
        
        [homepage]: <https://gitlab.com/amalchuk/scienco>
        [pipeline]: <https://gitlab.com/amalchuk/scienco/badges/master/pipeline.svg?style=flat-square>
        [coverage]: <https://gitlab.com/amalchuk/scienco/badges/master/coverage.svg?style=flat-square>
        [license]: <https://img.shields.io/github/license/amalchuk/scienco?color=blue&style=flat-square>
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Natural Language :: Russian
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Text Processing :: Indexing
Classifier: Typing :: Typed
Requires-Python: >=3.6, <4.0
Description-Content-Type: text/markdown
