====================================
Welcome to Paramiko's documentation!
====================================

This site covers Paramiko's usage & API documentation. For basic info on what
Paramiko is, including its public changelog & how the project is maintained,
please see `the main website <http://paramiko.org>`_.


API documentation
=================

Core SSH protocol classes
-------------------------

.. toctree::
    api/channel
    api/client
    api/message
    api/packet
    api/transport


Authentication & key handling
-----------------------------

.. toctree::
    api/agent
    api/hostkeys
    api/keys
    api/win_pageant


Other primary functions
-----------------------

.. toctree::
    api/config
    api/proxy
    api/server
    api/sftp


Miscellany
----------

.. toctree::
    api/buffered_pipe
    api/file
    api/pipe
    api/ssh_exception