Getting started#

Requirements#

  • python3.6+

  • python modules

    • jwt_helper

    • tortoise-orm[asyncmy]

    • bcrypt

  • Optional

    • python-ldap

The Optional python-ldap Dependency is only needed if you want to use an LDAP/AD-Server as upstream Identity Provider.

Installation#

via PyPi#

py_auth_micro is available from PyPi and can be installed with pip from there. Just run the following command.

python3 -m pip install py-auth-micro

with python-ldap

python3 -m pip install py-auth-micro python-ldap

From Source#

  1. Clone the repository

git clone https://github.com/bad-microservices/py_auth_micro.git

  1. navigate into the cloned folder

cd py_auth_micro

  1. install via pip

python3 -m pip install .

(OPTIONAL) install python-ldap

python3 -m pip install python-ldap

Example implementation#

Here is an example auth flow you could implement with this library

example auth_flow