Skip to content

Commit

Permalink
Merge pull request #3 from OSSMafia/mnick/fixes
Browse files Browse the repository at this point in the history
fix: updated readme
  • Loading branch information
mattylight22 authored Aug 14, 2024
2 parents 110594d + 1fd64e8 commit ec00d8e
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.0.2
current_version = 0.0.3
commit = True
tag = True

Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@

FastAPI Auth Middleware for [Clerk](https://clerk.com)

Easily setup authentication on your API routes using your Clerk JWKS endpoint.

## Install
```bash
pip install fastapi-clerk
pip install fastapi-clerk-auth
```

## Basic Usage
Expand All @@ -19,9 +21,9 @@ app = FastAPI()

clerk_config = ClerkConfig(jwks_url="https://example.com/.well-known/jwks.json") # Use your Clerk JWKS endpoint

clear_auth_guard = ClerkHTTPBearer(config=clerk_config)
clerk_auth_guard = ClerkHTTPBearer(config=clerk_config)

@app.get("/")
async def read_root(credentials: HTTPAuthorizationCredentials | None = Depends(clear_auth_guard)):
async def read_root(credentials: HTTPAuthorizationCredentials | None = Depends(clerk_auth_guard)):
return JSONResponse(content=jsonable_encoder(credentials))
```
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[project]
name = "fastapi_clerk_auth"
version = "0.0.2"
description = "FastAPI Auth Middleware for [Clerk](https://clerk.com)"
version = "0.0.3"
description = "FastAPI Auth Middleware for Clerk (https://clerk.com)"
readme = "README.md"
requires-python = ">=3.9"
authors = [
Expand Down

0 comments on commit ec00d8e

Please sign in to comment.