Metadata-Version: 1.1
Name: word2keypress
Version: 1.0.16
Summary: Convert word to keypress sequence
Home-page: https://github.com/rchatterjee/word2keypress.git
Author: Rahul Chatterjee
Author-email: rahul@cs.cornell.edu
License: UNKNOWN
Description: Convert word to keypress-sequence
        =================================
        
        |Build Status|
        
        I made this as a submodule for my project on correcting password typos. I found this very cool, and
        might be useful in many scenarios where one has to find vairations of word due to mistyping.
        
        Here we define typo as purely mistyping a key, and not due to ignorance. Hence, finding possible
        typos of a word require converting the word into sequence of key presses. This module provides those
        functionality to convert word into and from sequence of key presses. Also, given a word find the
        possible typo of that word tuned to the typos due to mistyping.
        
        Dependency
        ----------
        
        Right now it needs cython. I will remove it in future. \* Cython.
        
        Install
        -------
        
        .. code:: bash
        
            $ pip install word2keypress
        
            # or
        
            $ python setup.py install
        
        How to Use?
        -----------
        
        Refer to the ``HowToRun.ipynb`` file.
        
        .. code:: python
        
            from word2keypress import distance, Keyboard
            kb = Keyboard(u'US') # making unicode is mandatory (weird Cython)
            kseq = kb.word_to_keyseq('Password')
            print "\nRaw sequence:", repr(kseq)
        
            print "\nReadable sequence:", repr(kb.print_keyseq(kseq))
        
            print "\nkeyseq->word:", kb.keyseq_to_word(kseq)
        
            print "\ndistance:", distance('Password1', 'PASSWORD1')
        
        How to test/develop ?
        ~~~~~~~~~~~~~~~~~~~~~
        
        (For myself, as I keep forgetting how to deal with cython. Stupid Idea) Don't forget to regenerate
        the ``src/word2keypress/_keyboard.c`` file in Option 1.
        
        ::
        
            $ python setup.py pytest      # Option 1
            $ tox                         # Option 2
            $ python -m pytest tests/     # Option 3
        
        In any case have to regenerate the ``_keyboard.c`` to test with the new code.
        
        .. |Build Status| image:: https://travis-ci.org/rchatterjee/word2keypress.svg?branch=master
           :target: https://travis-ci.org/rchatterjee/word2keypress
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
