diff --git a/README.md b/README.md index 964dd07..1fac5a6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,21 @@ jogobot-red =========== +Dependencies +------------ + +* pywikibot-core +* mwparserfromhell + +The libraries above need to be installed and configured manualy considering [documentation of pywikibot-core](https://www.mediawiki.org/wiki/Manual:Pywikibot). + +* SQLAlchemy +* PyMySQL + +Those can be installed using pip and the _requirements.txt_ file provided with this packet + + pip install -r requirements.txt + Versions -------- diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..45f37b6 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,23 @@ +# This is a PIP 6+ requirements file for using jogobot-red +# +# All dependencies can be installed using: +# $ sudo pip install -r requirements.txt +# +# It is good practise to install packages using the system +# package manager if it has a packaged version. If you are +# unsure, please use pip as described at the top of the file. +# +# To get a list of potential matches, use +# +# $ awk -F '[#>=]' '{print $1}' requirements.txt | xargs yum search +# or +# $ awk -F '[#>=]' '{print $1}' requirements.txt | xargs apt-cache search + +# Needed for Database-Connection +# SQLAlchemy Python ORM-Framework +SQLAlchemy>=1.1 +# PyMySQL DB-Connector +PyMySQL>=0.7 + +# Also needed, but not covered here, is a working copy of pywikibot-core +# which also brings mwparserfromhell