Skip to content

Commit

Permalink
Prepare release 1.3.0 (#584)
Browse files Browse the repository at this point in the history
* Prepare for 1.3.0 release with flask 3.0.0 support.

---------

Co-authored-by: Peter Doggart <[email protected]>
  • Loading branch information
peter-doggart and Peter Doggart authored Dec 10, 2023
1 parent 25cb897 commit 0c44114
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 12 deletions.
13 changes: 9 additions & 4 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ Releases prior to 0.3.0 were “best effort” filled out, but are missing
some info. If you see your contribution missing info, please open a PR
on the Changelog!

.. _section-1.2.1:
1.2.1
.. _section-1.3.0:
1.3.0
-----
.. _bug_fixes-1.2.1
.. _bug_fixes-1.3.0
Bug Fixes
~~~~~~~~~

Expand All @@ -37,7 +37,12 @@ Bug Fixes
* Fixing werkzeug 3 deprecated version import. Import is replaced by new style version check with importlib (#573) [Ryu-CZ]
* Fixing flask 3.0+ compatibility of `ModuleNotFoundError: No module named 'flask.scaffold'` Import error. (#567) [Ryu-CZ]
* Fix wrong status code and message on responses when handling `HTTPExceptions` (#569) [lkk7]

* Add flask 2 and flask 3 to testing matrix. [foarsitter]
* Update internally pinned pytest-flask to 1.3.0 for Flask >=3.0.0 support. [peter-doggart]
* Python 3.12 support. [foarsitter]
* Fix wrong status code and message on responses when handling HTTPExceptions. [ikk7]
* Update changelog Flask version table. [peter-doggart]
* Remove temporary package version restrictions for flask < 3.0.0, werkzeug and jsonschema (jsonschema future deprecation warning remains. See #553). [peter-doggart]

.. _section-1.2.0:
1.2.0
Expand Down
8 changes: 7 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,14 @@ Flask and Werkzeug moved to versions 2.0 in March 2020. This caused a breaking c
* - >= 0.5.0
- < 3.0.0
- unpinned, import statements wrapped for compatibility
* - == 1.2.0
- < 3.0.0
- pinned in Flask-RESTX.
* - >= 1.3.0
- >= 2.0.0 (Flask >= 3.0.0 support)
- unpinned, import statements wrapped for compatibility
* - trunk branch in Github
- < 3.0.0 (Flask >=3.0.0 support is in progress, see https://github.com/python-restx/flask-restx/issues/566)
- >= 2.0.0 (Flask >= 3.0.0 support)
- unpinned, will address issues faster than releases.

Installation
Expand Down
2 changes: 1 addition & 1 deletion doc/swagger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -757,7 +757,7 @@ Documenting authorizations
You can use the ``authorizations`` keyword argument to document authorization information.
See `Swagger Authentication documentation <https://swagger.io/docs/specification/2-0/authentication/>`_
for configuration details.
- ``authorizations`` is a Python dictionary representation of the Swagger ``securityDefinitions`` configuration.
- ``authorizations`` is a Python dictionary representation of the Swagger ``securityDefinitions`` configuration.

.. code-block:: python
Expand Down
8 changes: 7 additions & 1 deletion flask_restx/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,13 @@
from .postman import PostmanCollectionV1
from .resource import Resource
from .swagger import Swagger
from .utils import default_id, camel_to_dash, unpack, import_check_view_func, BaseResponse
from .utils import (
default_id,
camel_to_dash,
unpack,
import_check_view_func,
BaseResponse,
)
from .representations import output_json
from ._http import HTTPStatus

Expand Down
1 change: 1 addition & 0 deletions flask_restx/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ def import_werkzeug_response():

BaseResponse = import_werkzeug_response()


class FlaskCompatibilityWarning(DeprecationWarning):
pass

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": "1.1.0",
"version": "1.3.0",
"description": "Fully featured framework for fast, easy and documented API development with Flask",
"repository": "python-restx/flask-restx",
"keywords": [
Expand Down
6 changes: 3 additions & 3 deletions requirements/install.pip
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
aniso8601>=0.82
jsonschema<=4.17.3
Flask>=0.8, !=2.0.0, <3.0.0
werkzeug!=2.0.0, <3.0.0
jsonschema
Flask>=0.8, !=2.0.0
werkzeug!=2.0.0
pytz
importlib_resources
2 changes: 1 addition & 1 deletion requirements/test.pip
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ mock==3.0.5
pytest==7.0.1
pytest-benchmark==3.4.1
pytest-cov==4.0.0
pytest-flask==1.2.0
pytest-flask==1.3.0
pytest-mock==3.6.1
pytest-profiling==1.7.0
tzlocal
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ def pip(filename):
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: Implementation :: PyPy",
"Topic :: Software Development :: Libraries :: Python Modules",
"License :: OSI Approved :: BSD License",
Expand Down

0 comments on commit 0c44114

Please sign in to comment.