Skip to content

Commit

Permalink
added venv description
Browse files Browse the repository at this point in the history
Jan Harrie committed Jul 2, 2017

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent 70c7ca5 commit 2bf4111
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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) [email protected]
```

0 comments on commit 2bf4111

Please sign in to comment.