Readability

This is a Python program that calculates the approximate grade level required to understand a piece of text. It is based on the Coleman-Liau index, a formula for computing the U.S. grade level for a given block of text. The formula is:

index = 0.0588 * L - 0.296 * S - 15.8

where L is the average number of letters per 100 words in the text, and S is the average number of sentences per 100 words in the text.

Getting started

Prerequisites

You will need Python 3.6 or later to run this program. You can check your version of Python by running python3 --version in your terminal. If you do not have Python 3.6 or later, you can download/update it in Self Service. If you are confused about how to do this, please ask me for help.

This is a template repository, and you can generate your own version of this repository by clicking on the green Use this template button on the home page. It is recommended that you name the new repository the same name as the template. Once you have created your new repository, you can then clone it to your computer via the command line:

git clone https://github.com/<your-github-username>/readability.git

Then, you should see a folder called readability in your current directory. Change into that directory by running:

cd readability

Now, run ls to see the contents of the folder. You should see a file called readability.py. This is the Python program that you will be building on. There is also a file called helpers.py which contains some helper functions that you can use in your program. You can read more about them in the comments in the file. Finally, task.md outlines what you will be doing for this project.

References

This problem is a modified version of Problem Set 6 from CS50. The original problem description can be found here.