Developer Notes

Local Development

git clone https://github.com/kyleking/tui-typer-tutor.git
cd tui-typer-tutor
poetry install --sync

# See the available tasks
poetry run calcipy
# Or use a local 'run' file (so that 'calcipy' can be extended)
./run

# Run the default task list (lint, auto-format, test coverage, etc.)
./run main

# Make code changes and run specific tasks as needed:
./run lint.fix test

Publishing

For testing, create an account on TestPyPi. Replace ... with the API token generated on TestPyPi or PyPi respectively

poetry config repositories.testpypi https://test.pypi.org/legacy/
poetry config pypi-token.testpypi ...

./run main pack.publish --to-test-pypi
# If you didn't configure a token, you will need to provide your username and password to publish

To publish to the real PyPi

poetry config pypi-token.pypi ...
./run release

# Or for a pre-release
./run release --suffix=rc

Current Status

File	Statements	Missing	Excluded	Coverage
tui_typer_tutor/__init__.py	21	0	17	100.0%
tui_typer_tutor/app/__init__.py	0	0	0	100.0%
tui_typer_tutor/app/ttt.py	12	12	0	0.0%
tui_typer_tutor/constants/__init__.py	1	0	0	100.0%
tui_typer_tutor/constants/display_to_textual.py	5	0	0	100.0%
tui_typer_tutor/core/__init__.py	0	0	0	100.0%
tui_typer_tutor/core/config.py	13	13	0	0.0%
tui_typer_tutor/core/metrics.py	39	0	0	96.6%
tui_typer_tutor/core/scrolled_labels.py	0	0	0	100.0%
tui_typer_tutor/core/seed_data.py	9	0	0	93.3%
tui_typer_tutor/core/typing.py	43	1	0	96.5%
tui_typer_tutor/core/uninstall.py	18	0	0	92.3%
tui_typer_tutor/screens/__init__.py	0	0	0	100.0%
tui_typer_tutor/screens/help.py	14	14	0	0.0%
tui_typer_tutor/screens/main.py	74	74	0	0.0%
tui_typer_tutor/scripts.py	21	21	0	0.0%
Totals	270	135	17	50.0%

Generated on: 2023-12-10