RC for 5.0.0

[alexdlaird]

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.
• data to NgrokTunnel, which holds the original tunnel data.
• Stability 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.

[codecov[bot]]

Codecov Report

Merging #69 into develop will decrease coverage by 0.45%. The diff coverage is 93.71%.

@@             Coverage Diff             @@
##           develop      #69      +/-   ##
===========================================
- Coverage    94.72%   94.27%   -0.46%     
===========================================
  Files            5        5              
  Lines          512      559      +47     
===========================================
+ Hits           485      527      +42     
- Misses          27       32       +5     

Impacted Files	Coverage Δ
pyngrok/process.py	93.20% <91.89%> (-1.70%)	:arrow_down:
pyngrok/ngrok.py	92.26% <91.95%> (+0.59%)	:arrow_up:
pyngrok/conf.py	100.00% <100.00%> (ø)
pyngrok/installer.py	96.12% <100.00%> (+0.22%)	:arrow_up:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update d60defb...22a3513. Read the comment docs.