Metadata-Version: 2.1
Name: pymongo-ssh
Version: 0.0.2
Summary: Python utilities to simplify connection with MongoDB through SSH tunnel
Home-page: https://github.com/pualien/pymongo-ssh
Author: Matteo Senardi
Author-email: pualien@gmail.com
License: MIT
Platform: UNKNOWN
Requires-Dist: pandas (>=0.25.3)
Requires-Dist: PyYAML (==5.3.1)
Requires-Dist: sshtunnel (==0.2.2)
Requires-Dist: cryptography (==3.0)
Requires-Dist: pymongo (==3.11.2)

ssh-pymongo
-----------
Python utilities to simplify connection with MongoDB through SSH tunnel.
Note: `uri` parameter is assumed as local, after ssh.

``pip install pymongo-ssh``

Example 1
---------

.. code:: python

    from pymongo_ssh import MongoSession

    session = MongoSession('db.example.com')
    db = session.connection['db-name']
    session.stop()
    # session.start()

Example 2
---------

.. code:: python

    session = MongoSession(
        host='db.example.com',
        uri='mongodb://user:password@127.0.0.1/?authSource=admin&authMechanism=SCRAM-SHA-256'
    )
    ...
    session.stop()

Example 3
---------

.. code:: python

    session = MongoSession(
        host='db.example.com',
        user='myuser',
        password='mypassword',
    )
    ...
    session.stop()

Example 4
---------

.. code:: python

    session = MongoSession(
        host='db.example.com',
        port='21',
        user='myuser',
        key='/home/myplace/.ssh/id_rsa2',
        to_port='37017',
        to_host='0.0.0.0'
    )
    ...
    session.stop()



