Skip to content
Snippets Groups Projects
Commit 24ed1112 authored by Mathieu Loiseau's avatar Mathieu Loiseau
Browse files

improve readme

parent 6ee9206b
No related branches found
No related tags found
No related merge requests found
......@@ -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
......
No preview for this file type
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment