From ad75496ea14f83fe07745e0f09c8aa99690fb312 Mon Sep 17 00:00:00 2001 From: Alex Laird Date: Sat, 4 May 2024 08:07:08 -0500 Subject: [PATCH] Running formatter to cleanup files. --- CHANGELOG.md | 420 ++++++++++++++++++++++++++------ README.md | 15 +- SECURITY.md | 3 +- docs/_html/sitemap-index.xml | 2 +- docs/_templates/layout.html | 86 +++---- docs/_templates/sidebartoc.html | 24 +- pyngrok/conf.py | 2 +- pyngrok/exception.py | 2 +- pyngrok/installer.py | 2 +- pyngrok/ngrok.py | 8 +- pyngrok/process.py | 4 +- tests/test_installer.py | 4 +- tests/test_ngrok.py | 7 +- tests/test_process.py | 2 +- tests/testcase.py | 3 +- 15 files changed, 438 insertions(+), 146 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 352a8a02..84c698cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,229 +1,342 @@ # Changelog + All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased](https://github.com/alexdlaird/pyngrok/compare/7.1.6...HEAD) + ### Added + - Build improvements. - Test cases for TLS tunnels. ## [7.1.6](https://github.com/alexdlaird/pyngrok/compare/7.1.5...7.1.6) - 2024-03-24 + ### Added + - Build and stability improvements. ## [7.1.5](https://github.com/alexdlaird/pyngrok/compare/7.1.4...7.1.5) - 2024-03-08 + ### Added + - `obj` parsing in [`NgrokLog`](https://pyngrok.readthedocs.io/en/7.1.5/api.html#pyngrok.log.NgrokLog). - `raises` to documentation. - Build improvements. ## [7.1.4](https://github.com/alexdlaird/pyngrok/compare/7.1.3...7.1.4) - 2024-03-05 + ### 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. + +- `conf.VERSION`, moved all version information to `pyngrok/__init__.py`. Get package version + with `from pyngrok import __version__` instead. ## [7.1.3](https://github.com/alexdlaird/pyngrok/compare/7.1.2...7.1.3) - 2024-02-26 + ### Added + - Build improvements. ### Changed + - Renamed `make check-style` to `make check`. ## [7.1.2](https://github.com/alexdlaird/pyngrok/compare/7.1.1...7.1.2) - 2024-02-11 + ### 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`. ## [7.1.1](https://github.com/alexdlaird/pyngrok/compare/7.1.0...7.1.1) - 2024-02-09 + ### Added + - Migrated to `pyproject.toml`. - Fix for instability from an `ngrok` binary change. - Test improvements. ## [7.1.0](https://github.com/alexdlaird/pyngrok/compare/7.0.5...7.1.0) - 2024-02-02 + ### 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`. ## [7.0.5](https://github.com/alexdlaird/pyngrok/compare/7.0.4...7.0.5) - 2023-12-30 + ### Fixed -- Test improvements, suite now respects `NGROK_AUTHTOKEN` for all necessary tests (skipped if not set, rather than tests failing). + +- Test improvements, suite now respects `NGROK_AUTHTOKEN` for all necessary tests (skipped if not set, rather than tests + failing). ## [7.0.4](https://github.com/alexdlaird/pyngrok/compare/7.0.3...7.0.4) - 2023-12-27 + ### Added -- If a value for `PyngrokConfig.authToken`, it will attempt to use the environment variable `NGROK_AUTHTOKEN` if it is set. + +- If a value for `PyngrokConfig.authToken`, it will attempt to use the environment variable `NGROK_AUTHTOKEN` if it is + set. - Documentation improvements. - Build improvements. ## [7.0.3](https://github.com/alexdlaird/pyngrok/compare/7.0.2...7.0.3) - 2023-12-04 + ### Added + - Build improvements, including `wheel` support. ## [7.0.2](https://github.com/alexdlaird/pyngrok/compare/7.0.1...7.0.2) - 2023-12-01 + ### Changed -- `pyngrok` to no longer install the config file in a legacy location, now respects [`ngrok`'s default locations](https://ngrok.com/docs/agent/config/#default-locations). + +- `pyngrok` to no longer install the config file in a legacy location, now + respects [`ngrok`'s default locations](https://ngrok.com/docs/agent/config/#default-locations). ### Fixed + - Build improvements. ## [7.0.1](https://github.com/alexdlaird/pyngrok/compare/7.0.0...7.0.1) - 2023-11-14 + ### Added + - Documentation improvements. ## [7.0.0](https://github.com/alexdlaird/pyngrok/compare/6.1.2...7.0.0) - 2023-09-20 + ### Added + - Support for [Python type hints](https://docs.python.org/3/library/typing.html). - Documentation improvements. ### Changed -- Moved [`NgrokLog`](https://pyngrok.readthedocs.io/en/7.0.0/api.html#pyngrok.log.NgrokLog) from `pyngrok.process` to `pyngrok.log`. + +- Moved [`NgrokLog`](https://pyngrok.readthedocs.io/en/7.0.0/api.html#pyngrok.log.NgrokLog) from `pyngrok.process` + to `pyngrok.log`. ### Removed + - Support for Python 3.5. To use `pyngrok` with Python 3.5, pin `pyngrok<7`. ### Fixed + - Minor bugs. ## [6.1.2](https://github.com/alexdlaird/pyngrok/compare/6.1.0...6.1.2) - 2023-09-19 + ### Added + - Documentation improvements. ### Fixed + - Minor bugs. ## [6.1.0](https://github.com/alexdlaird/pyngrok/compare/6.0.0...6.1.0) - 2023-09-12 + ### Added -- Support for `labels`, so [`ngrok`'s Labeled Tunnel Configuration](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config/#labeled-tunnel-configuration-properties) is now supported, which enables basic support for [`ngrok`'s Cloud Edge](https://ngrok.com/docs/cloud-edge/). + +- Support for `labels`, + so [`ngrok`'s Labeled Tunnel Configuration](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config/#labeled-tunnel-configuration-properties) + is now supported, which enables basic support for [`ngrok`'s Cloud Edge](https://ngrok.com/docs/cloud-edge/). - `api_key` to `PyngrokConfig`, which can be set so `pyngrok` can interface with Cloud Edge when using `labels`. -- [ngrok.api_request()](https://pyngrok.readthedocs.io/en/6.1.0/api.html#pyngrok.ngrok.api_request) now takes an `auth` param, so it can now be used to pass the `Bearer` token to `ngrok`'s API. +- [ngrok.api_request()](https://pyngrok.readthedocs.io/en/6.1.0/api.html#pyngrok.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](https://pyngrok.readthedocs.io/en/6.1.0/api.html#pyngrok.ngrok.NgrokTunnel). - Documentation improvements. - Test improvements. ## [6.0.0](https://github.com/alexdlaird/pyngrok/compare/5.2.3...6.0.0) - 2023-04-12 + ### Changed + - Default installer behavior to download `ngrok` v3 by default. - Documentation updates. - Test updates. ## [5.2.3](https://github.com/alexdlaird/pyngrok/compare/5.2.2...5.2.3) - 2023-04-12 + ### Added + - Support for `basic_auth` parameter in `ngrok` v3. - Documentation improvements. - Test improvements. ## [5.2.2](https://github.com/alexdlaird/pyngrok/compare/5.2.1...5.2.2) - 2023-04-11 + ### Fixed + - Documentation improvements. - Test improvements. ## [5.2.1](https://github.com/alexdlaird/pyngrok/compare/5.2.0...5.2.1) - 2022-11-29 + ### Added + - Support for Python 3.10 and 3.11. ### Removed -- Usage of [`nose`](https://nose.readthedocs.io/en/latest/) in testing in favor of [`unittest`](https://docs.python.org/3/library/unittest.html). + +- Usage of [`nose`](https://nose.readthedocs.io/en/latest/) in testing in favor + of [`unittest`](https://docs.python.org/3/library/unittest.html). ## [5.2.0](https://github.com/alexdlaird/pyngrok/compare/5.1.0...5.2.0) - 2022-11-28 + ### Added + - Support for [`ngrok` v3](https://ngrok.com/docs/guides/upgrade-v2-v3) (v2 is still used by default). - Documentation and examples for using `pyngrok` with `ngrok` v3. ### Fixed + - Stability improvements. - Documentation improvements. - Test improvements. ## [5.1.0](https://github.com/alexdlaird/pyngrok/compare/5.0.6...5.1.0) - 2021-08-24 + ### Removed -- `reconnect_session_retries` from `PyngrokConfig`, instead relying on `ngrok`'s own built-in retry mechanism on startup fails. + +- `reconnect_session_retries` from `PyngrokConfig`, instead relying on `ngrok`'s own built-in retry mechanism on startup + fails. ### Fixed + - Logging improvements. - Documentation improvements. - Test improvements. ## [5.0.6](https://github.com/alexdlaird/pyngrok/compare/5.0.5...5.0.6) - 2021-08-08 + ### Added + - Darwin 64-bit ARM support, as this was added to `ngrok` itself. ### Removed + - Darwin 386 support, as this was removed from `ngrok` itself. ### Fixed + - Build improvements. - Documentation improvements. ## [5.0.5](https://github.com/alexdlaird/pyngrok/compare/5.0.4...5.0.5) - 2021-03-25 + ### Added -- `reconnect_session_retries` is a new configuration parameter in `PyngrokConfig`, which determines the max number of times to retry establishing a new session with `ngrok` if the connection fails on startup. + +- `reconnect_session_retries` is a new configuration parameter in `PyngrokConfig`, which determines the max number of + times to retry establishing a new session with `ngrok` if the connection fails on startup. ### Fixed + - Build improvements. - Test improvements. ## [5.0.4](https://github.com/alexdlaird/pyngrok/compare/5.0.3...5.0.4) - 2021-03-08 + ### Fixed + - Build improvements. ## [5.0.3](https://github.com/alexdlaird/pyngrok/compare/5.0.2...5.0.3) - 2021-03-02 + ### Fixed + - Build improvements. - Test improvements. ## [5.0.2](https://github.com/alexdlaird/pyngrok/compare/5.0.1...5.0.2) - 2021-02-12 + ### Changed + - Migrated build from Travis CI to GitHub Actions. ### Fixed + - Errors when `bind_tls` was set to `False`. - Documentation improvements. ## [5.0.1](https://github.com/alexdlaird/pyngrok/compare/5.0.0...5.0.1) - 2020-12-28 + ### Added + - Documentation improvements. ### Fixed + - Build improvements. ## [5.0.0](https://github.com/alexdlaird/pyngrok/compare/4.2.2...5.0.0) - 2020-10-25 + ### Added -- Support for [`ngrok`'s tunnel definitions](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config/#tunnel-definitions) when calling [ngrok.connect()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.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](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config/#tunnel-definitions) named "pyngrok-default" when calling [ngrok.connect()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.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()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.process.is_process_running) to check if `ngrok` is already running without also implicitly starting it. -- [ngrok.get_version()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.get_version) to get `ngrok` and `pyngrok` versions in a tuple. -- [conf.get_default()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.conf.get_default), replacing the need for direct references to `conf.DEFAULT_PYNGROK_CONFIG`. -- [conf.set_default()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.conf.set_default), replacing the need for direct references to `conf.DEFAULT_PYNGROK_CONFIG`. -- `refresh_metrics()` to [NgrokTunnel](https://pyngrok.readthedocs.io/en/4.1.16/api.html#pyngrok.ngrok.NgrokTunnel.refresh_metrics). -- `data` to [NgrokTunnel](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.NgrokTunnel), which holds the original tunnel data. -- [ngrok.update()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.update) to update `ngrok`, if an update is available. + +- Support + for [`ngrok`'s tunnel definitions](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config/#tunnel-definitions) + when calling [ngrok.connect()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.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](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config/#tunnel-definitions) + named "pyngrok-default" when + calling [ngrok.connect()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.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()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.process.is_process_running) to + check if `ngrok` is already running without also implicitly starting it. +- [ngrok.get_version()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.get_version) to get `ngrok` + and `pyngrok` versions in a tuple. +- [conf.get_default()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.conf.get_default), replacing the need + for direct references to `conf.DEFAULT_PYNGROK_CONFIG`. +- [conf.set_default()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.conf.set_default), replacing the need + for direct references to `conf.DEFAULT_PYNGROK_CONFIG`. +- `refresh_metrics()` + to [NgrokTunnel](https://pyngrok.readthedocs.io/en/4.1.16/api.html#pyngrok.ngrok.NgrokTunnel.refresh_metrics). +- `data` to [NgrokTunnel](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.NgrokTunnel), which holds the + original tunnel data. +- [ngrok.update()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.update) to update `ngrok`, if an + update is available. - Stability improvements. - Documentation improvements. - Logging improvements. ### Changed -- [ngrok.connect()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.connect) now returns a [NgrokTunnel](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.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()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.connect) changed its signature, renamed kwarg `port` (the first arg) to `addr` to match `ngrok`'s documentation. -- [ngrok.connect()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.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](https://pyngrok.readthedocs.io/en/5.0.0/_modules/pyngrok/ngrok.html#NgrokTunnel) 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()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.conf.set_default) instead). + +- [ngrok.connect()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.connect) now returns + a [NgrokTunnel](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.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()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.ngrok.connect) changed its signature, + renamed kwarg `port` (the first arg) to `addr` to match `ngrok`'s documentation. +- [ngrok.connect()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.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](https://pyngrok.readthedocs.io/en/5.0.0/_modules/pyngrok/ngrok.html#NgrokTunnel) + 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()](https://pyngrok.readthedocs.io/en/5.0.0/api.html#pyngrok.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. +- `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. Legacy documentation for 4.1, the latest version with Python 2.7 support, can be found [here](https://pyngrok.readthedocs.io/en/4.1.x/). -- `return_ngrok_tunnel` from `ngrok.connect()`. The `kwarg` can still be passed, but it will do nothing, it now always uses the `True` behavior. + +- Support for Python 2.7. Legacy documentation for 4.1, the latest version with Python 2.7 support, can be + found [here](https://pyngrok.readthedocs.io/en/4.1.x/). +- `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](https://github.com/alexdlaird/pyngrok/compare/4.1.16...4.2.2) - 2020-10-12 @@ -233,218 +346,345 @@ prepare for these breaking changes, see the changelog below. To avoid these brea Python 2.7 support is still needed, pin `pyngrok~=4.1.0`. ### Added -- [ngrok.connect()](https://pyngrok.readthedocs.io/en/4.2.2/api.html#pyngrok.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()](https://pyngrok.readthedocs.io/en/4.2.2/api.html#pyngrok.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()](https://pyngrok.readthedocs.io/en/4.2.2/api.html#pyngrok.conf.get_default), replacing the need to directly reference `conf.DEFAULT_PYNGROK_CONFIG`, which will be removed in 5.0.0. + +- [ngrok.connect()](https://pyngrok.readthedocs.io/en/4.2.2/api.html#pyngrok.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()](https://pyngrok.readthedocs.io/en/4.2.2/api.html#pyngrok.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()](https://pyngrok.readthedocs.io/en/4.2.2/api.html#pyngrok.conf.get_default), replacing the need to + directly reference `conf.DEFAULT_PYNGROK_CONFIG`, which will be removed in 5.0.0. ## [4.1.16](https://github.com/alexdlaird/pyngrok/compare/4.1.13...4.1.16) - 2020-10-12 + ### Added -- [ngrok.get_version()](https://pyngrok.readthedocs.io/en/4.1.16/api.html#pyngrok.ngrok.get_version) to get `ngrok` and `pyngrok` versions in a tuple. -- `refresh_metrics()` to [NgrokTunnel](https://pyngrok.readthedocs.io/en/4.1.16/api.html#pyngrok.ngrok.NgrokTunnel.refresh_metrics). + +- [ngrok.get_version()](https://pyngrok.readthedocs.io/en/4.1.16/api.html#pyngrok.ngrok.get_version) to get `ngrok` + and `pyngrok` versions in a tuple. +- `refresh_metrics()` + to [NgrokTunnel](https://pyngrok.readthedocs.io/en/4.1.16/api.html#pyngrok.ngrok.NgrokTunnel.refresh_metrics). - Documentation improvements. - Logging improvements. ## [4.1.13](https://github.com/alexdlaird/pyngrok/compare/4.1.12...4.1.13) - 2020-10-02 + ### Added -- An [integration example for Google Colab](https://pyngrok.readthedocs.io/en/4.1.13/integrations.html#google-colaboratory). + +- + +An [integration example for Google Colab](https://pyngrok.readthedocs.io/en/4.1.13/integrations.html#google-colaboratory). + - Documentation improvements. - Test `ngrok.api_request()` using `params` for filtering with special characters. ### Fixed -- [ngrok.api_request()](https://pyngrok.readthedocs.io/en/4.1.13/api.html#pyngrok.ngrok.api_request)'s `params` is now properly documented as a `dict` instead of a `list`. + +- [ngrok.api_request()](https://pyngrok.readthedocs.io/en/4.1.13/api.html#pyngrok.ngrok.api_request)'s `params` is now + properly documented as a `dict` instead of a `list`. - Trimmed trailing line return from `ngrok` logs. ## [4.1.12](https://github.com/alexdlaird/pyngrok/compare/4.1.11...4.1.12) - 2020-09-10 + ### Added + - Validation for `log_format` in `ngrok`'s `config.yaml`, as `pyngrok` depends on key/value logs. -- Validation for `log_level` in `ngrok`'s `config.yaml`, as `pyngrok` depends on the level being either `info` or `debug`. +- Validation for `log_level` in `ngrok`'s `config.yaml`, as `pyngrok` depends on the level being either `info` + or `debug`. ## [4.1.11](https://github.com/alexdlaird/pyngrok/compare/4.1.10...4.1.11) - 2020-09-08 + ### Fixed + - Build improvements. - Documentation improvements. ## [4.1.10](https://github.com/alexdlaird/pyngrok/compare/4.1.9...4.1.10) - 2020-08-14 + ### Fixed + - When `bind_tls` is `True`, the `public_url` return from `ngrok.connect()` is now `https`. ## [4.1.9](https://github.com/alexdlaird/pyngrok/compare/4.1.8...4.1.9) - 2020-08-12 + ### Fixed -- The thread that monitors `ngrok` logs now maintains its own `alive` state instead of modifying `PyngrokConfig.monitor_thread`. -- The thread that monitors `ngrok` logs [is now daemonic](https://docs.python.org/3/library/threading.html#threading.Thread.daemon), so it no longer blocks the Python process from terminating. + +- The thread that monitors `ngrok` logs now maintains its own `alive` state instead of + modifying `PyngrokConfig.monitor_thread`. +- The thread that monitors `ngrok` + logs [is now daemonic](https://docs.python.org/3/library/threading.html#threading.Thread.daemon), so it no longer + blocks the Python process from terminating. - Documentation improvements. ## [4.1.8](https://github.com/alexdlaird/pyngrok/compare/4.1.7...4.1.8) - 2020-07-26 + ### Added + - `DEFAULT_PYNGROK_CONFIG` variable to `conf` module, used when `pyngrok_config` is not passed to `ngrok` methods. ### Fixed + - Zombie processes remaining in certain cases when `ngrok` exited early or was terminated externally. ## [4.1.7](https://github.com/alexdlaird/pyngrok/compare/4.1.6...4.1.7) - 2020-07-23 + ### Fixed -- `TypeError` exception when a `NgrokLog` parses a string that contains a missing or malformed `lvl`. Default is now `NOTSET` in such cases. + +- `TypeError` exception when a `NgrokLog` parses a string that contains a missing or malformed `lvl`. Default is + now `NOTSET` in such cases. ## [4.1.6](https://github.com/alexdlaird/pyngrok/compare/4.1.5...4.1.6) - 2020-07-09 + ### Added -- `start_new_process` is a new configuration parameter in `PyngrokConfig`, which will be passed to [subprocess.Popen](https://docs.python.org/3/library/subprocess.html#subprocess.Popen) when `ngrok` is started. Requires Python 3 and POSIX. + +- `start_new_process` is a new configuration parameter in `PyngrokConfig`, which will be passed + to [subprocess.Popen](https://docs.python.org/3/library/subprocess.html#subprocess.Popen) when `ngrok` is started. + Requires Python 3 and POSIX. ### Fixed + - Documentation improvements in integration examples. ## [4.1.5](https://github.com/alexdlaird/pyngrok/compare/4.1.4...4.1.5) - 2020-07-06 + ### Fixed -- Appears `ngrok` itself has a bug around not properly escaping characters in tunnel names, so avoiding this bug for fileserver tunnels by substituting their name. + +- Appears `ngrok` itself has a bug around not properly escaping characters in tunnel names, so avoiding this bug for + fileserver tunnels by substituting their name. ## [4.1.4](https://github.com/alexdlaird/pyngrok/compare/4.1.3...4.1.4) - 2020-07-05 + ### Fixed -- Inconsistent support for a local directory (ex. `file:///`) being passed as `ngrok.connect()`'s `port`. This is valid, and `ngrok` will use its built-in fileserver for the tunnel. + +- Inconsistent support for a local directory (ex. `file:///`) being passed as `ngrok.connect()`'s `port`. This is valid, + and `ngrok` will use its built-in fileserver for the tunnel. ## [4.1.3](https://github.com/alexdlaird/pyngrok/compare/4.1.2...4.1.3) - 2020-06-21 + ### Fixed + - Issue where `NgrokLog` did not properly split on just the first `=` character when parsing a log. ## [4.1.2](https://github.com/alexdlaird/pyngrok/compare/4.1.1...4.1.2) - 2020-06-19 + ### Fixed + - Python 2 compatibility issue with download progress bar. ## [4.1.1](https://github.com/alexdlaird/pyngrok/compare/4.1.0...4.1.1) - 2020-06-18 + ### Fixed + - Stability improvements. - Documentation improvements. ## [4.1.0](https://github.com/alexdlaird/pyngrok/compare/4.0.3...4.1.0) - 2020-06-18 + ### Added + - Progress bar when `ngrok` is being downloaded and installed for the first time. - Version number displayed in CLI's `--help`. -- `installer.install_ngrok()` and `installer._download_file()` now accept `**kwargs`, which are passed down to [urllib.request.urlopen](https://docs.python.org/3/library/urllib.request.html#urllib.request.urlopen), and updated [the documentation](https://pyngrok.readthedocs.io/en/4.1.0/api.html#pyngrok.installer). +- `installer.install_ngrok()` and `installer._download_file()` now accept `**kwargs`, which are passed down + to [urllib.request.urlopen](https://docs.python.org/3/library/urllib.request.html#urllib.request.urlopen), and + updated [the documentation](https://pyngrok.readthedocs.io/en/4.1.0/api.html#pyngrok.installer). ### Fixed + - Documentation improvements. ## [4.0.3](https://github.com/alexdlaird/pyngrok/compare/4.0.2...4.0.3) - 2020-06-17 + ### Fixed + - Build improvements. ## [4.0.2](https://github.com/alexdlaird/pyngrok/compare/4.0.1...4.0.2) - 2020-06-17 + ### Added + - PyPI package classifiers. ### Fixed + - Build improvements. ## [4.0.1](https://github.com/alexdlaird/pyngrok/compare/4.0.0...4.0.1) - 2020-06-07 + ### 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). + +- 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](https://github.com/alexdlaird/pyngrok/compare/3.1.1...4.0.0) - 2020-06-06 + ### 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](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig). -- `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`. + +- `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](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig). +- `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](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.process.NgrokProcess). +- `start_monitor_thread()` and `stop_monitor_thread()` + to [NgrokProcess](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.process.NgrokProcess). ### Changed -- `timeout` parameter that was passed down to `ngrok.api_request()` is now configurable by `request_timeout` in `PyngrokConfig`. + +- `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`. +- 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](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig) instead. -- `ngrok_path`, `config_path`, `auth_token`, and `region` were all removed from `ngrok.get_ngrok_process()`. Use [PyngrokConfig](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig) instead. -- `ngrok_path`, `config_path`, `auth_token`, `region`, and `timeout` were all removed from `ngrok.connect()`. Use [PyngrokConfig](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig) instead. -- `ngrok_path`, `config_path`, and `timeout` were all removed from `ngrok.disconnect()`. Use [PyngrokConfig](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig) instead. -- `ngrok_path`, and `timeout` were all removed from `ngrok.get_tunnels()`. Use [PyngrokConfig](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig) instead. + +- `ngrok_path`, `config_path`, `auth_token`, and `region` were all removed from `process.get_process()`. + Use [PyngrokConfig](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig) instead. +- `ngrok_path`, `config_path`, `auth_token`, and `region` were all removed from `ngrok.get_ngrok_process()`. + Use [PyngrokConfig](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig) instead. +- `ngrok_path`, `config_path`, `auth_token`, `region`, and `timeout` were all removed from `ngrok.connect()`. + Use [PyngrokConfig](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig) instead. +- `ngrok_path`, `config_path`, and `timeout` were all removed from `ngrok.disconnect()`. + Use [PyngrokConfig](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig) instead. +- `ngrok_path`, and `timeout` were all removed from `ngrok.get_tunnels()`. + Use [PyngrokConfig](https://pyngrok.readthedocs.io/en/4.0.0/api.html#pyngrok.conf.PyngrokConfig) instead. ## [3.1.1](https://github.com/alexdlaird/pyngrok/compare/3.1.0...3.1.1) - 2020-06-06 + ### Changed + - Limit number of `NgrokLog`s stored in `NgrokProcess`'s `logs` variable to last 500. ## [3.1.0](https://github.com/alexdlaird/pyngrok/compare/3.0.0...3.1.0) - 2020-06-04 + ### Added -- After `ngrok` starts, the process moves into its own thread and `NgrokLog`s continue to be parsed for programmatic access. + +- After `ngrok` starts, the process moves into its own thread and `NgrokLog`s continue to be parsed for programmatic + access. ## [3.0.0](https://github.com/alexdlaird/pyngrok/compare/2.1.7...3.0.0) - 2020-05-29 + ### Added -- [NgrokLog](https://pyngrok.readthedocs.io/en/3.0.0/api.html#pyngrok.process.NgrokLog>) class is a parsed representation of `ngrok`'s logs for more accessible debugging. + +- [NgrokLog](https://pyngrok.readthedocs.io/en/3.0.0/api.html#pyngrok.process.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 `NgrokLog`s instead of `str`s. - When starting the `ngrok` process, log levels now match `ngrok`s in its startup logs. ### Removed -- `startup_logs` from `NgrokProcess`, [use `logs` instead](https://pyngrok.readthedocs.io/en/3.0.0/api.html#pyngrok.process.NgrokProcess). + +- `startup_logs` + from `NgrokProcess`, [use `logs` instead](https://pyngrok.readthedocs.io/en/3.0.0/api.html#pyngrok.process.NgrokProcess). ## [2.1.7](https://github.com/alexdlaird/pyngrok/compare/2.1.6...2.1.7) - 2020-05-06 + ### Fixed + - Documentation and SEO improvements. ## [2.1.6](https://github.com/alexdlaird/pyngrok/compare/2.1.5...2.1.6) - 2020-05-04 + ### Fixed + - Documentation and SEO improvements. ## [2.1.5](https://github.com/alexdlaird/pyngrok/compare/2.1.4...2.1.5) - 2020-05-01 + ### Added + - [Troubleshooting tips to the documentation](https://pyngrok.readthedocs.io/en/2.1.5/troubleshooting.html). -- An [integration example for end-to-end testing](https://pyngrok.readthedocs.io/en/2.1.5/integrations.html#end-to-end-testing). +- + +An [integration example for end-to-end testing](https://pyngrok.readthedocs.io/en/2.1.5/integrations.html#end-to-end-testing). ### Changed + - PyPI package classifiers. ## [2.1.4](https://github.com/alexdlaird/pyngrok/compare/2.1.3...2.1.4) - 2020-04-23 + ### Added + - An [integration example for FastAPI](https://pyngrok.readthedocs.io/en/2.1.4/integrations.html#fastapi). ### Fixed + - FreeBSD is now listed as a supported platform and the correct binary is chosen. ## [2.1.3](https://github.com/alexdlaird/pyngrok/compare/2.1.2...2.1.3) - 2020-03-28 + ### Added -- [Integration examples to the documentation](https://pyngrok.readthedocs.io/en/2.1.3/integrations.html) for common uses cases. + +- [Integration examples to the documentation](https://pyngrok.readthedocs.io/en/2.1.3/integrations.html) for common uses + cases. ### Fixed + - Build improvements. ## [2.1.2](https://github.com/alexdlaird/pyngrok/compare/2.1.1...2.1.2) - 2020-03-23 + ### Fixed + - Build improvements. ## [2.1.1](https://github.com/alexdlaird/pyngrok/compare/2.1.0...2.1.1) - 2020-03-21 + ### Fixed + - Version number displayed in CLI. ## [2.1.0](https://github.com/alexdlaird/pyngrok/compare/2.0.3...2.1.0) - 2020-03-21 + ### Added -- `region` parameter for `ngrok.connect()`, and `process.get_process()`. See [ngrok module](https://pyngrok.readthedocs.io/en/2.1.0/api.html#module-pyngrok.ngrok). -- `auth_token` parameter for `ngrok.connect()`, and `process.get_process()`. See [ngrok module](https://pyngrok.readthedocs.io/en/2.1.0/api.html#module-pyngrok.ngrok). + +- `region` parameter for `ngrok.connect()`, and `process.get_process()`. + See [ngrok module](https://pyngrok.readthedocs.io/en/2.1.0/api.html#module-pyngrok.ngrok). +- `auth_token` parameter for `ngrok.connect()`, and `process.get_process()`. + See [ngrok module](https://pyngrok.readthedocs.io/en/2.1.0/api.html#module-pyngrok.ngrok). - Support for `Cygwin` as a platform by having it use the 64-bit Windows binary. ## [2.0.3](https://github.com/alexdlaird/pyngrok/compare/2.0.2...2.0.3) - 2020-02-14 + ### Security + - Only allow instances of `urlopen` to be executed with a `http` request. ## [2.0.2](https://github.com/alexdlaird/pyngrok/compare/2.0.1...2.0.2) - 2020-02-08 + ### Changed + - `DEFAULT_RETRY_COUNT` for use in `installer._download_file()`. ## [2.0.1](https://github.com/alexdlaird/pyngrok/compare/2.0.0...2.0.1) - 2020-02-01 + ### Fixed -- Removed code that could cause a `ModuleNotFoundError` when another module referenced this module in it's `requirements.txt`. + +- Removed code that could cause a `ModuleNotFoundError` when another module referenced this module in + it's `requirements.txt`. ## [2.0.0](https://github.com/alexdlaird/pyngrok/compare/1.4.4...2.0.0) - 2020-01-28 + ### Added + - `api_url` variable to `NgrokProcess` class. - `startup_logs` variable to `NgrokProcess` class. - `startup_error` variable to `NgrokProcess` class. @@ -452,81 +692,115 @@ Python 2.7 support is still needed, pin `pyngrok~=4.1.0`. - `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). ## [1.4.4](https://github.com/alexdlaird/pyngrok/compare/1.4.3...1.4.4) - 2020-01-28 + ### Fixed + - Build improvements. ## [1.4.3](https://github.com/alexdlaird/pyngrok/compare/1.4.2...1.4.3) - 2020-01-13 + ### Fixed + - Build improvements. - Documentation improvements. ## [1.4.2](https://github.com/alexdlaird/pyngrok/compare/1.4.1...1.4.2) - 2019-09-09 + ### Changed + - Bumped PyYAML dependency version. ## [1.4.1](https://github.com/alexdlaird/pyngrok/compare/1.4.0...1.4.1) - 2019-09-09 + ### Fixed -- Issue where arguments passed from the command line to `ngrok` were being dropped (and thus `ngrok help` was always being displayed). + +- Issue where arguments passed from the command line to `ngrok` were being dropped (and thus `ngrok help` was always + being displayed). ## [1.4.0](https://github.com/alexdlaird/pyngrok/compare/1.3.8...1.4.0) - 2019-06-25 + ### Added -- Configurable `timeout` parameter for `ngrok.connect()`, `ngrok.disconnect()`, and `ngrok.get_tunnels()` in [ngrok module](https://pyngrok.readthedocs.io/en/1.4.0/api.html#module-pyngrok.ngrok). + +- Configurable `timeout` parameter for `ngrok.connect()`, `ngrok.disconnect()`, and `ngrok.get_tunnels()` + in [ngrok module](https://pyngrok.readthedocs.io/en/1.4.0/api.html#module-pyngrok.ngrok). - A changelog, code of conduct, and contributing guide. - A pull request template. - Documentation now builds and publishes to [pyngrok.readthedocs.io](https://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). +- `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. ## [1.3.8](https://github.com/alexdlaird/pyngrok/compare/1.3.7...1.3.8) - 2019-06-22 + ### Added -- Configurable `timeout` parameter for [requests to the API](https://pyngrok.readthedocs.io/en/1.3.8/pyngrok.html#pyngrok.ngrok.api_request). -- Configurable `timeout` parameter when `ngrok` is being [downloaded and installed](https://pyngrok.readthedocs.io/en/1.3.8/pyngrok.html#pyngrok.installer.install_ngrok). + +- Configurable `timeout` parameter + for [requests to the API](https://pyngrok.readthedocs.io/en/1.3.8/pyngrok.html#pyngrok.ngrok.api_request). +- Configurable `timeout` parameter when `ngrok` is + being [downloaded and installed](https://pyngrok.readthedocs.io/en/1.3.8/pyngrok.html#pyngrok.installer.install_ngrok). - `PyngrokNgrokURLError`, which is thrown when a request timeout occurs. ### Changed + - Improvements to the bug reports issue template. ## [1.3.7](https://github.com/alexdlaird/pyngrok/compare/1.3.4...1.3.7) - 2019-06-01 + ### 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. + +- 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. ## [1.3.4](https://github.com/alexdlaird/pyngrok/compare/1.3.0...1.3.4) - 2019-05-26 + ### 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. ## [1.3.0](https://github.com/alexdlaird/pyngrok/compare/1.2.0...1.3.0) - 2019-01-20 + ### Added + - `config_path` parameter to `ngrok.disconnect()`. - `ngrok.run()` method for more flexibility in starting `ngrok` programmatically. - `__str__` and `__repr__` methods. @@ -534,26 +808,34 @@ Python 2.7 support is still needed, pin `pyngrok~=4.1.0`. - Code documentation. ## [1.2.0](https://github.com/alexdlaird/pyngrok/compare/1.1.1...1.2.0) - 2019-01-18 + ### Added + - Updates to README with more usage examples. - `ngrok` command line usage via `entry_points` in packaging configuration. - Updates to PyPI categorization. ### Changed + - Improvements to log messages. - Improvements to exception messages. ## [1.1.1](https://github.com/alexdlaird/pyngrok/compare/1.0.0...1.1.1) - 2018-12-19 + ### Added + - Several more specific exceptions to the `exception` module. ### Changed + - Renamed the `ngrokexception` module to `exception`. - Improvements to the README. ### Fixed + - Issues with the Travis CI build. - Issues with `ngrok` binary download/installation. ## [1.0.0](https://github.com/alexdlaird/pyngrok/releases/tag/1.0.0) - 2018-12-18 + - First stable release of `pyngrok`. diff --git a/README.md b/README.md index fe280658..3d44fd3f 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,8 @@ named_tunnel = ngrok.connect(name="my_tunnel_name") ``` The [`connect`](https://pyngrok.readthedocs.io/en/latest/api.html#pyngrok.ngrok.connect) method takes `kwargs` as -well, which allows us to pass additional properties that are [supported by `ngrok`](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config/#tunnel-definitions). +well, which allows us to pass additional properties that +are [supported by `ngrok`](https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config/#tunnel-definitions). This package puts the default `ngrok` binary on our path, so all features of `ngrok` are available on the command line. @@ -63,11 +64,13 @@ available on the command line. ngrok http 80 ``` -For details on how to fully leverage `ngrok` from the command line, see [`ngrok`'s official documentation](https://ngrok.com/docs). +For details on how to fully leverage `ngrok` from the command line, +see [`ngrok`'s official documentation](https://ngrok.com/docs). ## Documentation -For more advanced usage, `pyngrok`'s official documentation is available at [http://pyngrok.readthedocs.io](http://pyngrok.readthedocs.io). +For more advanced usage, `pyngrok`'s official documentation is available +at [http://pyngrok.readthedocs.io](http://pyngrok.readthedocs.io). ### `ngrok` Version Compatibility @@ -76,7 +79,9 @@ For more advanced usage, `pyngrok`'s official documentation is available at [htt ## Contributing -If you would like to get involved, be sure to review the [Contribution Guide](https://github.com/alexdlaird/pyngrok/blob/main/CONTRIBUTING.rst). +If you would like to get involved, be sure to review +the [Contribution Guide](https://github.com/alexdlaird/pyngrok/blob/main/CONTRIBUTING.rst). -Want to contribute financially? If you've found `pyngrok` useful, [sponsorship](https://github.com/sponsors/alexdlaird) would +Want to contribute financially? If you've found `pyngrok` useful, [sponsorship](https://github.com/sponsors/alexdlaird) +would also be greatly appreciated! diff --git a/SECURITY.md b/SECURITY.md index 012b18d8..e7ade104 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -9,7 +9,8 @@ ## Reporting a Vulnerability -If you suspect you have found a security vulnerability, send an email to [contact@alexlaird.com](mailto:contact@alexlaird.com). +If you suspect you have found a security vulnerability, send an email +to [contact@alexlaird.com](mailto:contact@alexlaird.com). Please include a clear and concise description of what the vulnerability is, where it is exposed in the code, and (if known) what best practices might apply to patching it. diff --git a/docs/_html/sitemap-index.xml b/docs/_html/sitemap-index.xml index 4a643a76..9b0ff87f 100644 --- a/docs/_html/sitemap-index.xml +++ b/docs/_html/sitemap-index.xml @@ -1,6 +1,6 @@ +> https://pyngrok.readthedocs.io/en/stable/ weekly diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index 53301b1f..48506bb3 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -1,55 +1,59 @@ {% extends "!layout.html" %} {%- block extrahead %} - {{ super() }} +{{ super() }} - + - - - + + + - - - - - - + + + + + + - - - + + gtag('config', 'UA-43184722-4'); + {% endblock %} {% block footer %} - {{ super() }} - - Fork me on GitHub - -
This page uses - Google Analytics to collect statistics. You can disable it by blocking - the JavaScript coming from www.google-analytics.com. - -
+{{ super() }} + + Fork me on GitHub + +
This page uses + Google Analytics to collect statistics. You can disable it by blocking + the JavaScript coming from www.google-analytics.com. + +
{% endblock %} diff --git a/docs/_templates/sidebartoc.html b/docs/_templates/sidebartoc.html index 35b8f947..7878ced0 100644 --- a/docs/_templates/sidebartoc.html +++ b/docs/_templates/sidebartoc.html @@ -2,26 +2,28 @@

