https://github.com/crossbrowsertesting/sb_securetunnel_py
Python wrapper for SmartBear Secure_Tunnel to make using tunnels a snap
https://github.com/crossbrowsertesting/sb_securetunnel_py
Last synced: 5 months ago
JSON representation
Python wrapper for SmartBear Secure_Tunnel to make using tunnels a snap
- Host: GitHub
- URL: https://github.com/crossbrowsertesting/sb_securetunnel_py
- Owner: crossbrowsertesting
- Archived: true
- Created: 2020-10-16T15:36:20.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-12-08T20:40:59.000Z (over 5 years ago)
- Last Synced: 2025-09-24T18:57:22.905Z (9 months ago)
- Language: Python
- Size: 8.79 KB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sbsecuretunnel
A python module to make using tunnels easy.
Note: this is pre-release software. If you encounter any problems,
please reach out to CrossBrowserTesting
## pip
`pip install sbsecuretunnel`
## How to use
```
from sbsecuretunnel.sb_securetunnel import SBTunnel
tunnel = SBTunnel(username="you@email.com", authkey="yourauthkey")
tunnel.start_tunnel()
...
tunnel.kill_tunnel()
```
## Features
- Automatically gets the correct tunnel for your platform
- Handles cleanly starting and stopping the tunnel connection
- Handles all features of the tunnel
## Creating a tunnel object
The tunnel object is created with the following options:
- `username` ("") - CBT username
- `authkey` ("") - CBT authkey
- `delete_after` (False) - delete the tunnel binary after kill (note: on Windows, make sure backslashes are escaped `\\`)
- `tunnel_location` (".") - location to download tunnel binary to
- `ready_file` ("ready.check") - ready file for tunnel client
- `kill_file` ("kill.check") - kill file for tunnel client
## Tunnel options
These are all methods available on the tunnel object
- `bypass(bool)` - enable or disable bypass
- `set_https_proxy(string)` - string should be the HTTPS proxy
- `set_http_proxy(string)` - same as above for HTTP
- `set_tunnel_name(string)` - set the name of the named tunnel
- `set_pac_file(string)` - set the client to use the PAC file at path string
- `set_html_path(string)` - set the path to use for local HTML files to be served
- `set_proxy(host="string", port="string", username="string"/None, password="string/None)` - set proxy settings
- `set_accept_all_certs(bool)` - set whether to accept all certs in the tunnel client