From 3e8447f49298eb8daaf7ee1078c6238894fb310c Mon Sep 17 00:00:00 2001 From: "Casper V. Kristensen" Date: Tue, 31 Jul 2018 17:49:26 +0200 Subject: [PATCH] Update readme. Remove automatic installation of levenshtein for fuzzywuzzy. --- README.md | 6 ++++-- setup.py | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 815ef1b..a05c0b5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Daily Releases: *A reddit bot that consolidates scene releases* +# Daily Releases ## Quick Start ### Installation @@ -10,11 +10,13 @@ pip3 install --upgrade https://git.caspervk.net/caspervk/dailyreleases/archive/m **It requires Python 3.6 or later.** +To speed up fuzzy string matching, it may be desirable to install `python3-levenshtein`. + ### Usage The program can be started by running `dailyreleases` or `python3 -m dailyreleases` depending on system configuration. ### Configuration The default configuration file will be copied to `~/.dailyreleases/config.ini` on the first run. All fields under the -[reddit] and [google] sections need to be filled out before the bot can be initialized. +`[reddit]` and `[google]` sections need to be filled out before the bot can be initialized. To append content to the generated post, add a file `~/.dailyreleases/epilogue.txt`. \ No newline at end of file diff --git a/setup.py b/setup.py index cdf59e5..03c554f 100644 --- a/setup.py +++ b/setup.py @@ -42,7 +42,7 @@ setup( "praw", "beautifulsoup4", "tabulate", - "fuzzywuzzy[speedup]" + "fuzzywuzzy" ], entry_points={ "console_scripts": [