Getting Around

  • Basic Usage
    • -
  • Dive Deeper +
  • Dive Deeper
    • diff --git a/pyngrok/conf.py b/pyngrok/conf.py index 9d490683..5e6ca52f 100644 --- a/pyngrok/conf.py +++ b/pyngrok/conf.py @@ -3,7 +3,7 @@ import os import platform -from typing import Optional, Callable +from typing import Callable, Optional from pyngrok.installer import get_ngrok_bin from pyngrok.log import NgrokLog diff --git a/pyngrok/exception.py b/pyngrok/exception.py index 8903b495..6fbbe272 100644 --- a/pyngrok/exception.py +++ b/pyngrok/exception.py @@ -1,7 +1,7 @@ __copyright__ = "Copyright (c) 2018-2024 Alex Laird" __license__ = "MIT" -from typing import Any, Optional, List +from typing import Any, List, Optional from pyngrok.log import NgrokLog diff --git a/pyngrok/installer.py b/pyngrok/installer.py index 920ef17a..0caede31 100644 --- a/pyngrok/installer.py +++ b/pyngrok/installer.py @@ -16,7 +16,7 @@ import yaml -from pyngrok.exception import PyngrokNgrokInstallError, PyngrokSecurityError, PyngrokError +from pyngrok.exception import PyngrokError, PyngrokNgrokInstallError, PyngrokSecurityError logger = logging.getLogger(__name__) diff --git a/pyngrok/ngrok.py b/pyngrok/ngrok.py index 0700d050..3ea67165 100644 --- a/pyngrok/ngrok.py +++ b/pyngrok/ngrok.py @@ -10,14 +10,14 @@ import sys import uuid from http import HTTPStatus -from typing import Optional, Any, Dict, List, Tuple +from typing import Any, Dict, List, Optional, Tuple from urllib.error import HTTPError, URLError from urllib.parse import urlencode -from urllib.request import urlopen, Request +from urllib.request import Request, urlopen -from pyngrok import process, conf, installer, __version__ +from pyngrok import __version__, conf, installer, process from pyngrok.conf import PyngrokConfig -from pyngrok.exception import PyngrokNgrokHTTPError, PyngrokNgrokURLError, PyngrokSecurityError, PyngrokError +from pyngrok.exception import PyngrokError, PyngrokNgrokHTTPError, PyngrokNgrokURLError, PyngrokSecurityError from pyngrok.installer import get_default_config from pyngrok.process import NgrokProcess diff --git a/pyngrok/process.py b/pyngrok/process.py index 6f28c2e7..fa56f9e0 100644 --- a/pyngrok/process.py +++ b/pyngrok/process.py @@ -8,14 +8,14 @@ import threading import time from http import HTTPStatus -from typing import Dict, List, Optional, Any +from typing import Any, Dict, List, Optional from urllib.request import Request, urlopen import yaml from pyngrok import conf, installer from pyngrok.conf import PyngrokConfig -from pyngrok.exception import PyngrokNgrokError, PyngrokSecurityError, PyngrokError +from pyngrok.exception import PyngrokError, PyngrokNgrokError, PyngrokSecurityError from pyngrok.installer import SUPPORTED_NGROK_VERSIONS from pyngrok.log import NgrokLog diff --git a/tests/test_installer.py b/tests/test_installer.py index 4a2351b7..a8d52352 100644 --- a/tests/test_installer.py +++ b/tests/test_installer.py @@ -5,9 +5,9 @@ import socket from unittest import mock -from pyngrok import ngrok, installer, conf +from pyngrok import conf, installer, ngrok from pyngrok.conf import PyngrokConfig -from pyngrok.exception import PyngrokNgrokInstallError, PyngrokSecurityError, PyngrokError +from pyngrok.exception import PyngrokError, PyngrokNgrokInstallError, PyngrokSecurityError from tests.testcase import NgrokTestCase diff --git a/tests/test_ngrok.py b/tests/test_ngrok.py index 5c6c58c7..9ef3bc5f 100644 --- a/tests/test_ngrok.py +++ b/tests/test_ngrok.py @@ -12,10 +12,9 @@ import yaml -from pyngrok import __version__ -from pyngrok import ngrok, process, installer -from pyngrok.exception import PyngrokNgrokHTTPError, PyngrokNgrokURLError, PyngrokSecurityError, PyngrokError, \ - PyngrokNgrokError +from pyngrok import __version__, installer, ngrok, process +from pyngrok.exception import PyngrokError, PyngrokNgrokError, PyngrokNgrokHTTPError, PyngrokNgrokURLError, \ + PyngrokSecurityError from tests.testcase import NgrokTestCase diff --git a/tests/test_process.py b/tests/test_process.py index 81ea535b..f314bed1 100644 --- a/tests/test_process.py +++ b/tests/test_process.py @@ -9,7 +9,7 @@ from urllib.parse import urlparse from urllib.request import urlopen -from pyngrok import process, installer, conf, ngrok +from pyngrok import conf, installer, ngrok, process from pyngrok.exception import PyngrokNgrokError from pyngrok.process import NgrokLog from tests.testcase import NgrokTestCase diff --git a/tests/testcase.py b/tests/testcase.py index 5d92b4ba..4bf65636 100644 --- a/tests/testcase.py +++ b/tests/testcase.py @@ -13,8 +13,7 @@ import psutil from psutil import AccessDenied, NoSuchProcess -from pyngrok import ngrok, installer, conf -from pyngrok import process +from pyngrok import conf, installer, ngrok, process from pyngrok.conf import PyngrokConfig logger = logging.getLogger(__name__)