pyngrok

Added

• Build and stability improvements.

Added

• obj parsing in NgrokLog.
• raises to documentation.
• Build improvements.

Added

• Build and style improvements.

Removed

• conf.VERSION, moved all version information to pyngrok/__init__.py. Get package version with from pyngrok import __version__ instead.

Added

• Build improvements.

Changed

• Renamed make check-style to make check.

Added

• Relative dependency pinning in pyproject.toml.
• Style and stability improvements (check flake8 with make check-style).

Removed

• requirements.txt files to streamline in to pyproject.toml.

Added

• Migrated to pyproject.toml.
• Fix for instability from an ngrok binary change.
• Test improvements.

Added

• Documentation improvements.
• Test improvements.

Removed

• Support for 3.6 and 3.7. To use pyngrok with Python 3.7 or lower, pin pyngrok<7.1.

Fixed

• Test improvements, suite now respects NGROK_AUTHTOKEN for all necessary tests (skipped if not set, rather than tests failing).

Added

• If a value for PyngrokConfig.authToken, it will attempt to use the environment variable NGROK_AUTHTOKEN if it is set.
• Documentation improvements.
• Build improvements.

Added

• Build improvements, including wheel support.

Changed

• pyngrok to no longer install the config file in a legacy location, now respects ngrok's default locations.

Fixed

• Build improvements.

Added

• Documentation improvements.

Added

• Support for Python type hints.
• Documentation improvements.

Changed

• Moved NgrokLog from pyngrok.process to pyngrok.log.

Removed

• Support for Python 3.5. To use pyngrok with Python 3.5, pin pyngrok<7.

Added

• Documentation improvements.

Fixed

• Minor bugs.

Added

• Support for labels, so ngrok's Labeled Tunnel Configuration is now supported, which enables basic support for ngrok's Cloud Edge.
• api_key to PyngrokConfig, which can be set so pyngrok can interface with Cloud Edge when using labels.
• ngrok.api_request() now takes an auth param, so it can now be used to pass the Bearer token to ngrok's API.
• id to NgrokTunnel.
• Documentation improvements.
• Test improvements.

Changed

• Default installer behavior to download ngrok v3 by default.
• Documentation updates.
• Test updates.

Added

• Support for basic_auth parameter in ngrok v3.
• Documentation improvements.
• Test improvements.

Fixed

• Documentation improvements.
• Test improvements.

Added

• Support for Python 3.10 and 3.11.

Removed

• Usage of nose in testing in favor of unittest.

Added

• Support for ngrok v3 (v2 is still used by default).
• Documentation and examples for using pyngrok with ngrok v3.

Fixed

• Stability improvements.
• Documentation improvements.
• Test improvements.