Metadata-Version: 2.1
Name: prosegrinder
Version: 0.2.0
Summary: A text analytics library for prose fiction.
Home-page: https://github.com/prosegrinder/python-prosegrinder
Author: David L. Day
Author-email: dday376@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Requires-Dist: cmudict (>=0.4.0)
Requires-Dist: narrative (>=0.1.2)
Requires-Dist: pointofview (>=0.3.0)
Requires-Dist: syllables (>=0.1.0)

Prosegrinder
===============

.. image:: https://img.shields.io/pypi/v/prosegrinder.svg
    :target: https://pypi.python.org/pypi/prosegrinder
    :alt: Latest PyPI version

.. image:: https://github.com/prosegrinder/python-prosegrinder/workflows/Python%20CI/badge.svg?branch=master
    :target: https://github.com/prosegrinder/python-prosegrinder/actions?query=workflow%3A%22Python+CI%22+branch%3Amaster
    :alt: GitHub Workflow Status

.. image:: https://app.codacy.com/project/badge/Grade/fbb22c1d33a34aa3bee095fc3ff62bc9
    :target: https://www.codacy.com/gh/prosegrinder/python-prosegrinder?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=prosegrinder/python-prosegrinder&amp;utm_campaign=Badge_Grade
    :alt: Latest Codacy Coverage Report

A relatively fast, functional prose text counter with readability scoring.

Installation
------------

``prosegrinder`` is available on PyPI. Simply install it with ``pip``::

    $ pip install prosegrinder

Usage
-----

The main use is via the prosegrinder.Prose object.

    >>> from prosegrinder import Prose
    >>> p = Prose("Some lengthy text that's actual prose, like a novel or article.")

The Prose object will parse everything down and compute basic staticstics, including word count,
sentence count, paragraph count, syllable count, point of view, dialogue, narrative, and a set
of readabilit scores. All objects and attributes should be treated as immutable.

I know this isn't great documentation, but it should be enough to get you going.

Readbility scores
~~~~~~~~~~~~~~~~~

The set of scores automatically calculated:

* Automated Readability Index
* Coleman Liau Index
* Flesch Kincaid Grade Level
* Flesch Reading Ease
* Gunning Fog Index
* Linsear Write
* LIX
* RIX
* SMOG


