RcGcDb/README.md

20 lines
713 B
Markdown
Raw Normal View History

2020-07-23 19:12:07 +00:00
## Introduction
RcGcDb is a backend for handling webhooks to which recent changes of MediaWiki wikis are being pushed to.
### Dependencies ###
* **Python 3.6>**
* beautifulsoup 4.6.0>
* aiohttp 3.6.2>
* lxml 4.2.1>
#### Installation
```
$ git clone git@gitlab.com:chicken-riders/rcgcdb.git #clone repo
2020-07-25 13:27:15 +00:00
$ cd RcGcDb
2020-07-23 19:12:07 +00:00
$ python3 -m venv . #(optional, if you want to contain everything (you should!))
$ source bin/activate #(optional, see above)
$ pip3 install -r requirements.txt #install requirements (lxml may require additional distro packages, more on that here https://lxml.de/build.html)
$ nano settings.json.example #edit the configuration file
$ mv settings.json.example settings.json
$ python3 start.py
```