Metadata-Version: 2.1
Name: psycossh
Version: 0.0.1
Summary: A ConnectionFactory for use by psycopg2 to enable SSH Tunneling
Home-page: https://github.com/mpca-adau/psycossh
Author: Daniel Sullivan
Author-email: daniel.sullivan@state.mn.us
License: LGPL-3.0
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Description-Content-Type: text/markdown
Requires-Dist: sshtunnel
Requires-Dist: psycopg2
Requires-Dist: sqlalchemy

# PsycoSSH

A ConnectionFactory for use by psycopg2 to enable SSH Tunneling

Probably should just use `create_tunneled_engine` which wraps around it

### Example

```python
from psycossh import create_tunneled_engine
from sqlalchemy import MetaData

engine = create_tunneled_engine(
    ssh_user="ssh_username",
    ssh_pkey=r"C:\Path\To\OpenSSH_Private_Key",  # without password
    ssh_host=r"ssh_server_host",
    ssh_port=22,  # default value  

    database=r"main_db",
    pg_host="localhost",  # default value
    pg_port=5432,  # default value
    pg_password="pg_password"
)
meta = MetaData()
meta.reflect(bind=engine)
print(meta.tables)
```


