Skip to content

Floppymnt/bookbot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📚 BookBot

A simple Python CLI tool to analyze a text file—counting words, and generating a report.


🧰 Features

  • Reads a specified text file (e.g., frankenstein.txt)
  • Computes:
    • Total word count
    • Frequency of each letter (case-insensitive, sorted descending)
  • Outputs a clean, formatted report to the console

🚀 Getting Started

Prerequisites

  • Python 3.7 or higher

Installation

  1. Clone the repository
git clone https://github.com/Floppymnt/bookbot.git
cd bookbot
  1. Add your book/text file
  • Create a books/ directory (or similar)
  • Place .txt files inside, (e.g., frankenstein.txt):

Usage

Run the script from the project root:

python3 main.py PATH/TO/frankenstein.txt

💡 TODO

  • Analyze multiple files in a folder
  • Filter only .txt files or add support for .md, .pdf, etc.
  • Add flags for tweaked analysis

🤝 Contributions

Pull requests, suggestions, and bug reports are welcome!
Follow the standard GitHub flow:

  1. Fork → 2. Create a branch → 3. Commit → 4. Submit a PR

🧾 License

Distributed under the MIT License. See LICENSE for details.


📄 Acknowledgments


📝 About

This is my first git project made while following the boot.dev curriculum!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages