Merge pull request #1 from passwordless/dev

Python SDK

Author: abergs

.flake8

@@ -0,0 +1,6 @@
+[flake8]
+show-source = True
+doctests = True
+exclude =
+    src/passwordless/__init__.py
+    venv

.github/workflows/cd.yml

@@ -0,0 +1,25 @@
+name: Release
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # 3.6.0
+      - name: Install poetry
+        run: pipx install poetry
+      - name: Set up Python 3.8
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # 4.7.1
+        with:
+          python-version: '3.8'
+          cache: 'poetry'
+      - name: Configure PYPI
+        run: poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
+      - name: Publish to PYPI
+        run: poetry publish --build

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: Python CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build-maven:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # 3.6.0
+      - name: Install poetry
+        run: pipx install poetry
+      - name: Set up Python 3.8
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # 4.7.1
+        with:
+          python-version: '3.8'
+          cache: 'poetry'
+      - name: Build
+        run: poetry install --with dev,test
+      - name: Run isort
+        run: poetry run isort . --check-only
+      - name: Run docformatter
+        run: poetry run docformatter --in-place --config ./pyproject.toml src/
+      - name: Run black
+        run: poetry run black . --check
+      - name: Run flake8
+        run: poetry run flake8 .
+      - name: Run mypy
+        run: poetry run mypy .
+      - name: Test
+        run: poetry run pytest

.gitignore

@@ -157,4 +157,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+  - repo: https://github.com/PyCQA/isort
+    rev: e44834b7b294701f596c9118d6c370f86671a50d # 5.12.0
+    hooks:
+      - id: isort
+        args: ['--settings-path', 'pyproject.toml']
+  - repo: https://github.com/PyCQA/docformatter
+    rev: dfefe062799848234b4cd60b04aa633c0608025e # v1.7.5
+    hooks:
+      - id: docformatter
+        additional_dependencies: [tomli]
+        args: ['--in-place', '--config', './pyproject.toml']
+  - repo: https://github.com/psf/black
+    rev: e87737140f32d3cd7c44ede75f02dcd58e55820e # 23.9.1
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7ef0350a439c93166bc8ba89fcc3de6a9a664e6c # 6.1.0
+    hooks:
+      - id: flake8
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 08cbc46b6e135adec84911b20e98e5bc52032152 # v1.5.1
+    hooks:
+      - id: mypy
+        require_serial: true
+        additional_dependencies: [
+          types-requests>2,
+          marshmallow>3
+        ]
+        exclude: tests|examples

README.md

@@ -1 +1,113 @@
-# passwordless-python
+# Passwordless Python SDK
+
+The official [Bitwarden Passwordless.dev](https://passwordless.dev/) Python library, for Python 3+.
+
+## Installation
+
+Install with `python -m pip install passwordless`.
+
+### Dependencies
+
+- [Requests][requests] for HTTP API
+- [marshmallow][marshmallow] for JSON (de)serialization
+
+## Getting Started
+
+Follow the [Get started guide][api-docs].
+
+### Create `PasswordlessClient` instance:
+
+```python
+from passwordless import (
+    PasswordlessClient,
+    PasswordlessClientBuilder,
+    PasswordlessOptions,
+)
+
+
+class PasswordlessPythonSdkExample:
+    client: PasswordlessClient
+
+    def __init__(self):
+        options = PasswordlessOptions("your_api_secret")
+
+        self.client = PasswordlessClientBuilder(options).build()
+
+```
+
+### Register a passkey
+
+```python
+import uuid
+from passwordless import PasswordlessClient, RegisterToken, RegisteredToken
+
+
+class PasswordlessPythonSdkExample:
+    client: PasswordlessClient
+
+    def get_register_token(self, alias: str) -> str:
+        # Get existing userid from session or create a new user.
+        user_id = str(uuid.uuid4())
+
+        # Options to give the Api
+        register_token = RegisterToken(
+            user_id=user_id,  # your user id
+            username=alias,  # e.g. user email, is shown in browser ui
+            aliases=[alias]  # Optional: Link this userid to an alias (e.g. email)
+        )
+
+        response: RegisteredToken = self.client.register_token(register_token)
+
+        # return this token
+        return response.token
+```
+
+### Verify user
+
+```python
+from passwordless import PasswordlessClient, VerifySignIn, VerifiedUser
+
+
+class PasswordlessPythonSdkExample:
+    client: PasswordlessClient
+
+    def verify_sign_in_token(self, token: str) -> VerifiedUser:
+        verify_sign_in = VerifySignIn(token)
+
+        # Sign the user in, set a cookie, etc,
+        return self.client.sign_in(verify_sign_in)
+```
+
+### Customization
+
+Customize `PasswordlessOptions` by providing `api_secret` with your Application's Api Secret.
+You can also change the `api_url` if you prefer to self-host.
+
+Customize `PasswordlessClientBuilder` by providing `session` [requests Session][requests] instance.
+
+### Examples
+
+See [Passwordless Python Example](examples/flask) for Flash Web application.
+
+## Documentation
+
+For a comprehensive list of examples, check out the [API documentation][api-docs].
+
+## Contributing
+
+This library is compatible with Python 3 and requires minimum Python 3.8 installed.
+Install [Poetry][poetry] if not already installed.
+
+Activate shell: `poetry shell`
+
+Install dependencies: `poetry install --with dev,test`
+
+Build: `poetry build`
+
+[api-docs]:https://docs.passwordless.dev/guide/get-started.html
+
+[poetry]:https://python-poetry.org/docs/#installation
+
+[requests]:https://requests.readthedocs.io/en/latest/
+
+[marshmallow]:https://marshmallow.readthedocs.io/en/stable/

examples/flask/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+#.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/