Metadata-Version: 1.1
Name: wpm
Version: 1.9
Summary: Console app for measuring typing speed in words per minute (WPM)
Home-page: https://github.com/cslarsen/wpm
Author: Christian Stigen Larsen
Author-email: csl@csl.name
License: https://www.gnu.org/licenses/gpl-3.0.html
Download-URL: https://github.com/cslarsen/wpm/tarball/v1.9
Description: wpm — console app that measures your typing speed
        =================================================
        |versions| |license| |pypi|
        
        ``wpm`` is a simple terminal program that measures your typing speed in words
        per minute (WPM).
        
        .. image:: https://asciinema.org/a/xsSZrSD920trJh096FPFEhKMr.png
          :width: 720
          :target: https://asciinema.org/a/xsSZrSD920trJh096FPFEhKMr
        
        The WPM is calculated by dividing the final characters per second by five. This
        is a well-known formula, but gives slightly higher scores than on sites like
        typeracer.com.
        
        How to install
        ==============
        
        The recommended way is to install via PyPi
        
        .. code:: bash
        
            $ pip install wpm
        
        But you can also install from the source with
        
        .. code:: bash
        
            $ python setup.py install [--user]
        
        To just test the app without installing, type ``make run``.
        
        How to run
        ==========
        
        Just type ``wpm`` to start the program. The timer will start when you press the
        first key. At any time, you can hit ESCAPE to quit.
        
        You can backspace for the current word you're editing, if you make a mistake.
        Mistakes will lower the accuracy score.
        
        If you have problems finding the ``wpm`` file, you can also start it by typing
        ``python -m wpm``. You can also see options with ``python -m wpm --help``.
        
        If you want to type a custom text, run
        
        .. code:: bash
        
            $ wpm --load yourfile.txt
        
        You can also bundle up several texts into a single JSON file, using ``wpm
        --load-json yourfile.json``. It must have the following format:
        
        .. code:: json
        
            [
              {
                "author": "Author Name",
                "title": "Title of Work",
                "text": "The text to type here ..."
              },
              ...
            ]
        
        License
        =======
        
        Copyright 2017 Christian Stigen Larsen
        
        Distributed under the GNU GPL v3 or later. See the file LICENSE.txt for the
        full license text. This software makes use of open source software.
        
        .. |license| image:: https://img.shields.io/badge/license-GPL%20v3%2B-blue.svg
            :target: http://www.gnu.org/licenses/old-licenses/gpl-3.en.html
            :alt: Project License
        
        .. |versions| image:: https://img.shields.io/badge/python-2.7%2B%2C%203%2B-blue.svg
            :target: https://pypi.python.org/pypi/wpm/
            :alt: Supported Python versions
        
        .. |pypi| image:: https://badge.fury.io/py/wpm.svg
            :target: https://badge.fury.io/py/wpm
        
Keywords: wpm,typing,typist
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: PyPy
