https://github.com/jacastanon01/bookbot

https://github.com/jacastanon01/bookbot

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/jacastanon01/bookbot
• Owner: jacastanon01
• Created: 2024-02-18T00:26:46.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-02-18T20:28:21.000Z (10 months ago)
• Last Synced: 2024-02-19T07:30:07.691Z (10 months ago)
• Language: Python
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Bookbot

Bookbot is a simple Python-based command-line tool that reads text from a .txt file, analyzes the text, and generates a report. It provides a breakdown of word count and frequency of each letter.

## GOALS

My goal for this project was to write my first python script using an object-oriented approach to organizing the code. In this directory, I have two main files. One in the subfolder labeled `FP/` and the other in `OOP/`. It isn't really necessary for a project this small, but as my understanding grows, I hope this approach will guide me in future software considerations.

### PREREQUISITES

Python (version 3.12 or later)

### INSTALLATION

Clone this repository using the following command:

```sh

git clone https://github.com/jacastanon01/bookbot.git

```

### USAGE

This tool requires a path to a .txt file you wish to analyze. Use the following format to execute the script. There are two main scripts that are functionally the same. Specify which script you'd like to run and the subdirectory. For example, to run the OOP file:

```sh

python3 OOP/main.py 

```

If no exceptions are raised, the output should provide a detailed report: