API Reference

This page documents the inner API of the statelessauth project. The project is separated into the following modules (all relative to statelessauth).

  1. Wire - .wire : responsible for encoding and decoding objects from and to JSON.

  2. Engine - .engine : contains the different engines for the encoding and decoding as well as views.

  3. Middlewares - .middlewares : contains the authentication middleware.

  4. Config - .config : contains the configuration utils.

It also contains the following implementations

  1. User Auth - .contrib.auth : Implementation of the default django authentication system

We will be using the following guidelines regarding the documentation :

  1. Whenever a generic class is used, we will write class A[T] instead of class A(Generic[T]), where T is a TypeVar as defined by Python’s typing module.

  2. Whenever a generic class is used with a type containing a bound on it, we will write class A[T extends B], where B must be an ancestor of T. It is defined as class A(Generic[T]), where T is a TypeVar with bound=B as defined by Python’s typing module.