[script.module.websocket] v1.6.4

script.module.websocket/CONTRIBUTING.md

@@ -24,6 +24,8 @@ If you did not get your question answered from these 5 steps, then please open a
 new issue and ask your question! When you explain your problem, please:
 - [ ] [Enable the tracing feature](https://websocket-client.readthedocs.io/en/latest/examples.html#debug-and-logging-options)
 and include the entire debug trace of your connection process in the issue
+- [ ] Provide a [minimum reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)
+program to allow other users to recreate and demonstrate the error
 - [ ] Add an explanation for what you are trying to accomplish. If you can
 provide your code (or example code) in the issue, this helps a lot!
 
@@ -46,9 +48,9 @@ problem with the current code and test your solution (if possible to recreate).
 Great! To edit the [project documentation](https://websocket-client.readthedocs.io),
 it is recommended that you install Sphinx and build the updated documentation
 locally before submitting your edits. The Sphinx dependencies can be
-installed by navigating to the `docs/source` directory and running `pip install
--r requirements.txt`. To build a new version of the documentation, change
-directories (or `cd`) to the `docs/` directory and run `make clean html`.
+installed by navigating to the `docs/source` directory and running
+`pip3 install -r requirements.txt`. To build a new version of the documentation,
+change directories (or `cd`) to the `docs/` directory and run `make clean html`.
 Any build warnings or errors will be displayed in your terminal, and the new
 documentation will then be available in the `docs/build/html/` directory.
 You may also find the

script.module.websocket/ChangeLog

@@ -1,6 +1,148 @@
 ChangeLog
 ============
 
+- 1.6.4
+  - Fix #952, add support for HTTP 307 and 308 redirect codes (69468ad)
+
+- 1.6.3
+  - Fix type hints issues (#949)
+  - Add support for Python beta release 3.12 in CI (#946)
+  - Add maintainer email in setup.py (3d464fc)
+
+- 1.6.2
+  - Add support for SSLKEYLOGFILE environment variable (#943)
+  - Add support for callable header arguments (#932)
+  - Change handling of proxy environment variables, is_secure set to true now prevents http_proxy from getting used (#929)
+
+- 1.6.1
+  - Fix Dispatcher keyboard interrupt. Should solve reconnect loop with rel (#924)
+
+- 1.6.0
+  - Fix teardown issue when ping thread is not properly ended (#918)
+  - Fix double ping wait time on first ping (#912)
+  - Minor type hints improvements (eda6724, 54b3013)
+
+- 1.5.3
+  - Add logic to avoid error in the case where content-length header does not exist, bug introduced in 1.5.2 (#911)
+  - Fix wsdump.py script typing, bug introduced in 1.5.2 (#914)
+
+- 1.5.2
+  - Add type hints (#908)
+  - Fix pytype errors (#906)
+  - Fix args passed to logging function (#898)
+  - Standardize PEP 3101 formatting (c6a445f)
+  - Add more verbose exception for unsuccessful handshake for #900 (f85ae1f)
+
+- 1.5.1
+  - Fix logic bug that can cause disconnects (#893)
+
+- 1.5.0
+  - Refactor and improve ping/pong logic to resolve several issues, including an infinite loop issue during reconnect (#862)
+  - Fix issue where `skip_utf8_validation = True` is ignored (#886)
+  - Fix issue where sslopt `is_ssl` is ignored (#875)
+  - Downgrade "websocket connected" message from logging.warning to logging.info (#888)
+  - Update github actions to newer versions (669fe1b)
+
+- 1.4.2
+  - create_dispatcher is determined by URL ws/wss, NOT by presence of sslopt args, to maintain consistency (#875)
+  - Remove redundant key generation line (#864)
+  - Updated docs to fix old links and updated CI to include Python 3.11
+
+- 1.4.1
+  - Fix stack growth bug when `run_forever` reconnects (#854)
+  - Add doctest CI for sphinx docs code examples (d150099)
+  - General docs improvements
+
+- 1.4.0
+  - Fix automatic reconnect with `run_forever` (#838)
+  - Allow a timeout to be set when using a proxy (#842)
+
+- 1.3.3
+  - Fix unclosed socket error (#826)
+  - Update header dict access (#818)
+  - Add utf8 workaround to docs (fc9ee9f)
+
+- 1.3.2
+  - Add support for pre-initialized stream socket in new WebSocketApp (#804)
+  - Remove rel.saferead() in examples (f0bf03d)
+  - Increase scope of linting checks (dca4022)
+  - Start adding type hints (a8a4099)
+
+- 1.3.1
+  - Fix 10 year old bug and improve dispatcher handling for run_forever (#795)
+  - Fix run_forever to never return None, only return True or False, and add two tests (#788)
+  - Remove Python 3.6 support, EOL in Dec 2021
+
+- 1.3.0
+  - BREAKING: Set Origin header to use https:// scheme when wss:// WebSocket URL is passed (#787)
+  - Replace deprecated/broken WebSocket URLs with working ones (6ad5197)
+  - Add documentation referencing rel for automatic reconnection with run_forever()
+  - Add missing opcodes 1012, 1013 (#771)
+  - Add errno.ENETUNREACH to improve error handling (da1b050)
+  - Minor documentation improvements and typo fixes
+
+- 1.2.3
+  - Fix broken run_forever() functionality (#769)
+
+- 1.2.2
+  - Migrate wsdump script in setup.py from scripts to newer entry_points (#763)
+  - Add support for ssl.SSLContext for arbitrary SSL parameters (#762)
+  - Remove keep_running variable (#752)
+  - Remove HAVE_CONTEXT_CHECK_HOSTNAME variable (dac1692)
+  - Replace deprecated ssl.PROTOCOL_TLS with ssl.PROTOCOL_TLS_CLIENT (#760)
+  - Simplify code and improve Python 3 support (#751, #750, #746)
+  - Fill default license template fields (#748)
+  - Update CI tests
+  - Improve documentation (#732, #733, #734, #737, #766, #768)
+
+- 1.2.1
+  - Fix python-socks dependency issue mentioned in #728
+  - Replace echo.websocket.org with a local websockets echo server for unit tests (4951de2)
+
+- 1.2.0
+  - Fix #697, #665: Transition from LGPL 2.1 license to Apache 2.0 license
+  - Revert #417 and reimplement SOCKS proxy support with python-socks instead of PySocks (fbcbd43)
+
+- 1.1.1
+  - Fix #377: increase exception verbosity in _app.py callback exception
+  - Fix #717: race condition during connection close
+  - Fix #722: improve handling where credentials include symbols like @
+  - Fix #711: improve handling if ssl is None
+
+- 1.1.0
+  - Set enable_multithread to True by default (beb135a)
+  - Performance improvement in _mask() function (287970e, #433)
+  - Performance improvement in recv_strict() function (60e4711, #255)
+  - Performance improvement by removing numpy-related code (a462d45)
+  - Support uppercase no_proxy, http_proxy, https_proxy env vars (150df4f, #700)
+  - Add sslopt 'server_hostname' support (#698)
+  - Replace deprecated ssl.PROTOCOL_SSLv23 with ssl.PROTOCOL_TLS (494564f)
+  - Update documentation, README (7c9d604, #704)
+
+- 1.0.1
+ - Fix exception handling bug #694
+
+- 1.0.0
+
+ - Removed Python 2 code, now only Python 3 compatible (d45343b, b7c5733, ff67af8)
+ - Use semver for release versions, unlike breaking release 0.58.0 (#669)
+ - Enhance enableTrace output (13e83b4)
+ - Improve unit tests to over 80% code coverage (1679ab0, a00dd2d, etc.)
+ - Fix old _app.py close status code bug (resulted in on_close() requiring 3 args) (#686)
+ - Replace select import with selectors (#568)
+
+- 0.59.0
+
+ - Last main release to support Python 2
+ - Fix Python 2 urlparse scheme (#332)
+ - Add support for headers with multiple values (#627)
+ - Add debug support for reserved custom status codes (#639)
+ - Allow multiple Set-Cookie: headers (#649)
+ - Simplified cookie sorting (#662)
+ - Add no_proxy support (#671)
+ - Add Host header to HTTP proxy request (#677)
+ - Improve PEP8 style compliance (dc3f5c4)
+
 - 0.58.0
 
  - Fix README typos (#659)