Initial Python sdk code

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+per-file-ignores = __init__.py:F401
+ignore = E501

.github/actions/gitleaks/action.yml

@@ -0,0 +1,10 @@
+name: Leaks checks
+description: 'gitleaks checks'
+runs:
+  using: "composite"
+  steps:
+    - name: gitleaks checks
+      run: |
+        chmod +x ./scripts/gitleaks/gitleaks.sh
+        ./scripts/gitleaks/gitleaks.sh
+      shell: bash

.github/workflows/ci.yaml

@@ -0,0 +1,53 @@
+name: Python package
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+
+      - name: Lint with flake8
+        run: |
+            flake8 . --count --show-source --statistics
+
+      - name: Lint with black
+        uses: psf/black@stable
+        with:
+          options: "--check --verbose"
+
+      - name: Run isort
+        uses: isort/isort-action@master
+        with:
+          configuration: --profile black
+
+      - name: Check leaks
+        uses: ./.github/actions/gitleaks
+
+      - name: License Checker
+        uses: andersy005/gh-action-py-liccheck@main
+        with:
+          strategy-ini-file: ./liccheck.ini
+          level: paranoid
+          requirements-txt-file: ./requirements-dev.txt
+          no-deps: false
+          liccheck-version: 0.6.4
+
+      - name: Tests
+        run: |
+          python -m pytest tests/*

.github/workflows/ci_pr.yaml

@@ -0,0 +1,58 @@
+name: Python package on pull request
+
+on: [pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+
+      - name: Build coverage file
+        run: |
+          python -m pytest --junitxml=/tmp/pytest.xml --cov-report=term-missing:skip-covered --cov=descope tests/ | tee /tmp/pytest-coverage.txt
+
+      - name: Pytest coverage comment
+        id: coverageComment
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: /tmp/pytest-coverage.txt
+          junitxml-path: /tmp/pytest.xml
+          create-new-comment: false
+
+      - name: Coverage
+        run: |
+          echo "Coverage Percantage - ${{ steps.coverageComment.outputs.coverage }}"
+          echo "Coverage Color - ${{ steps.coverageComment.outputs.color }}"
+          echo "Coverage Html - ${{ steps.coverageComment.outputs.coverageHtml }}"
+          echo "Coverage Warnings - ${{ steps.coverageComment.outputs.warnings }}"
+          echo "Coverage Errors - ${{ steps.coverageComment.outputs.errors }}"
+          echo "Coverage Failures - ${{ steps.coverageComment.outputs.failures }}"
+          echo "Coverage Skipped - ${{ steps.coverageComment.outputs.skipped }}"
+          echo "Coverage Tests - ${{ steps.coverageComment.outputs.tests }}"
+          echo "Coverage Time - ${{ steps.coverageComment.outputs.time }}"
+          echo "Not Success Test Info - ${{ steps.coverageComment.outputs.notSuccessTestInfo }}"
+
+      - name: Create the Badge
+        uses: schneegans/dynamic-badges-action@v1.0.0
+        with:
+          auth: ${{ secrets.CI_READ_COMMON }}
+          gistID: 277ec23e4e70728824362a0d24fbd0f9
+          filename: pytest-coverage-comment.json
+          label: Coverage Report
+          message: ${{ steps.coverageComment.outputs.coverage }}
+          color: ${{ steps.coverageComment.outputs.color }}
+          namedLogo: pytest

.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+exclude: 'docs/'
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.0.1
+  hooks:
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/PyCQA/isort
+  rev: 5.10.1
+  hooks:
+  - id: isort
+    args: ["--profile", "black"]
+- repo: https://github.com/psf/black
+  rev: 22.3.0
+  hooks:
+    - id: black
+      language_version: python3
+- repo: https://github.com/asottile/pyupgrade
+  rev: v2.31.1
+  hooks:
+    - id: pyupgrade
+      args: [--py37-plus]
+- repo: https://gitlab.com/pycqa/flake8
+  rev: 4.0.1
+  hooks:
+    - id: flake8
+- repo: https://github.com/dhatim/python-license-check
+  rev: master
+  hooks:
+  - id: liccheck
+    language: system
+    args: ["-r./requirements-dev.txt", "-lparanoid"]

README.md

@@ -1,2 +1,149 @@
-# python-sdk
+# Python SDK
 Python library used to integrate with Descope
+
+### Prerequisites
+
+In order to initiate the AuthClient object you must specify the project ID given by Descope either by:
+   - Set the `DESCOPE_PROJECT_ID` environment variable.
+   - Set the project_id argument when initialization the AuthClient object.
+
+
+### Installation
+Install the Descope Python SDK using the following command.
+Descope Python SDK supports Python 3.6 and above
+
+.. code-block:: python
+
+    pip install Descope-Auth
+
+
+## Usage
+Use (copy-paste) the pre defined samples decorators based on your framework (Flask supported) or the api as describe below
+
+### API
+.. code-block:: python
+
+from descope import DeliveryMethod, User, AuthClient
+
+class DeliveryMethod(Enum):
+    WHATSAPP = 1
+    PHONE = 2
+    EMAIL = 3
+
+User(username: str, name: str, phone: str, email: str)
+
+AuthClient(PROJECT_ID, PUBLIC_KEY=None)
+
+sign_up_otp(method: DeliveryMethod, identifier: str, user: User)
+Example:
+from descope import DeliveryMethod, User, AuthClient
+user = User("username", "name", "11111111111", "dummy@dummy.com")
+auth_client = AuthClient(PROJECT_ID)
+auth_client.sign_up_otp(DeliveryMethod.EMAIL, "dummy@dummy.com", user)
+
+
+sign_in_otp(method: DeliveryMethod, identifier: str)
+Example:
+from descope import DeliveryMethod, AuthClient
+auth_client = AuthClient(PROJECT_ID)
+auth_client.sign_in_otp(DeliveryMethod.EMAIL, "dummy@dummy.com")
+
+@descope_signin_otp_by_email
+
+verify_code(method: DeliveryMethod, identifier: str, code: str)
+--Upon successful verification new session cookies will returned and should be set on the response
+Or one of the decorators:
+@descope_verify_code_by_email
+@descope_verify_code_by_phone
+@descope_verify_code_by_whatsapp
+
+
+Example:
+from descope import DeliveryMethod, AuthClient
+auth_client = AuthClient(PROJECT_ID)
+auth_client.verify_code(DeliveryMethod.EMAIL, "1111")
+Or decorator
+
+APP = Flask(__name__)
+@APP.route("/api/verify")
+@descope_verify_code_by_email
+def verify():
+    pass
+
+
+
+validate_session_request(signed_token: str, signed_refresh_token: str)
+Or decorator
+@descope_validate_auth
+
+Example:
+from descope import AuthClient
+auth_client = AuthClient(PROJECT_ID)
+new_valid_token = auth_client.validate_session_request('session_token', 'refresh_token')
+
+logout(signed_token: str, signed_refresh_token: str)
+Example:
+from descope import AuthClient
+auth_client = AuthClient(PROJECT_ID)
+auth_client.logout('session_token', 'refresh_token')
+
+#### Exception
+.. code-block:: python
+
+AuthException
+Example:
+from descope import DeliveryMethod, AuthClient, AuthException
+try:
+    auth_client = AuthClient(PROJECT_ID)
+    auth_client.sign_in_otp(DeliveryMethod.EMAIL, "dummy@dummy.com")
+except AuthException:
+    #Handle exception
+
+#
+### Run The Example
+
+1. Clone repo locally `git clone github.com/descope/python-sdk`
+2. Install the requirements `pip3 install -r requirements-dev.txt`
+
+3. export your project id
+
+```
+export DESCOPE_PROJECT_ID=<insert here>
+```
+
+5. Run the example application `python samples/web_sample_app.py`
+6. Application runs on `http://localhost:9000`
+7. Now you can perform GET requests to the server api like the following example:
+
+Signup a new user by OTP via email, verify the OTP code and then access private (authenticated) api
+
+.. code-block
+
+    /api/signup
+    Body:
+    {
+        "email": "dummy@dummy.com",
+        "user": {
+            "username": "dummy",
+            "name": "dummy",
+            "phone": "11111111111",
+            "email": "dummy@dummy.com"
+       }
+    }
+
+    /api/verify
+    Body:
+    {
+        "code": "111111",
+        "email": "dummy@dummy.com"
+    }
+
+    ** Response will have the new generate session cookies
+
+    /api/private
+    Use the session cookies (otherwise you will get HTTP 401 - Unauthorized)
+
+### Unit Testing
+.. code-block:: python
+
+python -m pytest tests/*

descope/__init__.py

@@ -0,0 +1,8 @@
+from descope.auth import AuthClient
+from descope.common import (
+    REFRESH_SESSION_COOKIE_NAME,
+    SESSION_COOKIE_NAME,
+    DeliveryMethod,
+    User,
+)
+from descope.exceptions import AuthException