Skip to content
This repository has been archived by the owner on Feb 21, 2023. It is now read-only.

Commit

Permalink
Make hiredis and optional dependency (resolves #917)
Browse files Browse the repository at this point in the history
  • Loading branch information
seandstewart committed Mar 18, 2021
1 parent 10b82dd commit e42bf48
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGES/917.feature
@@ -0,0 +1 @@
Make hiredis an optional dependency.
9 changes: 3 additions & 6 deletions docs/getting-started.md
Expand Up @@ -6,15 +6,12 @@
pip install aioredis
```

This will install `aioredis`, alongside `hiredis` and `async-timeout`.
This will install `aioredis`, `async-timeout`.

### Without Dependencies

If you find yourself in a situation where you cannot support `hiredis` in your
application, you can install aioredis without that dependency:
### With hiredis

```shell
pip install --no-deps aioredis async-timeout
pip install aioredis[hiredis]
```

### Installing from Git
Expand Down
6 changes: 4 additions & 2 deletions setup.py
Expand Up @@ -39,7 +39,7 @@ def read_version():
setup(
name="aioredis",
version=read_version(),
description=("asyncio (PEP 3156) Redis support"),
description="asyncio (PEP 3156) Redis support",
long_description="\n\n".join((read("README.md"), read("CHANGES.md"))),
long_description_content_type="text/markdown",
classifiers=classifiers,
Expand All @@ -49,9 +49,11 @@ def read_version():
packages=find_packages(exclude=["tests"]),
install_requires=[
"async-timeout",
'hiredis>=1.0; implementation_name=="cpython"',
"typing-extensions",
],
extras_require={
"hiredis": 'hiredis>=1.0; implementation_name=="cpython"',
},
python_requires=">=3.6",
include_package_data=True,
)

0 comments on commit e42bf48

Please sign in to comment.