Merge branch 'oauth-redirect' of github.com:thedumbterminal/flask-restx into oauth-redirect

Author: thedumbterminal

.github/workflows/black.yml

@@ -0,0 +1,10 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable

.github/workflows/test.yml

@@ -10,55 +10,25 @@ on:
     - cron: "0 1 * * *"
   workflow_dispatch:
 jobs:
-  checks:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v1
-        with:
-          python-version: 3.8
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install ".[dev]"
-      - name: Audit Python packages for known vulnerabilities
-        run: |
-          if ! RES=$(ossaudit --installed --config setup.cfg); then
-            RES="${RES//'%'/'%25'}"
-            RES="${RES//$'\n'/'%0A'}"
-            RES="${RES//$'\r'/'%0D'}"
-            echo "::error ::${RES}"
-            exit 1
-          fi
-          echo ${RES}
-      - name: Format with black
-        run: |
-          if ! RES=$(black --check $(git diff --name-only --diff-filter=AM master -- "*.py") 2>&1); then
-            RES="${RES//'%'/'%25'}"
-            RES="${RES//$'\n'/'%0A'}"
-            RES="${RES//$'\r'/'%0D'}"
-            echo "::error ::${RES}"
-            exit 1
-          fi
-          echo ${RES}
   unit-tests:
-    needs: checks
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        python-version: [2.7, 3.5, 3.6, 3.7, 3.8, pypy2, pypy3]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "pypy3.8", "3.12"]
+        flask: ["<3.0.0", ">=3.0.0"]
     steps:
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
+          pip install "flask${{ matrix.flask }}"
           pip install ".[test]"
       - name: Test with inv
         run: inv cover qa
@@ -72,16 +42,16 @@ jobs:
     if: github.event_name == 'pull_request'
     steps:
       - name: Set up Python 3.8
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: "3.8"
       - name: Checkout ${{ github.base_ref }}
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: ${{ github.base_ref}}
           path: base
       - name: Checkout ${{ github.ref }}
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: ${{ github.ref}}
           path: ref

CHANGELOG.rst

