Bump pyngrok from 4.1.12 to 5.0.0

[dependabot]

Bumps pyngrok from 4.1.12 to 5.0.0.

Release notes

Sourced from pyngrok's releases.

5.0.0

Added

• Support for ngrok's tunnel definitions when calling ngrok.connect(). If a tunnel definition in ngrok's config matches the given name, it will be used to start the tunnel.
• Support for a ngrok tunnel definition named "pyngrok-default" when calling ngrok.connect(). When name is None and a "pyngrok-default" tunnel definition exists it ngrok's config, it will be used.
• process.is_process_running() to check if ngrok is already running without also implicitly starting it.
• ngrok.get_version() to get ngrok and pyngrok versions in a tuple.
• conf.get_default(), replacing the need for direct references to conf.DEFAULT_PYNGROK_CONFIG.
• conf.set_default(), replacing the need for direct references to conf.DEFAULT_PYNGROK_CONFIG.
• refresh_metrics() to NgrokTunnel.
• data to NgrokTunnel, which holds the original tunnel data.
• ngrok.update() to update ngrok, if an update is available.
• Stability improvements.
• Documentation improvements.
• Logging improvements.

Changed

• ngrok.connect() now returns a NgrokTunnel instead of a str of the public URL. The returned NgrokTunnel has a reference to the previously returned public_url in it.
• ngrok.connect() changed its signature, renamed kwarg port (the first arg) to addr to match ngrok's documentation.
• ngrok.connect() changed its signature, the options kwarg should now be unpacked, pass each option directly to the method as a kwarg.
• NgrokTunnel.__init__()'s params (data, pyngrok_config, and api_url) are now required.
• ngrok.disconnect() no longer installs and starts ngrok, it simply returns if the ngrok process has not been started.
• Renamed conf.DEFAULT_PYNGROK_CONFIG to conf._default_pyngrok_config (use conf.set_default() instead).
• Renamed ngrok.ensure_ngrok_installed() to ngrok.install_ngrok().
• ngrok.install_ngrok() (formerly ngrok.ensure_ngrok_installed()) changed its signature, now takes a pyngrok_config (optional) instead of ngrok_path as its only arg.
• Renamed process._ensure_path_ready() to process._validate_path().

Removed

• Support for Python 2.7. To use pyngrok with Python 2.7, pin pyngrok>=4.1,<4.2.
• return_ngrok_tunnel from ngrok.connect(). The kwarg can still be passed, but it will do nothing, it now always uses the True behavior.

4.2.2

The next release, 5.0.0, contains breaking changes, including dropping support for Python 2.7. 4.2.x is meant to ease migration between 4.1.x and 5.0.0 and should not be pinned, as it will not be supported after 5.0.0 is released. To prepare for these breaking changes, see the changelog below. To avoid these breaking changes altogether, or if Python 2.7 support is still needed, pin pyngrok>=4.1,<4.2.

Added

• ngrok.connect() replaced options with kwargs, maintained backwards compatibility. Support for passing options as a dict will be removed in 5.0.0, unpack the dict as kwargs.
• ngrok.connect() added return_ngrok_tunnel to its args, which defaults to False for backwards compatibility. This will default to True in 5.0.0, and the flag will be removed.
• conf.get_default(), replacing the need to directly reference conf.DEFAULT_PYNGROK_CONFIG, which will be removed in 5.0.0.

4.1.16

Added

• ngrok.get_version() to get ngrok and pyngrok versions in a tuple.
• refresh_metrics() to NgrokTunnel.
• Documentation improvements.
• Logging improvements.

4.1.13

Added

... (truncated)

Changelog

Sourced from pyngrok's changelog.

5.0.0 - 2020-10-25

Added

• Support for ngrok's tunnel definitions when calling ngrok.connect(). If a tunnel definition in ngrok's config matches the given name, it will be used to start the tunnel.
• Support for a ngrok tunnel definition named "pyngrok-default" when calling ngrok.connect(). When name is None and a "pyngrok-default" tunnel definition exists it ngrok's config, it will be used.
• process.is_process_running() to check if ngrok is already running without also implicitly starting it.
• ngrok.get_version() to get ngrok and pyngrok versions in a tuple.
• conf.get_default(), replacing the need for direct references to conf.DEFAULT_PYNGROK_CONFIG.
• conf.set_default(), replacing the need for direct references to conf.DEFAULT_PYNGROK_CONFIG.
• refresh_metrics() to NgrokTunnel.
• data to NgrokTunnel, which holds the original tunnel data.
• ngrok.update() to update ngrok, if an update is available.
• Stability improvements.
• Documentation improvements.
• Logging improvements.

Changed

• ngrok.connect() now returns a NgrokTunnel instead of a str of the public URL. The returned NgrokTunnel has a reference to the previously returned public_url in it.
• ngrok.connect() changed its signature, renamed kwarg port (the first arg) to addr to match ngrok's documentation.
• ngrok.connect() changed its signature, the options kwarg should now be unpacked, pass each option directly to the method as a kwarg.
• NgrokTunnel.__init__()'s params (data, pyngrok_config, and api_url) are now required.
• ngrok.disconnect() no longer installs and starts ngrok, it simply returns if the ngrok process has not been started.
• Renamed conf.DEFAULT_PYNGROK_CONFIG to conf._default_pyngrok_config (use conf.set_default() instead).
• Renamed ngrok.ensure_ngrok_installed() to ngrok.install_ngrok().
• ngrok.install_ngrok() (formerly ngrok.ensure_ngrok_installed()) changed its signature, now takes a pyngrok_config (optional) instead of ngrok_path as its only arg.
• Renamed process._ensure_path_ready() to process._validate_path().

Removed

• Support for Python 2.7. To use pyngrok with Python 2.7, pin pyngrok>=4.1,<4.2.
• return_ngrok_tunnel from ngrok.connect(). The kwarg can still be passed, but it will do nothing, it now always uses the True behavior.

4.2.2 - 2020-10-12

The next release, 5.0.0, contains breaking changes, including dropping support for Python 2.7. 4.2.x is meant to ease migration between 4.1.x and 5.0.0 and should not be pinned, as it will not be supported after 5.0.0 is released. To prepare for these breaking changes, see the changelog below. To avoid these breaking changes altogether, or if Python 2.7 support is still needed, pin pyngrok>=4.1,<4.2.

Added

• ngrok.connect() replaced options with kwargs, maintained backwards compatibility. Support for passing options as a dict will be removed in 5.0.0, unpack the dict as kwargs.
• ngrok.connect() added return_ngrok_tunnel to its args, which defaults to False for backwards compatibility. This will default to True in 5.0.0, and the flag will be removed.
• conf.get_default(), replacing the need to directly reference conf.DEFAULT_PYNGROK_CONFIG, which will be removed in 5.0.0.

4.1.16 - 2020-10-12

Added

• ngrok.get_version() to get ngrok and pyngrok versions in a tuple.
• refresh_metrics() to NgrokTunnel.
• Documentation improvements.
• Logging improvements.

4.1.13 - 2020-10-02

... (truncated)

Commits

• de6ffe0 README update.
• 4926aed Merge branch '5.0.0' into develop
• e837536 Adding release date to changelog for 5.0.0
• d02f999 Doc updates, updating response from capture_run_process.
• 7172478 - Renamed process.get_update() to process.capture_run_process(), since it can...
• f2d2c3b Updating changelog.
• 17bca9d Bump version.
• 9206bec Merge branch 'develop' into 5.0.0
• 6f63f2a Changelog update.
• 7ae1961 Changelog update.
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

[dependabot]

Superseded by #13.