Metadata-Version: 2.1
Name: tui-typer-tutor
Version: 1.0.1
Summary: Fork of kraanzu/termtyper with a focus on special characters. Inspired by climech/typing-practice.
Home-page: https://github.com/kyleking/tui-typer-tutor
License: MIT
Author: Kyle King
Author-email: dev.act.kyle@gmail.com
Requires-Python: >=3.11.2,<4.0.0
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: bidict (>=0.22.1)
Requires-Dist: corallium (>=0.2.2)
Requires-Dist: platformdirs (>=3.8.0)
Requires-Dist: pydantic (>=1.10.9)
Requires-Dist: textual (>=0.28.0)
Project-URL: Bug Tracker, https://github.com/kyleking/tui-typer-tutor/issues
Project-URL: Changelog, https://github.com/kyleking/tui-typer-tutor/blob/main/docs/docs/CHANGELOG.md
Project-URL: Documentation, https://tui-typer-tutor.kyleking.me
Project-URL: Repository, https://github.com/kyleking/tui-typer-tutor
Description-Content-Type: text/markdown

# tui-typer-tutor

Fork of `kraanzu/termtyper` with a focus on special characters. Inspired by `climech/typing-practice` and `justinsgithub/terminal-typing-tutor`.

## Installation and Usage

1. `pipx install tui-typer-tutor`
1. Launch a typing session with the default text: `ttt`
1. Specify custom files with: `ttt --seed-file='./any-file.txt'`
1. To uninstall run: `ttt --uninstall && pipx uninstall tui-typer-tutor`

## Project Status

See the `Open Issues` and/or the [CODE_TAG_SUMMARY]. For release history, see the [CHANGELOG].

## Contributing

We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:

- [DEVELOPER_GUIDE]
- [STYLE_GUIDE]

## Code of Conduct

We follow the [Contributor Covenant Code of Conduct][contributor-covenant].

### Open Source Status

We try to reasonably meet most aspects of the "OpenSSF scorecard" from [Open Source Insights](https://deps.dev/pypi/tui-typer-tutor)

## Responsible Disclosure

If you have any security issue to report, please contact the project maintainers privately. You can reach us at [dev.act.kyle@gmail.com](mailto:dev.act.kyle@gmail.com).

## License

[LICENSE]

[changelog]: https://tui-typer-tutor.kyleking.me/docs/CHANGELOG
[code_tag_summary]: https://tui-typer-tutor.kyleking.me/docs/CODE_TAG_SUMMARY
[contributor-covenant]: https://www.contributor-covenant.org
[developer_guide]: https://tui-typer-tutor.kyleking.me/docs/DEVELOPER_GUIDE
[license]: https://github.com/kyleking/tui-typer-tutor/blob/main/LICENSE
[style_guide]: https://tui-typer-tutor.kyleking.me/docs/STYLE_GUIDE

