Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 1.74 KB

README.md

File metadata and controls

54 lines (41 loc) · 1.74 KB
Raw

Bookbot

Python CLI tool to analyze the word count and letter usage in text files. Be it a simple note, a long essay, or a full fledged novel - analyze texts of all sorts and lengths!

Details

The program creates a report with the word count from each file as well as a list of letters in that file from the English alphabet and the amount of their occurrences in descending order. See below for a sample output.

Installing / Getting started

Requires python3.7+ Get Python from python.org

Fork and clone this repository to your local machine

Fork this repo, then clone it to your local machine:

git clone https://github.com/YOUR-USERNAME/bookbot

Place text files in the project's /texts directory

cd bookbot
mv PATH-TO-YOUR-TEXTFILE /texts

You can add as many files as you like - they will be analyzed in one go and be presented in alphabetical order. Please check the supported file types below.

Supported file types

Currently, the following file types are supported:

  • .txt
  • .docx
  • .odt
  • .rtf
  • .md
  • .mdx
  • .html
  • .pdf

Run the program

From inside the project's root directory, run:

python main.py

Enjoy!

Sample Terminal Output

Sample Terminal Output

How to Contribute

Contributions are always welcome! Please check the Code of Conduct .

License

The project is licensed under the MIT License.