anzar 0.3.0

Add your description here

Anzar SDK Documentation

Install The Python SDK

In a python project run the following command to install the anzar package.

uv

$ uv add anzar

pip

# in a virtual env run
$ pip install anzar

Create Anzar Auth Instance

in your main entry file (main.py for example), import anzar.yml and parse it as a YAML file

def load_config(path: str) -> AnzarConfig:
    import yaml

    try:
        with open(path, "r") as f:
            data = yaml.safe_load(f)
        return AnzarConfig(**data)
    except Exception as e:
        import sys

        sys.exit("check your configuration file: anzar.yml")

import Anzar Auth and create your auth instance

# Initialize once at application startup
# The SDK will communicate with your Anzar container at the configured api_url
from anzar import Anzar

config = load_config("anzar.yml")
anzar = Anzar(config, options=None)

⚠️ Warning: Only extend these functionality if you are using JWT authentication

⚠️ Warning: Implement a secure Storage solution

from anzar.types import SdkOptions, SessionTokens

def refresh_token(tokens: SessionTokens):
    # store tokens.access, tokens.refresh
options = SdkOptions(
    get_token=lambda: "AccessToken"
    get_refresh_token=lambda: "RefreshToken"
    on_token_refresh=lambda tokens: refresh_token(tokens),
    ...
)

Basic Usage

Anzar provides authentication support for email and password.

📝 Note: Other methods of authentication will be implemented later

Sign Up

To sign up a user you need to call the method register with the user's information.

from anzar.types import ApiException, AuthResponse

try:
    data: AuthResponse = anzar.Auth.register({
      "username": "username",
      "email": "[e-mail]",
      "password": "password"
    })
    if data.tokens:
        # Store securely the `access`,`refresh` tokens
except ApiException as e:
    print(e.status, e.body)

📝 Note: By default, the users are automatically signed in after they successfully sign up. Disabling this behavior will be implemented later

Sign In

To sign in a user you need to call the method login.

from anzar.types import ApiException, AuthResponse

try:
    data: AuthResponse = anzar.Auth.login({
      "email": "[e-mail]",
      "password": "password"
    })
    if data.tokens:
        # Store securely the `access`,`refresh` tokens
except ApiException as e:
    print(e.status, e.body)