From 0c529b15fc24710c898ac3441b28210de340eeac Mon Sep 17 00:00:00 2001 From: Jack Grahl Date: Sun, 27 Feb 2022 14:04:32 +0000 Subject: [PATCH 1/5] Don't support 3.6 anymore. --- .github/workflows/test.yml | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index fda0012..a4705db 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -7,7 +7,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: [3.6, 3.7, 3.8, 3.9] + python-version: [3.7, 3.8, 3.9] os: [ubuntu-18.04, macos-latest, windows-latest] flask-version: ["1.0", 1.1, "2.0", latest] runs-on: ${{ matrix.os }} diff --git a/pyproject.toml b/pyproject.toml index ccc4250..012fe4f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ authors = ["Jack Grahl "] license = "MIT" [tool.poetry.dependencies] -python = "^3.6" +python = "^3.7" Flask = "^1.0" [tool.poetry.dev-dependencies] From e45c134d4fed69c6f74ce981b9b090c824e4601b Mon Sep 17 00:00:00 2001 From: Jack Grahl Date: Mon, 2 May 2022 11:27:53 +0100 Subject: [PATCH 2/5] Update docs for python 3.6. --- README.md | 4 ++-- README.txt | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 88bf84a..be636a0 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,12 @@ 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.0. (Currently it appears that Flask 1.0 itself does not work with Python 3.10, so this combination is not supported.) 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 3.6 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!!!) (Flask versions before 2.0.0 worked with Python 2.7 and Python 3.5) ## Install diff --git a/README.txt b/README.txt index bef0e47..e0bcf12 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.0 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 063a3666fd4fac51c224d82f860a8b7c66f7ce27 Mon Sep 17 00:00:00 2001 From: Jack Grahl Date: Mon, 2 May 2022 11:32:30 +0100 Subject: [PATCH 3/5] Prerelease version 1.4.0. --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 012fe4f..e7a7b77 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "flask-selfdoc" -version = "1.3.1-alpha.0" +version = "1.4.0-alpha.0" description = "Documentation generator for flask" authors = ["Jack Grahl "] license = "MIT" From d577187196bf9ed5e58adea63231a1d4d0dce9bd Mon Sep 17 00:00:00 2001 From: jwg4 Date: Thu, 20 Oct 2022 16:30:49 +0100 Subject: [PATCH 4/5] Add warning about using older versions of everything --- README.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.txt b/README.txt index e0bcf12..6a8ab75 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 3.7 and upwards; and it depends only on Flask. It is tested with all versions of Flask from 1.0 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.0 up to the latest release and the latest Flask release will continue to be supported. Older versions of Flask-Selfdoc can be used if you require the same compatibility with old versions of Python and Flask as was present in Flask-Autodoc. However this is not recommended - instead we recommend to upgrade Flask and/or Python. If your codebase uses Flask-Autodoc, you can swap it for Flask-Selfdoc by simply changing the name of the module in your import: From c3ca2428100924ae3a943d93a60a4e5a5f857d12 Mon Sep 17 00:00:00 2001 From: jwg4 Date: Thu, 20 Oct 2022 16:34:44 +0100 Subject: [PATCH 5/5] Allow Flask 1 or 2 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index e7a7b77..a3758f6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ license = "MIT" [tool.poetry.dependencies] python = "^3.7" -Flask = "^1.0" +Flask = ">=1.0,<3.0" [tool.poetry.dev-dependencies] pytest = "^6.2.5"