Analyze how difficult a Spanish word will be to spell
- GitHub repo: https://github.com/mario-bermonti/wdiff.git
- Documentation: https://wdiff.readthedocs.io/
- Free software: GNU General Public License v3
wdiff helps analyze how difficult it is to spell Spanish words. The objetive with wdiff is to improve research on spelling skill and may also be useful for games that require user's to spell Spanish words.
wdiff was design to be easy to use and as flexible as possible to facilitate conducting research on spelling skills.
wdiff determines the difficulty of words based on the following dimensions:
- Word length - how many letters it has
- Number of silent letters - letters that don't have a phonemic representation (e.g., h)
- Number of graphemes that share their phoneme with other graphemes (e.g., s and z)
python -m pip install wdiff
The most basic usage requires you to pass an iterable of words (e.g., list), run all possible analyses, and save the results to a file named results.csv.
from wdiff.analyzer import Analyzer
words = ['guitarra', 'jinete', 'serpiente']
analyzer = Analyzer(words) # create analyzer
analyzer.run_all_analyses()
print(analyzer.results) # see results
analyzer.save_results()You can further customize which analyses to run, extract the results as a pandas.DataFrame, and choose the name of the results file.
Check the documentation for more details. Better documentation is coming very soon!
All contributions are welcome!
Will find a detailed description of all the ways you can contribute to wdiff in the contributing guide.
This is a beginner-friendly project so don't hesitate to ask any questions or get in touch with the project's maintainers.
Please review the project's code of conduct before making any contributions.
This project was developed by Mario E. Bermonti Pérez as part of his academic research. Feel free to contact me at mbermonti@psm.edu or mbermonti1132@gmail.com.
This package was created with Cookiecutter and the mario-bermonti/cookiecutter-modern-pypackage project template.