updates to readme & run.sh

andre
Castro0o 5 years ago
parent 89e23cd7cd
commit 49c1db7b60

@ -1,8 +1,9 @@
# Wiki to HTML pages script # Wiki to HTML pages script
![](https://pzwiki.wdka.nl/mw-mediadesign/images/8/82/Workflow-wiki2html.svg)
## Depencencies ## Depencencies
* python3 * python3
* [pip]() Python library installed * [pip](https://pip.pypa.io/en/stable/installing/) Python library installed
* Install: * Install:
* `curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py` * `curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py`
* `python3 get-pip.py` * `python3 get-pip.py`
@ -20,7 +21,7 @@
## login.txt ## login.txt
`login.txt` is a secrete file (ignored by git) where you place you itch wiki username and password, in separate lines. `login.txt` is a local and individual file, ignored by git, where you place you itch wiki username and password, in separate lines.
It is used to let mwclient access the wiki, since it is close for reading and writing. It is used to let mwclient access the wiki, since it is close for reading and writing.
``` ```
@ -30,7 +31,13 @@ mypassword
## Run ## Run
* all toguether `./run.sh`
`cd special-issue-11-wiki2html/`
Run scripts together with `./run.sh`
1 script at a time:
`python3 download_imgs.py` `python3 download_imgs.py`
* Downloads all images from wiki to `images/` directory * Downloads all images from wiki to `images/` directory
@ -38,19 +45,13 @@ mypassword
`python3 publication2html.py` `python3 publication2html.py`
* with ask API perform a query: * with ask API perform a query:
* default `[[File:+]][[Title::+]][[Date::+]]|?Title|?Date|?Part|sort=Date,Title,Part|order=asc,asc,asc` * default query is: `[[File:+]][[Title::+]][[Date::+]]|?Title|?Date|?Part|sort=Date,Title,Part|order=asc,asc,asc`
* custom query `python3 publication2html.py --ask '[[File:+]][[Title::+]][[Date::+]]|?Date|order=desc'`
* The results, with the same Title, are stored * The results, with the same Title, are stored
* into 1 single HTML * into 1 single HTML
* sorted by Part * sorted by Part
OR
`python3 images2html.py`
* cycles through the items in `images.json`
* querying the File: wiki for image
* if it contains essential metadata: Title, Page, Total Pages
* retrieves its text content
* generates a HTML page from it
* saves page onto `static_html/` directory
## TODO: Work on making an overview! ## TODO
* Fix issue with PANDOC conversion MW -> HTML

@ -1,3 +1,3 @@
#!/bin/sh #!/bin/sh
python3 download_imgs.py python3 download_imgs.py
python3 images2html.py python3 publication2html.py

@ -3,6 +3,16 @@ import os
from mwclient import Site from mwclient import Site
from datetime import datetime from datetime import datetime
from pprint import pprint from pprint import pprint
from argparse import ArgumentParser
p = ArgumentParser()
#p.add_argument("--host", metavar='', default="hub.xpub.nl")
#p.add_argument("--path", metavar='', default="/itchwiki/", help="Wiki path. Should end with /")
p.add_argument("--ask", "-a", metavar='', default="[[File:+]][[Title::+]][[Date::+]]|?Title|?Date|?Part|sort=Date,Title,Part|order=asc,asc,asc", help="Ask query to be sent to the wiki API.")
args = p.parse_args()
print args
site = Site(host='hub.xpub.nl/sandbox', path='/itchwiki/') site = Site(host='hub.xpub.nl/sandbox', path='/itchwiki/')
@ -13,8 +23,9 @@ with open(os.path.join(wd, 'login.txt'), 'r') as login: # read login user & pwd
user, pwd = loginlines.split('\n') user, pwd = loginlines.split('\n')
site.login(username=user, password=pwd) # login to wiki site.login(username=user, password=pwd) # login to wiki
# TODO: move query onto argument
query = ('[[File:+]][[Title::+]][[Date::+]]|?Title|?Date|?Part|sort=Date,Title,Part|order=asc,asc,asc') query = args.ask
print('Query:', query) print('Query:', query)
# examples: # examples:

Loading…
Cancel
Save