pyngrok

Added

• config_path parameter to ngrok.disconnect().
• ngrok.run() method for more flexibility in starting ngrok programmatically.
• __str__ and __repr__ methods.
• Initial Sphinx configuration and dependencies for documentation.
• Code documentation.

Added

• Support for all platforms for which ngrok is compatible, including ARM processors.

Changed

• Cleaned up code around ensuring the ngrok binary is present.
• Cleaned up code around process termination.
• Cleaned up tests.

Fixed

• Documentation issues.

Added

• config_path variable to NgrokProcess class.
• Ability to pass args to ngrok.run().
• A bug report issue template.
• A feature request issue template.

Changed

• Renamed CURRENT_PROCESSES in process module to a private _current_processes.
• Reduced many log levels to debug to minimize noise and make info logs most relevant.

Fixed

• Sometimes ngrok logs errors on startup but doesn't set the lvl=error flag, so pyngrok now also checks the err variable to see if it contains an error to surface.
• If the ngrok process started by pyngrok is killed externally, pyngrok now handles its own state properly.
• Documentation issues.

Changed

• DEFAULT_RETRY_COUNT for use in installer._download_file().

Fixed

• Removed code that could cause a ModuleNotFoundError when another module referenced this module in it's requirements.txt.

Added

• api_url variable to NgrokProcess class. See NgrokProcess class.
• startup_logs variable to NgrokProcess class. See NgrokProcess class.
• startup_error variable to NgrokProcess class. See NgrokProcess class.
• pyngrok console alias that mirrors ngrok.
• pyngrok's version is now also reported alongside ngrok's version when invoked via the console.

Changed

• Refactored the boot loop for improved stability and accessibility.

Fixed

• Properly identify more ARM processors, including aarch64.

Removed

• process variable from NgrokProcess (previously deprecated in 1.4.0, use proc now instead).

Fixed

• Issue where arguments passed from the command line to ngrok were being dropped (and thus ngrok help was always being displayed).

Added

• Configurable timeout parameter for requests to the API.
• Configurable timeout parameter when ngrok is being downloaded and installed.
• PyngrokNgrokURLError, which is thrown when a request timeout occurs.

Changed

• Improvements to the bug reports issue template.

Added

• Configurable timeout parameter for ngrok.connect(), ngrok.disconnect(), and ngrok.get_tunnels() in ngrok module.
• A changelog, code of conduct, and contributing guide.
• A pull request template.
• Documentation now builds and publishes to pyngrok.readthedocs.io.
• proc variable to NgrokProcess, which will replace process in the future due to module shadowing (process is still set for backwards compatibility, but it should no longer be relied upon as it will be removed in a future release).

Fixed

• Documentation issues.