From 2bf41111c68ab65d0358a537fe17f1e7a2387bb3 Mon Sep 17 00:00:00 2001 From: Jan Harrie Date: Sun, 2 Jul 2017 11:51:20 +0200 Subject: [PATCH] added venv description --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f140d0cc..c1f67d97 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,34 @@ Original from Jan Harrie, adopted by Bene +## Setup -## Requirements -sudo -H pip3 install -r requirements.txt +### Virtual Environment +Install +``` +$ pip install virtualenv +``` +Swith in project directory and create a virtual environment +``` +$ virtualenv -p /usr/bin/python3.6 venv +``` + +Activate virtual environment +``` +$ source venv/bin/activate +``` + + +### Requirements +Install requirements (with acvtivated venv) +``` +pip install -r requirements.txt +``` ## Usage +``` usage: flathunter.py [-h] [--config CONFIG] Searches for flats on Immobilienscout24.de and wg-gesucht.de and sends results @@ -17,6 +38,7 @@ to Telegram User optional arguments: -h, --help show this help message and exit --config CONFIG, -c CONFIG - Config file to use. If not set, ./comfig.yaml is used. + Config file to use. If not set, $PROJECT_DIR/comfig.yaml is used. Designed by Jan Harrie (c) harrymcfly@protonmail.com +```