Giter VIP home page Giter VIP logo

bookbot's Introduction

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.

bookbot's People

Contributors

imgbotapp avatar sunkio avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Forkers

aug09

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.