From 9f41310b17d076a2e74550e824c33e8acbdcb043 Mon Sep 17 00:00:00 2001 From: Jack Grahl Date: Mon, 28 Feb 2022 22:19:59 +0000 Subject: [PATCH 1/3] Add python 3.10, remove flask 1.0 --- .github/workflows/test.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index fda0012..88d74b4 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -7,9 +7,9 @@ jobs: strategy: fail-fast: false matrix: - python-version: [3.6, 3.7, 3.8, 3.9] + python-version: [3.6, 3.7, 3.8, 3.9, "3.10"] os: [ubuntu-18.04, macos-latest, windows-latest] - flask-version: ["1.0", 1.1, "2.0", latest] + flask-version: [1.1, "2.0", latest] runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@v2 From 034991762e2ab5f03636ea4679a283fc7edac6c0 Mon Sep 17 00:00:00 2001 From: Jack Grahl Date: Mon, 2 May 2022 11:20:09 +0100 Subject: [PATCH 2/3] Remove claimed support for 3.6. --- README.md | 5 +++-- README.txt | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6ca54dd..9767135 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,11 @@ Flask-Selfdoc is a Flask extension that automatically creates documentation for ## Requirements -Flask-Selfdoc is compatible with Python versions >=3.6 and Flask versions >=1.0. +Flask-Selfdoc is compatible with Python versions >=3.7 and Flask versions >=1.1. + The package is tested with a selection of those versions. If you find it doesn't work correctly with versions in those ranges please report a bug, thanks. -Previous versions of Flask-Selfdoc worked with Python 2.7, Python 3.5 and Flask 0.11 and 0.12. If you need a version which works with these old versions of Python and Flask, try Flask-Selfdoc 1.2.3 (but you are better off upgrading away from end-of-life Python!!!) +Previous versions of Flask-Selfdoc worked with Python 2.7, Python 3.5 and Flask 0.11, 0.12, 1.0. If you need a version which works with these old versions of Python and Flask, try Flask-Selfdoc 1.2.3 (but you are better off upgrading away from end-of-life Python!!!) ## Install diff --git a/README.txt b/README.txt index bef0e47..a72496a 100644 --- a/README.txt +++ b/README.txt @@ -3,7 +3,7 @@ Flask-Selfdoc Flask-Selfdoc is a Flask extension that automatically creates documentation for your endpoints based on the routes, function arguments and docstrings. It was forked from Flask-Autodoc, written by Arnaud Coomans, and is completely compatible as a replacement for that extension. -Flask-Selfdoc is compatible with Python versions 2 and 3; and it depends only on Flask. It is tested with all versions of Flask from 0.11 up to the latest release and the latest Flask release will continue to be supported. +Flask-Selfdoc is compatible with Python versions 3.7 and upwards; and it depends only on Flask. It is tested with all versions of Flask from 1.1 up to the latest release and the latest Flask release will continue to be supported. If your codebase uses Flask-Autodoc, you can swap it for Flask-Selfdoc by simply changing the name of the module in your import: @@ -13,6 +13,6 @@ instead of from flask_autodoc import Autodoc -No other changes are necessary. Flask-Selfdoc 1.0 has exactly the same functionality as Flask-Autodoc 0.1.2, the most recent release at the time of the fork. The projects will remain like-for-like compatible for the foreseeable future. +No other changes are necessary. Flask-Selfdoc 1.x has exactly the same functionality as Flask-Autodoc 0.1.2, the most recent release at the time of the fork. The projects will remain compatible for the foreseeable future, although some functionality will be added to Flask-Selfdoc. -The main project webpage is on GitHub at https://github.com/jwg4/flask-selfdoc and the full documentation is at https://github.com/jwg4/flask-selfdoc/blob/master/README.md \ No newline at end of file +The main project webpage is on GitHub at https://github.com/jwg4/flask-selfdoc and the full documentation is at https://github.com/jwg4/flask-selfdoc/blob/master/README.md From 2e06acd5f45329ee178441a4da8e0d9832c46fe8 Mon Sep 17 00:00:00 2001 From: Jack Grahl Date: Mon, 2 May 2022 11:20:33 +0100 Subject: [PATCH 3/3] Prerelease version 1.4.0 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 5e16758..6f6f3aa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "flask-selfdoc" -version = "1.3.0" +version = "1.4.0-alpha.0" description = "Documentation generator for flask" authors = ["Jack Grahl "] license = "MIT"