Metadata-Version: 2.1
Name: dyslexic-readability
Version: 0.0.3
Summary: A readability scoring library tailored to the specific needs of Turkish dyslexic readers.
Home-page: https://github.com/AkinGunduz/dyslexic_readability_index
Author: Akin Gunduz
Author-email: akngndz93@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/AkinGunduz/dyslexic_readability_index/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Dyslexic Readability Package

A readability scoring library tailored to the specific needs of Turkish dyslexic readers.

## Basic Usage

The package is available on PyPI. Simply install it with pip:

```bash
  pip install dyslexic-readability
```

You can also install it from source:

```bash
  git@github.com:AkinGunduz/dyslexic_readability_index.git
  Cloning into 'dyslexic_readability_index'...
  ...

  $ cd dyslexic_readability_index
  $ python setup.py install
  ...
```

## Dependencies

This project uses the following python libraries. Please use Python3+.

`nltk`
`numpy`
`editdistance`
`python-syllable`

## Kullanım/Örnekler

```python
import dyslexic_scores
import readability_scores

story = (
    "Ormanların birinde bir sivrisinek yaşarmış."
    " Bu sivrisinek tüm hayvanları rahatsız edercesine kral olduğunu iddia ediyormuş."
    " Her önüne gelen hayvana kafa tutuyormuş. Yine hayvanlara laf ederken sıra kurbağaya gelmiş."
    " Kurbağa ona hayvanların kralının aslan olduğunu söylemiş. Buna sinirlenen sinek aslanın yanına gitmiş."
    " Aslan bir ağacın dibinde uyukluyormuş. Gidip başında vızıldayarak kral olduğunu iddia etmiş."
    " Aslanı sinir edince aslan sineğe pençe sallamış. Ama ıskalayınca sinek daha da uğraşmaya başlamış."
    " Aslan bir daha sinir olunca yine pençe sallamış ama tutturamamış."
    " Sinek iyice şımarmaya başlamış, kulağının dibine vızıldayarak daha da sinir bozmaya çalışıyormuş."
    " Aslında hedefine ulaşması için son bir şey yapması lazımmış. Aslana zarar vererek üstünlüğünü kanıtlayacağını düşünüyormuş."
    " Bunun da ardından sinek gidip aslanın burnunu iğnesi ile sokmuş. Aslan ise öfkelenerek kükremiş."
    " Sinek oradan uzaklaşarak aslanı yendiği için mutlu davranıyormuş. Örümcek ağına yakalanana kadar sürecekmiş bu mutluluğu."
    " Örümcek ağına yakalanınca kurtulamamış. Yardım çığlıkları atınca aslan gelip onu kurtarmış."
    " Bu da sineğe ders olmuş ve bir daha hiç kral olduğunu iddia etmemiş."
)

obj = dyslexic_scores.DyslexicScores(story)
obj_r = readability_scores.Readability(story)

print(
    "Dyslexic Score:  ",
    obj.overall_dyslexic_score(),
    "Atesman Score: ",
    obj_r.Atesman(),
    "Overall Score:  ",
    obj.overall_calculated_score(),
)
```

