diff --git a/MANIFEST.in b/MANIFEST.in index 0fd999a8..37facf1b 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -6,6 +6,7 @@ recursive-include docs Makefile make.bat conf.py *.rst # Miscellaneous assets include LICENSE +include NEWS include README.rst include pytest.ini include tox.ini diff --git a/NEWS b/NEWS index 5e7677b2..4044afae 100644 --- a/NEWS +++ b/NEWS @@ -1,6 +1,48 @@ w3lib release notes =================== +2.0.0 (to be released) +---------------------- + +Backwards incompatible changes: + +- Python 2 is no longer supported; Python 3.6+ is required now (#168, #175). +- :func:`w3lib.url.safe_url_string` and :func:`w3lib.url.canonicalize_url` + no longer convert "%23" to "#" when it appears in the URL path. This is a bug + fix. It's listed as a backward-incomatible change because in some cases the + output of :func:`w3lib.url.canonicalize_url` is going to change, and so, if + this output is used to generate URL fingerprints, new fingerprints might be + incompatible with those created with the previous w3lib versions + (#141). + +Deprecation removals (#169): + +- The ``w3lib.form`` module is removed. +- The ``w3lib.html.remove_entities`` function is removed. +- The ``w3lib.url.urljoin_rfc`` function is removed. + +The following functions are deprecated, and will be removed in future releases +(#170): + +- ``w3lib.util.str_to_unicode`` +- ``w3lib.util.unicode_to_str`` +- ``w3lib.util.to_native_str`` + +Other improvements and bug fixes: + +- Type annotations are added (#172, #184). +- Added support for Python 3.9 and 3.10 (#168, #176). +- Fixed :func:`w3lib.html.get_meta_refresh` for ```` tags where + ``http-equiv`` is written after ``content`` (#179). +- Fixed :func:`w3lib.url.safe_url_string` for IDNA domains with ports (#174). +- :func:`w3lib.url.url_query_cleaner` no longer adds an unneeded ``#`` when + ``keep_fragments=True`` is passed, and the URL doesn't have a fragment + (#159). +- Removed a workaround for an ancient pathname2url bug (#142) +- CI is migrated to GitHub Actions (#166, #177); other CI improvements (#160, + #182). +- The code is formatted using black (#173). + 1.22.0 (2020-05-13) -------------------