Metadata-Version: 1.1
Name: pyfastcopy
Version: 1.0.1
Summary: Speed up shutil.copyfile by using sendfile system call
Home-page: https://github.com/desbma/pyfastcopy
Author: desbma
Author-email: UNKNOWN
License: UNKNOWN
Download-URL: https://github.com/desbma/pyfastcopy/archive/1.0.1.tar.gz
Description: pyfastcopy
        ==========
        
        |Latest Version| |Tests Status| |Coverage| |Supported Python versions|
        |License|
        
        pyfastcopy is a simple Python module that monkey patches the
        ``shutil.copyfile`` function of Python standard library to internally
        use the sendfile system call.
        
        It can provide massive performance improvements for large file copy (the
        larger the file, the greater the performance gain). See
        `here <https://bugs.python.org/issue25156#msg253643>`__ for some
        numbers.
        
        Because ``shutil.copyfile`` is used by other fonctions in the ``shutil``
        module, the following functions also automatically benefit from the
        performance boost:
        
        -  ``shutil.copy``
        -  ``shutil.copy2``
        -  ``shutil.copytree``
        
        If sendfile is not available on your system or fails, the classic,
        slower chunk file copy is used, so there is no downside to using this
        module.
        
        For more information, see `my proposed
        patch <https://bugs.python.org/issue25156>`__ for Python.
        
        Usage
        -----
        
        Just import the module:
        
        ::
        
            import pyfastcopy
        
        And then use the patched shutil.copyfile as usual:
        
        ::
        
            shutil.copyfile(src, dst)
        
        **The ``sendfile`` system call does not exist on Windows, so importing
        this module will have no effect.**
        
        Installation
        ------------
        
        From PyPI (with PIP)
        ~~~~~~~~~~~~~~~~~~~~
        
        1. If you don't already have it, `install
           pip <http://www.pip-installer.org/en/latest/installing.html>`__ for
           Python 3 (not needed if you are using Python >= 3.4)
        2. Install pyfastcopy: ``pip3 install pyfastcopy``
        3. Enjoy fast fast copy when using ``shutil.copyfile``, ``shutil.copy``,
           ``shutil.copy2`` or ``shutil.copytree``
        
        From source
        ~~~~~~~~~~~
        
        1. If you don't already have it, `install
           setuptools <https://pypi.python.org/pypi/setuptools#installation-instructions>`__
           for Python 3
        2. Clone this repository:
           ``git clone https://github.com/desbma/pyfastcopy``
        3. Install pyfastcopy: ``python3 setup.py install``
        4. Enjoy fast fast copy when using ``shutil.copyfile``, ``shutil.copy``,
           ``shutil.copy2`` or ``shutil.copytree``
        
        License
        -------
        
        Python Software Foundation License
        
        .. |Latest Version| image:: https://img.shields.io/pypi/v/pyfastcopy.svg?style=flat
           :target: https://pypi.python.org/pypi/pyfastcopy/
        .. |Tests Status| image:: https://img.shields.io/travis/desbma/pyfastcopy/master.svg?label=tests&style=flat
           :target: https://travis-ci.org/desbma/pyfastcopy
        .. |Coverage| image:: https://img.shields.io/coveralls/desbma/pyfastcopy/master.svg?style=flat
           :target: https://coveralls.io/r/desbma/pyfastcopy?branch=master
        .. |Supported Python versions| image:: https://img.shields.io/pypi/pyversions/pyfastcopy.svg?style=flat
           :target: https://pypi.python.org/pypi/pyfastcopy/
        .. |License| image:: https://img.shields.io/github/license/desbma/pyfastcopy.svg?style=flat
           :target: https://pypi.python.org/pypi/pyfastcopy/
        
Keywords: shutil,copy,copyfile,file,performance,speed,sendfile
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Python Software Foundation License
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries :: Python Modules
