https://github.com/jmagnusson/bgtunnel

Initiate SSH tunnels in the background in python
https://github.com/jmagnusson/bgtunnel

Last synced: 3 days ago
JSON representation

Initiate SSH tunnels in the background in python

• Host: GitHub
• URL: https://github.com/jmagnusson/bgtunnel
• Owner: jacobsvante
• License: mit
• Created: 2013-09-13T15:38:35.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2023-06-29T20:27:57.000Z (over 1 year ago)
• Last Synced: 2024-12-03T02:06:21.771Z (9 days ago)
• Language: Python
• Size: 44.9 KB
• Stars: 48
• Watchers: 4
• Forks: 12
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

• awesome-network-stuff - **43**星

README

        
[![Build Status](https://travis-ci.org/jmagnusson/bgtunnel.png?branch=master)](https://travis-ci.org/jmagnusson/bgtunnel)

**Author:** Jacob Magnusson. [Follow me on Twitter][twitter]

## What is this?

`bgtunnel` is a python module for easily creating ssh tunnels in the background, from within python. An example use case is when you want to access a remote database. With `bgtunnel` all you need is ssh access to the remote machine and python installed.

The package has no external dependencies. If you'd want to you could just drop in `bgtunnel.py` into your project.

## Installation

Install using `pip`:

    pip install bgtunnel

## Dependencies

python 2.7+ or 3.3+

## Testing

Clone the repo:

    git clone https://github.com/jmagnusson/bgtunnel.git

Install requirements for testing:

    pip install -r requirements_test.txt

Ensure that you have all python versions listed in `tox.ini` then to run the tests simply issue the following:

    tox

## Documentation

[docs]

[twitter]: https://twitter.com/jacobsvante_

[docs]: https://github.com/jmagnusson/bgtunnel/blob/master/bgtunnel.py#L1