Skip to content

Commit

Permalink
Include optional Redis support as an "extra"
Browse files Browse the repository at this point in the history
This makes it easy to install the optional libraries.

Bug: T181850
  • Loading branch information
Adam Roses Wight committed Dec 5, 2017
1 parent 920f29d commit 94722ee
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Expand Up @@ -11,9 +11,9 @@ ORES is based on Python 3. Use pip to install ORES:

``pip install ores`` (or ``pip3 install ores`` if your distribution defaults to Python 2)

If you're running with the default configuration, you'll need to install a few more optional libraries,
If you're running with the default Redis configuration, you'll need to install a few more optional libraries,

``pip install pylru``
``pip install ores[redis]``

Then you can easily run a test server by:

Expand Down Expand Up @@ -53,3 +53,4 @@ Authors
* [Yuvi Panda](https://github.com/yuvipanda)
* [Amir Sarabadani](https://github.com/Ladsgroup)
* [Justin Du](https://github.com/mdew192837)
* [Adam Wight](https://github.com/adamwight)
8 changes: 8 additions & 0 deletions setup.py
Expand Up @@ -49,6 +49,14 @@ def requirements(fname):
include_package_data=True,
long_description=read('README.md'),
install_requires=list(requirements("requirements.txt")),
extras_require={
# Install ores[redis] if your deployment will use the Redis scoring
# cache and Celery backend.
"redis": [
"pylru",
"redis",
],
},
classifiers=[
"Development Status :: 3 - Alpha",
"Programming Language :: Python",
Expand Down

0 comments on commit 94722ee

Please sign in to comment.