Added StreamLit as example project (#44)

* StreamLit as second example project

Author: mzieniukbw

examples/flask/poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
-name = "passwordless-example"
-version = "0.1.1"
+name = "passwordless-example-flask"
+version = "1.0.0"
 description = "Passwordless.dev Python SDK usage Example"
 authors = [
     "Bitwarden <[email protected]>"
@@ -11,8 +11,8 @@ maintainers = [
 readme = "README.md"
 
 [tool.poetry.dependencies]
-python = "^3.8"
-passwordless = "^0"
+python = ">=3.8"
+passwordless = "^1"
 flask = "^2"
 flasgger = "^0"
 flask-marshmallow = "^0"

examples/flask/pyproject.toml

@@ -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/

examples/streamlit/.gitignore

@@ -0,0 +1,4 @@
+[browser]
+gatherUsageStats = false
+serverAddress="localhost"
+serverPort=8501

examples/streamlit/.streamlit/config.toml

@@ -0,0 +1,3 @@
+passwordless_api_url="https://v4.passwordless.dev"
+passwordless_api_key=""
+passwordless_api_secret=""

examples/streamlit/.streamlit/secrets.toml

@@ -0,0 +1,47 @@
+# Passwordless Python SDK Example
+
+Please read the documentation here: https://docs.passwordless.dev
+
+## Getting Started
+
+This example uses *StreamLit* and provides UI to interact with
+the [Passwordless Python SDK][passwordless-python-sdk] to the *Passwordless API*.
+
+Python 3.8 or newer is required to run the application.
+For frontend, install Node.
+
+Install [Poetry][poetry] if not already installed.
+
+Activate shell: `poetry shell`
+
+Install dependencies: `poetry install --with dev`
+
+1. Get your own API keys here: https://admin.passwordless.dev/signup
+2. Change the value of the Key and Secret in [.streamlit/secrets.toml file](.streamlit/secrets.toml)
+    - (optional) In case of self-hosting, change the value of the Url with the base url where your *Passwordless API*
+      instance is running.
+3. Build the application:
+   ```
+   cd passwordless_auth/frontend
+   npm install
+   npm run build
+   ```
+4. Start the application `poetry run streamlit run app.py`
+5. The application will now listen on port `8501` e.g. http://localhost:8501, where you can *Sign In* and *Register*
+   users within your Application.
+
+### Preparing for production
+
+1. Edit the `[browser]` section in the [config.toml](.streamlit%2Fconfig.toml) file:
+    - Change `serverAddress` to your host name
+    - Change `serverPort` to your port. For `https://` use 443.
+2. To run the application with `https://` scheme:
+    1. Put reverse proxy with SSL in front of the application.
+    2. Provide the path to the certificate and key files, by modifying `sslCertFile` and `sslKeyFile` in the
+       `[server]` section of the [config.toml](.streamlit%2Fconfig.toml) file
+
+Note: WebAuthn will only work with `https://` scheme with a valid, trusted certificate.
+
+[passwordless-python-sdk]:https://github.com/bitwarden/passwordless-python
+
+[poetry]:https://python-poetry.org/docs/#installation

examples/streamlit/README.md

@@ -0,0 +1,27 @@
+import streamlit as st
+
+st.set_page_config(page_title="Passwordless StreamLit example")
+st.title("Bitwarden Passwordless.dev - Python")
+
+st.write(
+    "[Documentation](https://docs.passwordless.dev) - [Get your API keys]("
+    "https://admin.passwordless.dev/signup)"
+)
+
+if (
+    "passwordless_api_key" not in st.secrets
+    or "passwordless_api_secret" not in st.secrets
+    or "passwordless_api_url" not in st.secrets
+    or st.secrets["passwordless_api_key"] == ""
+    or st.secrets["passwordless_api_secret"] == ""
+    or st.secrets["passwordless_api_url"] == ""
+):
+    st.write(
+        "To run this example you must first specify yor API Key "
+        "and API Secret in _.streamlit/secrets.toml_ file."
+    )
+
+if "login_user" in st.session_state:
+    st.write("## Logged in User: ", st.session_state.login_user)
+else:
+    st.write("## Sign in to your account or register new account")

examples/streamlit/__init__.py

@@ -0,0 +1,42 @@
+import passwordless_api
+import streamlit as st
+from passwordless_auth import passwordless_auth_component
+
+st.set_page_config(page_title="Sign In")
+st.title("Sign In")
+
+st.text_input("Alias", key="alias")
+
+if st.button("Login"):
+    if "auth_error" in st.session_state:
+        del st.session_state.auth_error
+    st.session_state.login_init = True
+
+if "login_init" in st.session_state:
+    auth_result = passwordless_auth_component(
+        "passwordless_auth_login",
+        {
+            "api_url": st.secrets["passwordless_api_url"],
+            "api_key": st.secrets["passwordless_api_key"],
+            "type": "login",
+            "alias": st.session_state.alias,
+        },
+    )
+    print(auth_result)
+
+    if auth_result is not None:
+
+        if "token" in auth_result:
+            st.session_state.login_user = passwordless_api.login(
+                auth_result["token"]
+            )
+        else:
+            st.session_state.auth_error = auth_result
+
+        del st.session_state.login_init
+
+if "login_user" in st.session_state:
+    st.write("## User: ", st.session_state.login_user)
+
+if "auth_error" in st.session_state:
+    st.write("## Error: ", st.session_state.auth_error)

examples/streamlit/app.py

@@ -0,0 +1,46 @@
+import passwordless_api
+import streamlit as st
+from passwordless_auth import passwordless_auth_component
+
+st.set_page_config(page_title="Login")
+st.title("Register")
+
+st.text_input("Username", key="username")
+st.text_input("Alias", key="alias")
+
+if st.button("Register"):
+    if "auth_error" in st.session_state:
+        del st.session_state.auth_error
+
+    registered_token = passwordless_api.register(
+        st.session_state.username, st.session_state.alias
+    )
+
+    st.session_state.register_token = registered_token.token
+
+if "register_token" in st.session_state:
+    auth_result = passwordless_auth_component(
+        "passwordless_auth_register",
+        data={
+            "api_url": st.secrets["passwordless_api_url"],
+            "api_key": st.secrets["passwordless_api_key"],
+            "type": "register",
+            "token": st.session_state.register_token,
+        },
+    )
+    print(auth_result)
+
+    if auth_result is not None:
+
+        if "token" in auth_result:
+            st.session_state.register_auth_result = auth_result
+        else:
+            st.session_state.auth_error = auth_result
+
+        del st.session_state.register_token
+
+if "register_auth_result" in st.session_state:
+    st.write("## Result: ", st.session_state.register_auth_result)
+
+if "auth_error" in st.session_state:
+    st.write("## Error: ", st.session_state.auth_error)