Metadata-Version: 2.1
Name: mspelling
Version: 0.2.2
Summary: Measure of Spanish spelling skills
Home-page: https://github.com/mario-bermonti/mspelling
Keywords: mspelling
Author: Mario E. Bermonti Pérez
Author-email: mbermonti1132@gmail.com
Requires-Python: >=3.7.1,<3.11
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Kivy (>=2.0.0,<3.0.0)
Requires-Dist: click (>=8.0.3,<9.0.0)
Requires-Dist: kivymd (>=0.104.2,<0.105.0)
Requires-Dist: numpy (>=1.21.5,<2.0.0)
Requires-Dist: pandas (>=1.3.5,<2.0.0)
Requires-Dist: xlrd (>=2.0.1,<3.0.0)
Project-URL: Bug Tracker, https://github.com/mario-bermonti/mspelling/issues
Project-URL: Documentation, https://mspelling.readthedocs.io
Project-URL: Repository, https://github.com/mario-bermonti/mspelling
Description-Content-Type: text/markdown

# mSpelling

[![PyPI - Version](https://img.shields.io/pypi/v/mspelling.svg)](https://pypi.python.org/pypi/mspelling)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mspelling.svg)](https://pypi.python.org/pypi/mspelling)
![GitHub](https://img.shields.io/github/license/mario-bermonti/mspelling)
[![Tests](https://github.com/mario-bermonti/mspelling/workflows/tests/badge.svg)](https://github.com/mario-bermonti/mspelling/actions?workflow=tests)
[![Codecov](https://codecov.io/gh/mario-bermonti/mspelling/branch/master/graph/badge.svg?token=YOURTOKEN)](https://codecov.io/gh/mario-bermonti/mspelling)
[![Read the Docs](https://readthedocs.org/projects/mspelling/badge/)](https://mspelling.readthedocs.io/)
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

Measure of Spanish spelling skills

* GitHub repo: <https://github.com/mario-bermonti/mspelling.git>
* Documentation: <https://mspelling.readthedocs.io/>
* Free software: GNU General Public License v3

## Features
- Developed specifically for research on spelling skills
- Easy to administer
- Flexible and easy to extend
- Supports multiple platforms: MacOS, Windows, Linux
- Results are saved to a CSV file

## Description

![demo](./mspelling_gif.gif)

Words are presented by the computer one at a time and the participant types the word
using the keyboard. Participants have a rest period after every 5 trials.

At the end of the session, mspelling saves the results to a CSV file, which is supported
by most popular spreadsheet software these days (e.g., Excel).

mSpelling is developed using the Python programming language v3.

## Getting Started
Please see [mSpelling documentation][project_docs] for details about how to install and use mSpelling.

## Contributing to this project
  All contributions are welcome!

  Will find a detailed description of all the ways you can contribute to mspelling in
  [the contributing guide][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][code_conduct] before making
  any contributions.

## Author
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](mailto:mbermonti@psm.edu) or
[mbermonti1132@gmail.com](mailto:mbermonti1132@gmail.com)

## Credits

This package was created with [Cookiecutter][cookiecutter] and the [mario-bermonti/cookiecutter-modern-pypackage][cookiecutter-modern-pypackage] project template.

[cookiecutter]: https://github.com/cookiecutter/cookiecutter
[cookiecutter-modern-pypackage]: https://github.com/mario-bermonti/cookiecutter-modern-pypackage
[project_docs]: https://mspelling.readthedocs.io/
[code_conduct]: ./CODE_OF_CONDUCT.md
[contributing_guide]: ./contributing.md

