Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
enchant97 committed Mar 21, 2023
1 parent 6ecd6d0 commit ae9ef9c
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 8 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@
![PyPI - Downloads](https://img.shields.io/pypi/dm/quart-redis)
![GitHub](https://img.shields.io/github/license/enchant97/quart-redis)
![GitHub issues](https://img.shields.io/github/issues/enchant97/quart-redis)
![Lines of code](https://img.shields.io/tokei/lines/github/enchant97/quart-redis)
![GitHub last commit](https://img.shields.io/github/last-commit/enchant97/quart-redis)

An easy way of setting up a redis connection in quart.

## Requirements
- quart
- aioredis
- quart >= 0.18
- redis >= 4.2

## Example of Use
```
Expand All @@ -25,6 +24,8 @@ from quart_redis import RedisHandler, get_redis

app = Quart(__name__)
app.config["REDIS_URI"] = "redis://localhost"
# override default connection attempts, set < 0 to disable
# app.config["REDIS_CONN_ATTEMPTS"] = 3
redis_handler = RedisHandler(app)

@app.route("/")
Expand Down
2 changes: 2 additions & 0 deletions docs/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ from quart_redis import RedisHandler, get_redis

app = Quart(__name__)
app.config["REDIS_URI"] = "redis://localhost"
# override default connection attempts, set < 0 to disable
# app.config["REDIS_CONN_ATTEMPTS"] = 3
redis_handler = RedisHandler(app)

@app.route("/")
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
An easy way of setting up a redis connection in quart.

## Installation
Install the pip package using pip. The latest compatible release of aioredis will be automatically installed.
Install the pip package using pip. The latest compatible release of redis will be automatically installed.

```
pip install quart-redis
```

## Requirements
- quart
- aioredis
- quart >= 0.18
- redis >= 4.2

## Contents
- [Example Of Usage](./example.md)
Expand Down
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ project_urls =
Documentation = https://quart-redis.readthedocs.io/en/latest/
Change Log = https://github.com/enchant97/quart-redis/blob/master/CHANGELOG.md
license = MIT
keywords = quart redis aioredis cache
keywords = quart asyncio redis cache
classifiers =
License :: OSI Approved :: MIT License
Operating System :: OS Independent
Expand All @@ -26,5 +26,5 @@ classifiers =
packages = find:
python_requires = >=3.9
install_requires =
quart ~= 0.16
quart ~= 0.18
redis >= 4.2, < 5

0 comments on commit ae9ef9c

Please sign in to comment.