@@ -25,6 +25,143 @@ 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.3.1:
+1.3.1
+-----
+.. _bug_fixes-1.3.1
+Bug Fixes
+~~~~~~~~~
+
+::
+
+   * Add python version requirement on setup.py (#586) [jason-the-j]
+
+
+.. _section-1.3.0:
+1.3.0
+-----
+.. _bug_fixes-1.3.0
+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
+-----
+.. _bug_fixes-1.2.0
+Bug Fixes
+~~~~~~~~~
+
+::
+
+   * Fixing test as HTTP Header MIMEAccept expects quality-factor number in form of `X.X` (#547) [chipndell]
+   * Introduce temporary restrictions on some package versions. (`flask<3.0.0`, `werkzeug<3.0.0`, `jsonschema<=4.17.3`) [peter-doggart]
+
+
+.. _enhancements-1.2.0:
+
+Enhancements
+~~~~~~~~~~~~
+
+::
+
+   * Drop support for python 3.7
+
+
+.. _section-1.1.0:
+1.1.0
+-----
+
+.. _bug_fixes-1.1.0
+Bug Fixes
+~~~~~~~~~
+
+::
+
+   * Update Swagger-UI to latest version to fix several security vulnerabiltiies. [peter-doggart]
+   * Add a warning to the docs that nested Blueprints are not supported. [peter-doggart]
+   * Add a note to the docs that flask-restx always registers the root (/) path. [peter-doggart]
+
+.. _section-1.0.6:
+1.0.6
+-----
+
+.. _bug_fixes-1.0.6
+Bug Fixes
+~~~~~~~~~
+
+::
+
+   * Update Black to 2023 version [peter-doggart]
+   * Fix minor bug introduced in 1.0.5 that changed the behaviour of how flask-restx propagates exceptions. (#512) [peter-doggart]
+   * Update PyPi classifer to Production/Stable. [peter-doggart]
+   * Add support for Python 3.11 (requires update to invoke ^2.0.0) [peter-doggart]
+
+.. _section-1.0.5:
+1.0.5
+-----
+
+.. _bug_fixes-1.0.5
+Bug Fixes
+~~~~~~~~~
+
+::
+
+   * Fix failing pypy python setup in github actions
+   * Fix compatibility with upcoming release of Flask 2.3+. (#485) [jdieter]
+
+.. _section-1.0.2:
+1.0.2
+-----
+
+.. _bug_fixes-1.0.2
+Bug Fixes
+~~~~~~~~~
+
+::
+
+   * Properly remove six dependency
+
+.. _section-1.0.1:
+1.0.1
+-----
+
+.. _breaking-1.0.1
+
+Breaking
+~~~~~~~~
+
+Starting from this release, we only support python versions >= 3.7
+
+.. _bug_fixes-1.0.1
+
+Bug Fixes
+~~~~~~~~~
+
+::
+
+   * Fix compatibility issue with werkzeug 2.1.0 (#423) [stacywsmith]
+
+.. _enhancements-1.0.1:
+
+Enhancements
+~~~~~~~~~~~~
+
+::
+
+   * Drop support for python <3.7
+
 .. _section-0.5.1:
 0.5.1
 -----
@@ -79,7 +216,7 @@ Bug Fixes
 
 ::
 
-   * Fix Namespace error handlers when propogate_exceptions=True (#285) [mjreiss]
+   * Fix Namespace error handlers when propagate_exceptions=True (#285) [mjreiss]
    * pin flask and werkzeug due to breaking changes (#308) [jchittum]
    * The Flask/Blueprint API moved to the Scaffold base class (#308) [jloehel]
 

README.rst

@@ -38,7 +38,7 @@ and expose its documentation properly using `Swagger`_.
 Compatibility
 =============
 
-Flask-RESTX requires Python 2.7 or 3.4+.
+Flask-RESTX requires Python 3.8+.
 
 On Flask Compatibility
 ======================
@@ -60,10 +60,16 @@ Flask and Werkzeug moved to versions 2.0 in March 2020. This caused a breaking c
       - < 2.0.0
       - pinned in Flask-RESTX.
     * - >= 0.5.0
-      - All (For Now)
+      - < 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
-      - All (and updated more often)
+      - >= 2.0.0 (Flask >= 3.0.0 support)
       - unpinned, will address issues faster than releases.
 
 Installation
@@ -189,7 +195,8 @@ Contributors
 
 Flask-RESTX is brought to you by @python-restx. Since early 2019 @SteadBytes,
 @a-luna, @j5awry, @ziirish volunteered to help @python-restx keep the project up
-and running.
+and running, they did so for a long time! Since the beginning of 2023, the project
+is maintained by @peter-doggart with help from @ziirish.
 Of course everyone is welcome to contribute and we will be happy to review your
 PR's or answer to your issues.
 

doc/conf.py

@@ -51,8 +51,8 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"Flask-RESTX"
-copyright = u"2020, python-restx Authors"
+project = "Flask-RESTX"
+copyright = "2020, python-restx Authors"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -124,7 +124,11 @@
     "show_related": True,
     "page_width": "1000px",
     "sidebar_width": "260px",
-    "favicons": {64: "favicon-64.png", 128: "favicon-128.png", 196: "favicon-196.png",},
+    "favicons": {
+        64: "favicon-64.png",
+        128: "favicon-128.png",
+        196: "favicon-196.png",
+    },
     "badges": [
         (
             # Gitter.im
@@ -262,8 +266,8 @@
     (
         "index",
         "Flask-RESTX.tex",
-        u"Flask-RESTX Documentation",
-        u"python-restx Authors",
+        "Flask-RESTX Documentation",
+        "python-restx Authors",
         "manual",
     ),
 ]
@@ -294,7 +298,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ("index", "flask-restx", u"Flask-RESTX Documentation", [u"python-restx Authors"], 1)
+    ("index", "flask-restx", "Flask-RESTX Documentation", ["python-restx Authors"], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -310,8 +314,8 @@
     (
         "index",
         "Flask-RESTX",
-        u"Flask-RESTX Documentation",
-        u"python-restx Authors",
+        "Flask-RESTX Documentation",
+        "python-restx Authors",
         "Flask-RESTX",
         "One line description of project.",
         "Miscellaneous",

doc/index.rst

@@ -33,13 +33,13 @@ development and to support our users.
 Compatibility
 =============
 
-flask-restx requires Python 2.7+ or 3.4+.
+Flask-RESTX requires Python 3.8+.
 
 
 Installation
 ============
 
-You can install flask-restx with pip:
+You can install Flask-RESTX with pip:
 
 .. code-block:: console
 

doc/installation.rst

@@ -20,5 +20,5 @@ The development version can be downloaded from
     pip install -e .[dev,test]
 
 
-Flask-RESTX requires Python version 2.7, 3.5, 3.6, 3.7, or 3.8.
+Flask-RESTX requires Python version 3.8+.
 It's also working with PyPy and PyPy3.

doc/marshalling.rst

@@ -232,7 +232,7 @@ use :class:`~fields.Wildcard` ::
     >>> '{"Jane": "68", "bob": "42", "John": "12"}'
 
 The name you give to your :class:`~fields.Wildcard` acts as a real glob as
-shown bellow ::
+shown below ::
 
     >>> from flask_restx import fields, marshal
     >>> import json

doc/parsing.rst

@@ -38,7 +38,7 @@ It looks for two arguments in the :attr:`flask.Request.values` dict: an integer
 .. note ::
 
     The default argument type is a unicode string.
-    This will be ``str`` in python3 and ``unicode`` in python2.
+    This will be ``str``.
 
 If you specify the ``help`` value,
 it will be rendered as the error message when a type error is raised while parsing it.
@@ -85,7 +85,7 @@ And your args will look like this :
     args = parser.parse_args()
     args['name']    # ['bob', 'sue', 'joe']
 
-If you expect a coma separated list, use the ``action='split'``:
+If you expect a comma-separated list, use the ``action='split'``:
 
 .. code-block:: python