feat(flask): adding flask decorators as a package extra (#291)

* feat(flask): adding flask decorators as a package extra

* readme and omit coverage

.pre-commit-config.yaml

@@ -32,6 +32,7 @@ repos:
  rev: 6.1.0
  hooks:
  - id: flake8
+ additional_dependencies: [Flake8-pyproject]
  - repo: https://github.com/python-poetry/poetry
  rev: 1.6.1
  hooks:
@@ -69,10 +70,3 @@ repos:
  language: system
  files: ^(.*requirements.*\.txt|setup\.cfg|setup\.py|pyproject\.toml|liccheck\.ini)$
  pass_filenames: false
- - id: tox
- name: Run tests with tox
- description: Run tox to check that all tests pass
- entry: poetry run tox -p
- language: system
- files: ^(.*\.py)$
- pass_filenames: false

.vscode/extensions.json

@@ -0,0 +1,11 @@
+{
+ "recommendations": [
+ "ms-python.python",
+ "ms-python.black-formatter",
+ "ms-python.flake8",
+ "ms-python.isort",
+ "ms-python.vscode-pylance",
+ "ms-python.mypy-type-checker",
+ "bodil.prettier-toml",
+ ]
+}

.vscode/settings.json

@@ -3,5 +3,8 @@
  "python.testing.pytestArgs": [
  "tests"
  ],
- "mypy.runUsingActiveInterpreter": true,
+ "flake8.importStrategy": "fromEnvironment",
+ "mypy-type-checker.importStrategy": "fromEnvironment",
+ "isort.importStrategy": "fromEnvironment",
+ "black-formatter.importStrategy": "fromEnvironment",
 }

README.md

@@ -15,6 +15,12 @@ Install the package with:
 pip install descope
 ```
 
+#### If you would like to use the Flask decorators, make sure to install the Flask extras:
+
+```bash
+pip install descope[Flask]
+```
+
 ## Setup
 
 A Descope `Project ID` is required to initialize the SDK. Find it on the
@@ -795,10 +801,13 @@ updated_jwt = descope_client.mgmt.jwt.update_jwt(
 ```
 
 # Note 1: The generate code/link functions, work only for test users, will not work for regular users.
+
 # Note 2: In case of testing sign-in / sign-up operations with test users, need to make sure to generate the code prior calling the sign-in / sign-up operations.
 
 # Embedded links can be created to directly receive a verifiable token without sending it.
+
 # This token can then be verified using the magic link 'verify' function, either directly or through a flow.
+
 token = descope_client.mgmt.user.generate_embedded_link("[email protected]", {"key1":"value1"})
 
 ### Search Audit
@@ -885,8 +894,9 @@ You can find various usage samples in the [samples folder](https://github.com/de
 ## Run Locally
 
 ### Prerequisites
- - Python 3.7 or higher
- - [Poetry](https://python-poetry.org) installed
+
+- Python 3.7 or higher
+- [Poetry](https://python-poetry.org) installed
 
 ### Install dependencies
 
@@ -897,11 +907,13 @@ poetry install
 ### Run tests
 
 Running all tests:
+
 ```bash
 poetry run pytest tests
 ```
 
 Running all tests with coverage:
+
 ```bash
 poetry run pytest --junitxml=/tmp/pytest.xml --cov-report=term-missing:skip-covered --cov=descope tests/ --cov-report=xml:/tmp/cov.xml
 ```

samples/decorators/flask_decorators.py → descope/flask/__init__.py

@@ -1,10 +1,12 @@
+from __future__ import annotations
+
 import datetime
 import uuid
 from functools import wraps
 
 from flask import Response, _request_ctx_stack, redirect, request
 
-from descope import (
+from .. import (
  COOKIE_DATA_NAME,
  REFRESH_SESSION_COOKIE_NAME,
  REFRESH_SESSION_TOKEN_NAME,
@@ -13,8 +15,8 @@
  AuthException,
  DeliveryMethod,
 )
-from descope.descope_client import DescopeClient
-from descope.exceptions import ERROR_TYPE_INVALID_ARGUMENT
+from ..descope_client import DescopeClient
+from ..exceptions import ERROR_TYPE_INVALID_ARGUMENT
 
 
 def set_cookie_on_response(response: Response, token: dict, cookie_data: dict):
@@ -38,7 +40,7 @@ def set_cookie_on_response(response: Response, token: dict, cookie_data: dict):
  )
 
 
-def descope_signup_otp_by_email(descope_client):
+def descope_signup_otp_by_email(descope_client: DescopeClient):
  """
  Sign-up new user, using email to verify the OTP
  """
@@ -64,7 +66,7 @@ def decorated(*args, **kwargs):
  return decorator
 
 
-def descope_signin_otp_by_email(descope_client):
+def descope_signin_otp_by_email(descope_client: DescopeClient):
  """
  Sign-in existing user, using email to verify OTP
  """
@@ -89,7 +91,12 @@ def decorated(*args, **kwargs):
  return decorator
 
 
-def descope_validate_auth(descope_client, permissions=None, roles=None, tenant=""):
+def descope_validate_auth(
+ descope_client: DescopeClient,
+ permissions: list[str] | None = None,
+ roles: list[str] | None = None,
+ tenant="",
+):
  """
  Test if Access Token is valid
  """
@@ -152,7 +159,7 @@ def decorated(*args, **kwargs):
  return decorator
 
 
-def descope_verify_code_by_email(descope_client):
+def descope_verify_code_by_email(descope_client: DescopeClient):
  """
  Verify code by email decorator
  """
@@ -195,7 +202,7 @@ def decorated(*args, **kwargs):
  return decorator
 
 
-def descope_verify_code_by_phone(descope_client):
+def descope_verify_code_by_phone(descope_client: DescopeClient):
  """
  Verify code by email decorator
  """
@@ -238,7 +245,7 @@ def decorated(*args, **kwargs):
  return decorator
 
 
-def descope_verify_code_by_whatsapp(descope_client):
+def descope_verify_code_by_whatsapp(descope_client: DescopeClient):
  """
  Verify code by whatsapp decorator
  """
@@ -281,7 +288,7 @@ def decorated(*args, **kwargs):
  return decorator
 
 
-def descope_signup_magiclink_by_email(descope_client, uri):
+def descope_signup_magiclink_by_email(descope_client: DescopeClient, uri: str):
  """
  Signup new user using magiclink via email
  """
@@ -307,7 +314,7 @@ def decorated(*args, **kwargs):
  return decorator
 
 
-def descope_signin_magiclink_by_email(descope_client, uri):
+def descope_signin_magiclink_by_email(descope_client: DescopeClient, uri: str):
  """
  Signin using magiclink via email
  """
@@ -332,7 +339,7 @@ def decorated(*args, **kwargs):
  return decorator
 
 
-def descope_verify_magiclink_token(descope_client):
+def descope_verify_magiclink_token(descope_client: DescopeClient):
  """
  Verify magiclink token
  """
@@ -370,7 +377,7 @@ def decorated(*args, **kwargs):
  return decorator
 
 
-def descope_logout(descope_client):
+def descope_logout(descope_client: DescopeClient):
  """
  Logout
  """
@@ -426,7 +433,7 @@ def decorated(*args, **kwargs):
  return decorator
 
 
-def descope_full_login(project_id, flow_id, success_redirect_url):
+def descope_full_login(project_id: str, flow_id: str, success_redirect_url: str):
  """
  Descope Flow login
  """