diff --git a/README.md b/README.md index 1f80c7ccee35669f51179985daaf7eed6d3517d0..0340cd86ca55e25810978786de9b5d52e681df89 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,21 @@ This project does depend on python packages. * [``wikitextparser``](https://github.com/5j9/wikitextparser) can parse mediawiki pages and extract sections, templates and links * [documentation](https://wikitextparser.readthedocs.io/en/latest/#api-reference) * [``importlib``](https://docs.python.org/3/library/importlib.html) : to import parser modules +* [``sqlite3``](https://docs.python.org/3/library/sqlite3.html) For logs +* [``gitpython``](https://gitpython.readthedocs.io/en/stable/) for logs +* [``json``](https://docs.python.org/3/library/json.html) for json use +* [``re``](https://docs.python.org/3/library/re.html) ## Installation (maybe to be replaced by an automation of some sort, using a virtual environment might be better, see [server version](#wikstraktor-server)) -* [```pip install pywikibot```](https://pypi.org/project/pywikibot/) -* [```pip install wikitextparser```](https://pypi.org/project/wikitextparser/) -* [```pip install gitpython```](https://gitpython.readthedocs.io/en/stable/) -* [```pip install sqlite3```](https://docs.python.org/3/library/sqlite3.html) Might be provided with python -* [```pip install importlib```](https://pypi.org/project/importlib/) -_Optional (for python 2.*, not tested)_ -* run ``./setup.py`` (used to store wikstraktor version in wiktionary extracts) + +### Basic version +```bash +python3 -m venv wikstraktorenv #optional for basic version +. wikstraktorenv/bin/activate #activate environment (optional) +pip install -r requirements.txt +run ./setup.py +``` ### Wikstraktor Server If you want wikstraktor as a server, you need to install [flask](https://flask.palletsprojects.com/en/2.0.x/installation/) and [flask-cors](https://flask-cors.readthedocs.io/en/latest/) — to allow other domains to query —, and best practice is to do so in a [virtual environment](https://docs.python.org/3/library/venv.html#module-venv). @@ -32,8 +37,8 @@ The following commands are extracted from the aforementionned documentation, it ```bash python3 -m venv wikstraktorenv #create wikstraktorenv environment . wikstraktorenv/bin/activate #activate environment -pip install Flask #install Flask -pip install -U flask-cors #install Flask cors +pip install -r server_requirements.txt +run ./setup.py ``` ## Use diff --git a/wikstraktor.sqlite b/wikstraktor.sqlite index a41143a79f6220cd37a258a2b105deb621a15baf..ec099cb48da8c81ff59a6a675e4fa9f091455675 100644 Binary files a/wikstraktor.sqlite and b/wikstraktor.sqlite differ