Metadata-Version: 2.0
Name: mocksftp
Version: 1.0
Summary: Mock SFTP server for testing purposes
Home-page: https://github.com/LabD/python-mocksftp
Author: Michael van Tellingen
Author-email: michaelvantellingen@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: paramiko
Provides-Extra: test
Requires-Dist: flake8 (==3.2.1); extra == 'test'
Requires-Dist: flake8-blind-except (==0.1.1); extra == 'test'
Requires-Dist: flake8-debugger (==1.4.0); extra == 'test'
Requires-Dist: isort (==4.2.5); extra == 'test'
Requires-Dist: pretend (==1.0.8); extra == 'test'
Requires-Dist: pytest (==3.0.6); extra == 'test'
Requires-Dist: pytest-cov (==2.4.0); extra == 'test'



mocksftp - Easily test your sftp client code 
============================================

In-process SFTP server for testing your SFTP related client code.


Usage example
=============

For pytest, use the ``sftp_server`` and ``sftp_client`` fixtures:

.. code-block:: python

    from contextlib import closing
    import py.path


    def test_open_file(sftp_server, sftp_client):
        # Write directly in the server root.
        root_path = py.path.local(sftp_server.root)
        root_path.join('file.txt').write('content')

        # Access the folder via the client
        sftp = sftp_client.open_sftp()
        assert sftp.listdir('.') == ['file.txt']

        with closing(sftp.open('file.txt', 'r')) as data:
            assert data.read() == b'content'


History
=======

This project was started as a fork of https://github.com/carletes/mock-ssh-server
created by Carlos Valiente.

The SSH related code was removed to focus solely on the SFTP protocol.


Alternatives
============

* https://github.com/ulope/pytest-sftpserver
* https://github.com/rspivak/sftpserver


