Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Nneji123 committed Nov 3, 2022
1 parent d4674db commit 7bec91b
Show file tree
Hide file tree
Showing 11 changed files with 128 additions and 311 deletions.
48 changes: 0 additions & 48 deletions .config

This file was deleted.

12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,13 @@ API key based Authentication package for FastAPI, focused on simplicity and ease
- Username, Email address and password(hashing + salting) verification features.
- Lightweight, minimal dependencies required.

This package can be used for development(sqlite3 database) and production(postgres database) environments.

## Updates
1. Added **partial** support for mongodb database backend.
2. Added support for environment variables through .env files.
3. Added `example.env` file to show how to use environment variables.
4. Updated `README.md` to reflect changes.
5. Updated documentation to reflect changes.
6. Working on adding support for `mysql` database backend.

## Installation

Expand All @@ -40,7 +45,7 @@ from fastapi_auth import api_key_router, api_key_security


app = FastAPI(
description="FastAPI Auth is a package that provides authentication based API security with FastAPI and Postgres Database or Sqlite3 Database.",
description="FastAPI Auth is a package that provides authentication based API security with FastAPI and Postgres Database, SQLite Database or MongoDB Database",
title="FastAPI Auth Example",
version=1.0,
)
Expand Down Expand Up @@ -82,6 +87,7 @@ And finally, you can use this API key to access the secure endpoint.

![secure endpoint](images/secure_endpoint.png)


### API key creation in python

You can of course automate API key acquisition through python with `requests` and directly querying the endpoints.
Expand Down
2 changes: 1 addition & 1 deletion api/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from fastapi_auth import api_key_router, api_key_security

app = FastAPI(
description="FastAPI Auth is a package that provides authentication based API security with FastAPI and Postgres Database or Sqlite3 Database.",
description="FastAPI Auth is a package that provides authentication based API security with FastAPI and Postgres Database, Sqlite3 Database or MongoDB Database.",
title="FastAPI Auth Example",
version=1.0,
)
Expand Down
Loading

0 comments on commit 7bec91b

Please sign in to comment.