From 62e04549ac59c01c40ad367aabf17afb4a16075e Mon Sep 17 00:00:00 2001 From: pictuga Date: Sat, 11 Sep 2021 21:35:14 +0200 Subject: [PATCH] Optdeps in REAMDE and Dockerfile --- Dockerfile | 2 +- README.md | 25 +++++++++++-------------- 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/Dockerfile b/Dockerfile index 7893a18..5bd443f 100644 --- a/Dockerfile +++ b/Dockerfile @@ -3,6 +3,6 @@ FROM alpine:latest RUN apk add --no-cache python3 py3-lxml py3-pip py3-wheel git ADD . /app -RUN pip3 install --no-cache-dir /app gunicorn +RUN pip3 install --no-cache-dir /app[full] gunicorn CMD gunicorn --bind 0.0.0.0:8080 -w 4 --preload --access-logfile - morss diff --git a/README.md b/README.md index bc26220..a44c460 100644 --- a/README.md +++ b/README.md @@ -48,28 +48,25 @@ Some features of morss: ### Python package +Simple install (without optional dependencies) + ```shell pip install git+https://git.pictuga.com/pictuga/morss.git ``` +Full installation (including optional dependencies) + +```shell +pip install git+https://git.pictuga.com/pictuga/morss.git#[full] +``` + +The full install includes mysql (possible cache backend). Otherwise, only +in-memory and sqlite3 caches are available. + The dependency `lxml` is fairly long to install (especially on Raspberry Pi, as C code needs to be compiled). If possible on your distribution, try installing it with the system package manager. -Dependencies: - -- [python](http://www.python.org/) >= 2.6 (python 3 is supported) -- [lxml](http://lxml.de/) for xml parsing -- [bs4](https://pypi.org/project/bs4/) for badly-formatted html pages -- [dateutil](http://labix.org/python-dateutil) to parse feed dates -- [chardet](https://pypi.python.org/pypi/chardet) -- [six](https://pypi.python.org/pypi/six), a dependency of chardet -- pymysql - -You may also need: -- Apache, with python-cgi support, to run on a server -- a fast internet connection - ### Docker Build & run