feat: Merge pull request #556 from marcospereirampj/release/4.0.0

Release/4.0.0
marcospereirampj · Apr 27, 2024 · 6ec4998 · 6ec4998
2 parents af3d596 + 4bd55ba
commit 6ec4998
Show file tree

Hide file tree

Showing 11 changed files with 485 additions and 723 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -8,4 +8,4 @@ build:
     post_create_environment:
       - python -m pip install poetry
     post_install:
-      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install -E docs
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install
diff --git a/README.md b/README.md
@@ -20,9 +20,24 @@ https://github.com/marcospereirampj/python-keycloak/issues
 
 The documentation for python-keycloak is available on [readthedocs](http://python-keycloak.readthedocs.io).
 
-## Example of Using Keycloak OpenID
+## Keycloak version support
+
+The library strives to always support Keycloak's latest version. Additionally to that, we also support 5 latest major versions of Keycloak,
+in order to give our user base more time for smoother upgrades.
+
+Current list of supported Keycloak versions:
 
+- 24.X
+- 23.X
+- 22.X
+- 21.X
+- 20.X
 
+## Python version support
+
+We only support Python versions which have active or security support by the Python Software Foundation. You find the list of active python versions [here](https://endoflife.date/python).
+
+## Example of Using Keycloak OpenID
 
 ```python
 from keycloak import KeycloakOpenID

diff --git a/docs/source/modules/openid_client.rst b/docs/source/modules/openid_client.rst
@@ -116,9 +116,9 @@ Decode token
 
 .. code-block:: python
 
-    KEYCLOAK_PUBLIC_KEY = "-----BEGIN PUBLIC KEY-----\n" + keycloak_openid.public_key() + "\n-----END PUBLIC KEY-----"
-    options = {"verify_signature": True, "verify_aud": True, "verify_exp": True}
-    token_info = keycloak_openid.decode_token(token['access_token'], key=KEYCLOAK_PUBLIC_KEY, options=options)
+    token_info = keycloak_openid.decode_token(token['access_token'])
+    # Without validation
+    token_info = keycloak_openid.decode_token(token['access_token'], validate=False)
 
 
 Get UMA-permissions by token

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,31 +31,19 @@ Documentation = "https://python-keycloak.readthedocs.io/en/latest/"
 [tool.poetry.dependencies]
 python = ">=3.8,<4.0"
 requests = ">=2.20.0"
-mock = {version = "^4.0.3", optional = true}
-alabaster = {version = "^0.7.12", optional = true}
-commonmark = {version = "^0.9.1", optional = true}
-recommonmark = {version = "^0.7.1", optional = true}
-Sphinx = {version = "^6.1.0", optional = true}
-sphinx-rtd-theme = {version = "^1.0.0", optional = true}
-readthedocs-sphinx-ext = {version = "^2.1.9", optional = true}
-m2r2 = {version = "^0.3.2", optional = true}
-sphinx-autoapi = {version = "^3.0.0", optional = true}
 requests-toolbelt = ">=0.6.0"
 deprecation = ">=2.1.0"
 jwcrypto = "^1.5.4"
 
-[tool.poetry.extras]
-docs = [
-    "mock",
-    "alabaster",
-    "commonmark",
-    "recommonmark",
-    "sphinx",
-    "sphinx-rtd-theme",
-    "readthedocs-sphinx-ext",
-    "m2r2",
-    "sphinx-autoapi",
-]
+[tool.poetry.group.docs.dependencies]
+alabaster = ">=0.7.12"
+commonmark = ">=0.9.1"
+recommonmark = ">=0.7.1"
+Sphinx = ">=6.1.0"
+sphinx-rtd-theme = ">=1.0.0"
+readthedocs-sphinx-ext = ">=2.1.9"
+m2r2 = ">=0.3.2"
+sphinx-autoapi = ">=3.0.0"
 
 [tool.poetry.group.dev.dependencies]
 tox = ">=4.0.0"