About The Project

This project is a word counter application tailored for assignment documents. It takes a file path as input and outputs the total word count with user configurability to include or exclude specific items. An essential tool for managing your writing assignments efficiently.

Setup

It is preferable that a virtualenv is created.

Virtualenv

https://docs.python.org/3/library/venv.html

To create a venv run:

$ python -m venv venv

For Windows (using Powershell) run:

$ venv\Scripts\Activate.ps1

For Mac/Linux run:

$ source venv/bin/activate

Requirements

$ pip install -r requirements.txt

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request.

1. Fork the Project
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes using conventional commits (`git commit -m 'feat: Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a pull request

Contributors

charlie2clarke

FreddyC08