Skip to content

Commit

Permalink
Update README, bumpr, and package.json
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
j5awry committed Jul 19, 2021
1 parent d7a1ca8 commit 6bc6c74
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
25 changes: 25 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,31 @@ Compatibility

Flask-RESTX requires Python 2.7 or 3.4+.

On Flask Compatibility
======================

Flask and Werkzeug moved to versions 2.0 in March 2020. This caused a breaking change in Flask-RESTX.

.. list-table:: RESTX and Flask / Werkzeug Compatibility
:widths: 25 25 25
:header-rows: 1


* - Flask-RESTX version
- Flask version
- Note
* - <= 0.3.0
- < 2.0.0
- unpinned in Flask-RESTX. Pin your projects!
* - == 0.4.0
- < 2.0.0
- pinned in Flask-RESTX.
* - >= 0.5.0
- All (For Now)
- unpinned, import statements wrapped for compatibility
* - trunk branch in Github
- All (and updated more often)
- unpinned, will address issues faster than releases.

Installation
============
Expand Down
1 change: 0 additions & 1 deletion bumpr.rc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ clean =
inv clean
files =
README.rst
package.json

[bump]
unsuffix = true
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "flask-restx",
"version": "0.4.1-dev",
"version": "0.5.0",
"description": "Fully featured framework for fast, easy and documented API development with Flask",
"repository": "python-restx/flask-restx",
"keywords": [
Expand Down

0 comments on commit 6bc6c74

Please sign in to comment.