A poetry checking tool that analyzes poems and tells you information about them. Can tell you different types of poetry based on dictionary and rhyming.
Always enjoyed poetry, read about dictionaries and rhyming, implemented this.
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of
python
To install poetry-checker, follow these steps:
git clone https://github.com/2kabhishek/poetry-checker
cd poetry-checkerTo run poetry-checker, follow these steps: python src/poetry_program.py
By default it looks at the sample_poems directory, add your poem to the directory and run the program. Enter the file name when prompted.
Every module has it's own doctest, which can be run by running python -m doctest -v <module>.
Unit tests can be ran using python -m unittest.
Custom linter is present in the util directory.
poetry-checker was built using python
Setting up tests was tricky, due to module path issues.
- Learned about
doctestand found it very useful for documentation. - Pronunciation and they are used in rhyming.
- Different types of poetry.
Add CLI flags to pass in poems.txt file.
Hit the ⭐ button if you found this useful.