Merge branch 'master' of https://github.com/cdimascio/py-readability-metrics

Author: Carmine DiMascio

CONTRIBUTING.md

@@ -39,6 +39,15 @@ _The following use [ARI](https://github.com/cdimascio/py-readability-metrics/blo
 
 ### Docs
 
+Prequisites:
+1. Install Sphinx
+
+```shell
+pip install -U sphinx m2r
+```
+
+Modify Documentation
+
 1. Fork the repo
 2. Navigate to `docs`
 3. Make a change
@@ -53,6 +62,14 @@ _The following use [ARI](https://github.com/cdimascio/py-readability-metrics/blo
 
 Contributors should ignore the steps below.
 
+Prerequisites:
+
+```shell
+pip install twine
+```
+
+publish 
+
 ```shell
 rm -rf build dist py_readability_metrics.egg-info && python setup.py sdist bdist_wheel
 twine upload dist/*

docs/source/index.md

@@ -36,6 +36,7 @@ Here is some text explaining some complicated stuff
     r.ari()
     r.linsear_write()
     r.smog()
+    r.spache()
 
 ## Readability Metrics
 
@@ -50,6 +51,7 @@ Here is some text explaining some complicated stuff
     coleman_liau
     gunning_fog
     smog
+    spache
     linsear_write
 
 # Indices and tables

docs/source/spache.rst

@@ -0,0 +1,27 @@
+SPACHE
+===========
+
+
+About
+^^^^^
+
+G. Spache devised the Spache Readability Formula in 1953 through an article, A New Readability Formula for Primary-Grade Reading Materials, published in The Elementary School Journal. The formula calculates the grade level of a text sample based on sentence length and number of unfamiliar words. The Spache Formula considers “unfamiliar words” as words that 3rd grade and below do not recognize. The Spache Formula is best used to calculate the difficulty of text that falls at the 3rd grade level or below. [reference]_
+
+Usage
+^^^^^
+
+.. code-block:: python
+
+    r = Readability(text)
+
+    s = r.spache()
+
+    print(s.score)
+    print(s.grade_level)
+
+
+References
+----------
+
+.. [reference] `readabilityformulas.com <https://www.readabilityformulas.com/spache-readability-formula.php>`_
+    

setup.py

@@ -7,7 +7,7 @@
 
 setup(
     name='py-readability-metrics',
-    version='1.3.5',
+    version='1.4.1',
     author='Carmine DiMAscio',
     author_email='cdimascio@gmail.com',
     description='Score text "Readability" with popular metrics such as Flesch-Kincaid, Gunning Fog, ARI, Dale Chall, SMOG, and more',