From d7729708350d97af249d08fe9d3477132e7e4ce8 Mon Sep 17 00:00:00 2001 From: tripleee Date: Mon, 23 Oct 2023 21:06:06 +0300 Subject: [PATCH] README.md: No longer advertise this as Python 2 compatible Also, clean up formatting somewhat and remove old commentary --- README.md | 43 +++++++++++++++++++++++++++---------------- 1 file changed, 27 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 8fb7ac2..1a6a36d 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,29 @@ ChatExchange ============ -[![Github Actions build status for master](https://github.com/Manishearth/ChatExchange/actions/workflows/lint+test.yml/badge.svg)](https://github.com/Manishearth/ChatExchange/actions) +[![Github Actions build status for master][1]][2] -A Python2 and Python3 cross-version API for talking to Stack Exchange chat. + [1]: https://github.com/Manishearth/ChatExchange/actions/workflows/lint+test.yml/badge.svg + [2]: https://github.com/Manishearth/ChatExchange/actions - - Supported Python versions (Travis CI build run for each of these): - `2.7`, `3.4`, `3.5`, `3.6`, `3.7-dev`, `nightly` - - Unclear versions (not run on Travis CI as `pytest` does not support them): - `2.6`, `3.2`, `3.3` +A Python3 API for talking to Stack Exchange chat. + + - Supported Python versions (tests run by Github Actions): + 3.7, 3.8, 3.9, 3.10, 3.11, 3.12 + - Unclear versions (not run on Github Actions + as Github no longer supports them): + 2.7 (sic), 3.4, 3.5, 3.6 ## Dependencies -**Make sure you use either `pip2` or `pip3` depending on which Python version you want to run this on.** +`pip install chatexchange` pulls in the following libraries: - BeautifulSoup (`pip install beautifulsoup4`) - - Requests (`pip install requests`). Usually there by default. Please upgrade it with `pip install requests --upgrade` - *Note that Ubuntu comes with an old version of `pip` that is not compatible any more with the latest version of `requests`. It will be broken after you installed `requests`, except if you update it before (or afterwards) with `easy_install pip` or `pip install --upgrade pip` (that one works only before).* - - python-websockets for the experimental websocket listener (`pip install websocket-client`). This module is optional, without it `initSocket()` from SEChatBrowser will not work + - Requests (`pip install requests`) + - python-websockets for the experimental websocket listener + (`pip install websocket-client`). + This module is optional; without it, `initSocket()` from SEChatBrowser + will not work. The package has a number of additional development requirements; install them with @@ -28,7 +34,9 @@ or `.[dev]` if you are in the top directory of a local copy of the source. ## Shortcuts -1. `make install-dependencies` will install the necessary Python package dependencies into your current environment (active virtualenv or system site packages) +1. `make install-dependencies` will install the necessary + Python package dependencies into your current environment + (active virtualenv or system site packages) 2. `make test` will run the tests 3. `make run-example` will run the example script 4. `make` will run the above three in order @@ -37,13 +45,16 @@ or `.[dev]` if you are in the top directory of a local copy of the source. Licensed under either of - * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) - * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) + or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) + or http://opensource.org/licenses/MIT) at your option. ### Contribution -Unless you explicitly state otherwise, any contribution intentionally submitted -for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any -additional terms or conditions. +Unless you explicitly state otherwise, any contribution +intentionally submitted for inclusion in the work by you, +as defined in the Apache-2.0 license, shall be dual licensed as above, +without any additional terms or conditions.