Skip to content

Commit

Permalink
Update docs aredis -> redis-py
Browse files Browse the repository at this point in the history
  • Loading branch information
steinitzu committed Feb 7, 2024
1 parent 7f15a4c commit 24c0164
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ stateless JWTs or revokable tokens stored in a central whitelist.

* All JWT encoding and decoding is done using the de-facto standard [PyJWT](https://pyjwt.readthedocs.io) under the hood
* Optional JWT whitelist for revokable tokens (pluggable storage backend)
* Redis whitelist support is built in using [aredis](https://aredis.readthedocs.io/en/latest/)
* Redis whitelist support is built in using [redis-py](https://github.com/redis/redis-py)
* Optional idle timeout support to revoke tokens that are not accessed for a given interval
* Type safe, using generics for an extendable JWT payload model

Expand All @@ -20,10 +20,10 @@ stateless JWTs or revokable tokens stored in a central whitelist.
pip install jotbox
```

To use the included redis whitelist, you must install `aredis` as well:
To use the included redis whitelist, you must install `redis` as well:

```
pip install aredis
pip install redis
```

## Quickstart
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/whitelist-and-revoke-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ my_whitelist = RedisWhitelist('redis://localhost')
```

If you want more control over how the redis connection pool
is created, you can pass in an `aredis.StrictRedis` instance directly:
is created, you can pass in an `redis.asyncio.Redis` instance directly:

```python3
...
from aredis import StrictRedis
from redis.asyncio import Redis

my_redis = StrictRedis(...)
my_redis = Redis(...)
my_whitelist = RedisWhitelist(my_redis)
```

Expand Down

0 comments on commit 24c0164

Please sign in to comment.