summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLeonard Richardson <leonardr@segfault.org>2019-10-06 10:02:07 -0400
committerLeonard Richardson <leonardr@segfault.org>2019-10-06 10:02:07 -0400
commit5b7212298f17a6c3c33f79b49e36a730b45fd19d (patch)
tree5b104dcaa129aa1b79666daf29a4afc18299132d /README.md
parent24fca77a9e156ec77f1bec115199c9be176edcc2 (diff)
Added section on Python 2 sunsetting.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/README.md b/README.md
index e7d1b56..b84f237 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,20 @@ To go beyond the basics, [comprehensive documentation is available](http://www.c
* [Bug tracker](https://bugs.launchpad.net/beautifulsoup/)
* [Complete changelog](https://bazaar.launchpad.net/~leonardr/beautifulsoup/bs4/view/head:/CHANGELOG)
+# Note on Python 2 sunsetting
+
+Since 2012, Beautiful Soup has been developed as a Python 2 library
+which is automatically converted to Python 3 code as necessary. This
+makes it impossible to take advantages of some features of Python
+3.
+
+For this reason, I plan to discontinue Beautiful Soup's Python 2
+support at some point after January 1, 2021: one year after the sunset
+date for Python 2 itself. Beyond that point, new Beautiful Soup
+development will exclusively target Python 3. Of course, older
+releases of Beautiful Soup, which support both versions, will continue
+to be available.
+
# Supporting the project
If you use Beautiful Soup as part of your professional work, please consider a
@@ -79,10 +93,10 @@ Beautiful Soup supports unit test discovery from the project root directory:
```
```
- $ python -m unittest discover -s bs4 # Python 2.7 and up
+ $ python -m unittest discover -s bs4
```
If you checked out the source tree, you should see a script in the
home directory called test-all-versions. This script will run the unit
-tests under Python 2.7, then create a temporary Python 3 conversion of
+tests under Python 2, then create a temporary Python 3 conversion of
the source and run the unit tests again under Python 3.