Skip to content

Installation

Getting Started

You can add AuthX to your FastAPI project in a few easy steps. First of all, install the dependency:

Default Dependency

fast →pip install authx

restart ↻

Extra Dependencies

After installing the dependency, you can install the extra dependencies, which we have in the authx-extra repository.

fast →pip install authx_extra

restart ↻

Warning

Once you install the extra dependency you are aiming to use, ex:

  • for cache you will have Redis installed as a dependency.
  • for profiler you will have Pyinstruments Profiler installed as a dependency.
  • for metrics you will have Prometheus installed as a dependency.

Development Dependencies

fast →git clone https://github.com/yezz123/authx.git

cd authx
bash scripts/install.sh
restart ↻