Metadata-Version: 1.0
Name: xmodem
Version: 0.4.2
Summary: XMODEM protocol implementation.
Home-page: https://github.com/tehmaze/xmodem
Author: Wijnand Modderman, Jeff Quast
Author-email: maze@pyth0n.org
License: MIT
Description: .. image:: https://travis-ci.org/tehmaze/xmodem.png?branch=master
           :target: https://travis-ci.org/tehmaze/xmodem
        
        .. image:: https://coveralls.io/repos/tehmaze/xmodem/badge.png
           :target: https://coveralls.io/r/tehmaze/xmodem
        
        ================================
         XMODEM protocol implementation
        ================================
        
        Documentation available at http://packages.python.org/xmodem/
        
        Python Package Index (PyPI) page is available at https://pypi.python.org/pypi/xmodem
        
        Usage
        =====
        
        Create a function to get and put character data (to a serial line for
        example)::
        
            >>> from xmodem import XMODEM
            >>> def getc(size, timeout=1):
            ...     return data or None
            ...
            >>> def putc(data, timeout=1):
            ...     return size or None
            ...
            >>> modem = XMODEM(getc, putc)
        
        Now, to upload a file, use the ``send`` method::
        
            >>> stream = open('/etc/fstab', 'rb')
            >>> modem.send(stream)
        
        To download a file, use the ``recv`` method::
        
            >>> stream = open('output', 'wb')
            >>> modem.recv(stream)
        
        For more information, take a look at the documentation_.
        
        .. _documentation: http://packages.python.org/xmodem/xmodem.html
        
        Changes
        =======
        
        0.4.2:
          * bugfix: documentation files missing from the release tarball
            `Issue #16 <https://github.com/tehmaze/xmodem/issues/16>`_.
        
        0.4.1
          * bugfix: re-transmit in send() on NAK or timeout, previously
            re-transmissions (wrongly) occurred only on garbage bytes.
            `PR #12 <https://github.com/tehmaze/xmodem/pull/12>`_.
        
        0.4.0
          * enhancement: support for python 3
            `PR #8 <https://github.com/tehmaze/xmodem/pull/8>`_.
          * bugfix: CRC failures in XMODEM.recv() were not renegotiated correctly
            `PR #11 <https://github.com/tehmaze/xmodem/issues/11>`_.
        
Keywords: xmodem protocol
Platform: UNKNOWN
