4.0.1

Changed

• Moved _DEFAULT_NGROK_CONFIG_PATH from ngrok module to conf module, renamed to DEFAULT_NGROK_CONFIG_PATH.

Fixed

• Exception thrown when trying to validate the config when no file is given (i.e. the variable is None and thus the default should be used).

4.0.0

Added

• PyngrokConfig, which contains all of pyngrok's configuration for interacting with the ngrok binary rather than passing these values around in an ever-growing list of kwargs. It is documented here.
• log_event_callback is a new configuration parameter in PyngrokConfig, a callback that will be invoked each time a ngrok log is emitted.
• monitor_thread is a new configuration parameter in PyngrokConfig which determines whether ngrok should continue to be monitored (for logs, etc.) after it has finished starting. Defaults to True.
• startup_timeout is a new configuration parameter in PyngrokConfig.
• max_logs is a new configuration parameter in PyngrokConfig.
• start_monitor_thread() and stop_monitor_thread() to NgrokProcess.

Changed

• timeout parameter that was passed down to ngrok.api_request() is now configurable by request_timeout in PyngrokConfig.
• Max number of logs stored by the NgrokProcess from 500 to 100.
• NgrokProcess.log_boot_line() renamed to NgrokProcess._log_startup_line().
• NgrokProcess.log_line() renamed to NgrokProcess._log_line().
• Auto-generated tunnel names (if name is not given when calling ngrok.connect()) are no prefixed with proto and port.
• web_addr cannot be set to false in, as the pyngrok modules depends on this API.

Fixed

• installer.install_default_config() documentation now properly reflects that data is a dict and not a str.

Removed

• ngrok_path, config_path, auth_token, and region were all removed from process.get_process(). Use PyngrokConfig instead.
• ngrok_path, config_path, auth_token, and region were all removed from ngrok.get_ngrok_process(). Use PyngrokConfig instead.
• ngrok_path, config_path, auth_token, region, and timeout were all removed from ngrok.connect(). Use PyngrokConfig instead.
• ngrok_path, config_path, and timeout were all removed from ngrok.disconnect(). Use PyngrokConfig instead.
• ngrok_path, and timeout were all removed from ngrok.get_tunnels(). Use PyngrokConfig instead.

3.1.1

Changed

• Limit number of NgrokLogs stored in NgrokProcess's logs variable to last 500.

3.1.0

Added

• After ngrok starts, the process moves into its own thread and NgrokLogs continue to be parsed for programmatic access.

3.0.0

• NgrokLog class is a parsed representation of ngrok's logs for more accessible debugging.
• logs variable to NgrokProcess class, which is a NgrokLog object.

Changed

• ngrok_logs in PyngrokNgrokException is now a list of NgrokLogs instead of strs.
• When starting the ngrok process, log levels now match ngroks in its startup logs.

Removed

• startup_logs from NgrokProcess, use logs instead.

2.1.7

Fixed

• Documentation and SEO improvements.

2.1.6

Fixed

• Documentation and SEO improvements.

2.1.5

Added

• Troubleshooting tips to the documentation.
• An integration example for end-to-end testing.

Changed

• PyPI package classifiers.

2.1.4

Added

• An integration example for FastAPI.

Fixed

• FreeBSD is now listed as a supported platform and the correct binary is chosen.

2.1.3

Added

• Integration examples to the documentation for common uses cases.

Fixed

• Build improvements.