Metadata-Version: 2.4
Name: typetest-cli
Version: 1.2.5
Summary: Lightweight typing speed commandline tool
Author: Kyler
Project-URL: repository, https://github.com/senyc/typetest-cli
Keywords: speed,test,typing,typetest,typetest-cli,terminal
Classifier: Operating System :: POSIX :: Linux
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: rich
Dynamic: license-file

================
typetest-cli
================
|build| |downloads|

.. |build| image:: https://github.com/senyc/typetest-cli/actions/workflows/tests.yml/badge.svg
.. |downloads| image:: https://static.pepy.tech/badge/typetest-cli

Python versions
===============

``typetest-cli`` works with all versions of python >= 3.8


Installation
============

pip install
-----------

.. code-block:: python

    pip install typetest-cli

GitHub
-------


.. code-block:: bash

    git clone https://github.com/senyc/typetest-cli
    cd typetest-cli
    python setup.py install

Running ``typetest-cli``
========================

After install you should be able to run the program with ``typetest`` or ``typetest-cli``

Usage
--------

.. code-block::

    usage: typetest [-h] [--hide-acc] [--hide-wpm] [--only-base] [--no-blocking]

    Lightweight typing speed commandline tool. Can be exited with Ctrl-c or return.

    options:
      -h, --help         show this help message and exit
      --hide-acc, -a     hides the accuracy statistic
      --hide-wpm, -w     hides the word per minute statistic
      --only-base, -b    Only uses the base text
      --no-blocking, -n  Do not block input after 3 failed attempts

    Will only display typing speed and accuracy upon completion of the line

