Skip to content

Commit 6bc6c74

Browse files
committed
Update README, bumpr, and package.json
bumpr does not properly support package.json files, creating a non-semver compliant version. Updated the README to list compability with Flask applications post 0.5.0 release. Bumped package.json manually for release.
1 parent d7a1ca8 commit 6bc6c74

File tree

3 files changed

+26
-2
lines changed

3 files changed

+26
-2
lines changed

README.rst

+25
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,31 @@ Compatibility
4040

4141
Flask-RESTX requires Python 2.7 or 3.4+.
4242

43+
On Flask Compatibility
44+
======================
45+
46+
Flask and Werkzeug moved to versions 2.0 in March 2020. This caused a breaking change in Flask-RESTX.
47+
48+
.. list-table:: RESTX and Flask / Werkzeug Compatibility
49+
:widths: 25 25 25
50+
:header-rows: 1
51+
52+
53+
* - Flask-RESTX version
54+
- Flask version
55+
- Note
56+
* - <= 0.3.0
57+
- < 2.0.0
58+
- unpinned in Flask-RESTX. Pin your projects!
59+
* - == 0.4.0
60+
- < 2.0.0
61+
- pinned in Flask-RESTX.
62+
* - >= 0.5.0
63+
- All (For Now)
64+
- unpinned, import statements wrapped for compatibility
65+
* - trunk branch in Github
66+
- All (and updated more often)
67+
- unpinned, will address issues faster than releases.
4368

4469
Installation
4570
============

bumpr.rc

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ clean =
99
inv clean
1010
files =
1111
README.rst
12-
package.json
1312

1413
[bump]
1514
unsuffix = true

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "flask-restx",
3-
"version": "0.4.1-dev",
3+
"version": "0.5.0",
44
"description": "Fully featured framework for fast, easy and documented API development with Flask",
55
"repository": "python-restx/flask-restx",
66
"keywords": [

0 commit comments

Comments
 (0)