Skip to content

Man2Dev/writing-checker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

writing-checker

Code style: black Imports: isort License: MIT

A Simple Tool to Improve Your Writing Skills

Overview

Writing Checker is a simple tool designed to help you improve your writing skills by providing real-time feedback on grammar, spelling, and style. This project uses the language-tool-python library to perform language checks and offers a user-friendly interface to interact with the system.

Features

  • Real-time grammar, spelling, and style checking
  • Suggestions for improving your writing
  • Word and paragraph counters
  • Timer for tracking your progress
  • Linking words comma checker
  • Select sentences for further review

Technologies Used

  • Python
  • SQLite
  • Tkinter (for GUI)

Getting Started

To get started with Writing Checker, follow these steps:

Install the required packages: You will need to install language-tool-python and any other required dependencies. You can install them using pip:

git clone https://github.com/Man2Dev/writing-checker.git
cd writing-checker
pip install -r requirements.txt
python main.py

Use the application: Once the application is running, you can start using it to check your writing. Simply paste or type your text into the input area, and the application will provide real-time feedback on grammar, spelling, and style.

  • Note: you will need language-tools running locally on machine or, on container.

Contributing

We welcome contributions to the Writing Checker project. If you'd like to contribute, please follow these steps:

Fork the repository Create a new branch for your changes Make your changes and commit them Push your changes to your forked repository Open a pull request


License

Writing Checker is released under the MIT License. See the LICENSE file for more information.

Acknowledgements

Writing Checker uses the language-tool-python library for language checking. We would like to thank the maintainers of this library for their hard work and dedication.

Contact

If you have any questions or concerns, please contact us at mohammad.r.hendiani@gmail.com

Happy Writing! We hope you find Writing Checker helpful in improving your writing skills. Happy writing!